EmploymentRelations

Operations for EmploymentRelations

List employmentRelations

get

List employmentRelations

Filter Syntax:

• Filters use exact match only

• Multiple filters are combined with AND logic

• Filterable fields: toEmployeeID, fromEmployeeID, relationTypeID

• Example: ?toEmployeeID=123e4567-e89b-12d3-a456-426614174000&fromEmployeeID=123e4567-e89b-12d3-a456-426614174000

Authorizations

Query parameters

toEmployeeIDstringOptional

Filter by toEmployeeID (exact match)

fromEmployeeIDstringOptional

Filter by fromEmployeeID (exact match)

relationTypeIDstringOptional

Filter by relationTypeID (exact match)

limitinteger · min: 1 · max: 1000Optional

Maximum number of items to return (1-1000)

Default: 10

cursorstringOptional

Cursor for pagination. Use the value from the 'nextCursor' field of the previous response.

Responses

200

Successful response

application/json

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

get/employmentRelations

GET /employmentRelations HTTP/1.1
Accept: */*

{
  "data": [
    {
      "activePeriod": "[2023-01-01,2023-12-31)",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "fromEmployeeID": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "lastModifiedAt": "2026-01-01T00:00:00.000Z",
      "relationTypeID": "123e4567-e89b-12d3-a456-426614174000",
      "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
      "toEmployeeID": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "pagination": {
    "hasMore": true,
    "limit": 1,
    "nextCursor": "text",
    "total": 1
  }
}

Get EmploymentRelation

get

Get a single EmploymentRelation by ID

Authorizations

Path parameters

idstringRequired

EmploymentRelation ID

Responses

200

Successful response

application/json

activePeriodstringRequired

Date range in PostgreSQL format [start,end)

Example: [2023-01-01,2023-12-31)

createdAtstring · date-timeRequired

fromEmployeeIDstring · uuidRequired

idstring · uuidRequired

lastModifiedAtstring · date-timeRequired

relationTypeIDstring · uuidRequired

repositoryIDstring · uuidRequired

toEmployeeIDstring · uuidRequired

401

Unauthorized

application/json

404

Not found

application/json

500

Internal server error

application/json

get/employmentRelations/{id}

GET /employmentRelations/{id} HTTP/1.1
Accept: */*

{
  "activePeriod": "[2023-01-01,2023-12-31)",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "fromEmployeeID": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "lastModifiedAt": "2026-01-01T00:00:00.000Z",
  "relationTypeID": "123e4567-e89b-12d3-a456-426614174000",
  "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
  "toEmployeeID": "123e4567-e89b-12d3-a456-426614174000"
}

List EmploymentRelation creation proposals

get

List all createEmploymentRelations proposals. These are proposed changes to create new EmploymentRelation records that may be automatically approved or require manual approval depending on system configuration.

Filter Syntax:

• Filters use exact match only

• Multiple filters are combined with AND logic

• Filterable fields: toEmployeeID, fromEmployeeID, relationTypeID

• Example: ?toEmployeeID=123e4567-e89b-12d3-a456-426614174000&fromEmployeeID=123e4567-e89b-12d3-a456-426614174000

Authorizations

Query parameters

toEmployeeIDstringOptional

Filter by toEmployeeID (exact match)

fromEmployeeIDstringOptional

Filter by fromEmployeeID (exact match)

relationTypeIDstringOptional

Filter by relationTypeID (exact match)

limitinteger · min: 1 · max: 1000Optional

Maximum number of items to return (1-1000)

Default: 10

cursorstringOptional

Cursor for pagination. Use the value from the 'nextCursor' field of the previous response.

Responses

200

Successful response

application/json

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

get/createEmploymentRelations

GET /createEmploymentRelations HTTP/1.1
Accept: */*

{
  "data": [
    {
      "activePeriod": "[2023-01-01,2023-12-31)",
      "fromEmployeeID": "123e4567-e89b-12d3-a456-426614174000",
      "isProposalExecutionFailed": true,
      "isProposalResolved": false,
      "proposalExecutionErrorText": "text",
      "relationTypeID": "123e4567-e89b-12d3-a456-426614174000",
      "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
      "requestID": "123e4567-e89b-12d3-a456-426614174000",
      "subjectID": "123e4567-e89b-12d3-a456-426614174000",
      "toEmployeeID": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "pagination": {
    "hasMore": true,
    "limit": 1,
    "nextCursor": "text",
    "total": 1
  }
}

Propose creation of EmploymentRelations

post

Create new proposals to add EmploymentRelation records. The proposals may be automatically approved or require manual approval depending on system configuration. You can submit multiple proposals in a single request.

Authorizations

Bodyobject · CreateCreateEmploymentRelationProposalRequest[]

activePeriodstringRequired

Date range in PostgreSQL format [start,end)

Example: [2023-01-01,2023-12-31)

fromEmployeeIDstring · uuidRequired

relationTypeIDstring · uuidRequired

repositoryIDstring · uuidRequired

toEmployeeIDstring · uuidRequired

Responses

201

Created successfully

application/json

activePeriodstringRequired

Date range in PostgreSQL format [start,end)

Example: [2023-01-01,2023-12-31)

fromEmployeeIDstring · uuidRequired

isProposalExecutionFailedbooleanRead-onlyRequired

isProposalResolvedbooleanRead-onlyRequiredExample: false

proposalExecutionErrorTextstringRead-onlyOptional

relationTypeIDstring · uuidRequired

repositoryIDstring · uuidRequired

requestIDstring · uuidRead-onlyRequired

subjectIDstring · uuidRead-onlyRequired

toEmployeeIDstring · uuidRequired

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

post/createEmploymentRelations

POST /createEmploymentRelations HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 264

[
  {
    "activePeriod": "[2023-01-01,2023-12-31)",
    "fromEmployeeID": "123e4567-e89b-12d3-a456-426614174000",
    "relationTypeID": "123e4567-e89b-12d3-a456-426614174000",
    "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
    "toEmployeeID": "123e4567-e89b-12d3-a456-426614174000"
  }
]

[
  {
    "activePeriod": "[2023-01-01,2023-12-31)",
    "fromEmployeeID": "123e4567-e89b-12d3-a456-426614174000",
    "isProposalExecutionFailed": true,
    "isProposalResolved": false,
    "proposalExecutionErrorText": "text",
    "relationTypeID": "123e4567-e89b-12d3-a456-426614174000",
    "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
    "requestID": "123e4567-e89b-12d3-a456-426614174000",
    "subjectID": "123e4567-e89b-12d3-a456-426614174000",
    "toEmployeeID": "123e4567-e89b-12d3-a456-426614174000"
  }
]

Get EmploymentRelation creation proposal

get

Get details of a specific EmploymentRelation creation proposal by ID

Authorizations

Path parameters

idstringRequired

CreateEmploymentRelationProposal ID

Responses

200

Successful response

application/json

activePeriodstringRequired

Date range in PostgreSQL format [start,end)

Example: [2023-01-01,2023-12-31)

fromEmployeeIDstring · uuidRequired

isProposalExecutionFailedbooleanRead-onlyRequired

isProposalResolvedbooleanRead-onlyRequiredExample: false

proposalExecutionErrorTextstringRead-onlyOptional

relationTypeIDstring · uuidRequired

repositoryIDstring · uuidRequired

requestIDstring · uuidRead-onlyRequired

subjectIDstring · uuidRead-onlyRequired

toEmployeeIDstring · uuidRequired

401

Unauthorized

application/json

404

Not found

application/json

500

Internal server error

application/json

get/createEmploymentRelations/{id}

GET /createEmploymentRelations/{id} HTTP/1.1
Accept: */*

{
  "activePeriod": "[2023-01-01,2023-12-31)",
  "fromEmployeeID": "123e4567-e89b-12d3-a456-426614174000",
  "isProposalExecutionFailed": true,
  "isProposalResolved": false,
  "proposalExecutionErrorText": "text",
  "relationTypeID": "123e4567-e89b-12d3-a456-426614174000",
  "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
  "requestID": "123e4567-e89b-12d3-a456-426614174000",
  "subjectID": "123e4567-e89b-12d3-a456-426614174000",
  "toEmployeeID": "123e4567-e89b-12d3-a456-426614174000"
}

List EmploymentRelation deletion proposals

get

List all deleteEmploymentRelations proposals. These are proposed changes to delete EmploymentRelation records that may be automatically approved or require manual approval depending on system configuration.

Authorizations

Query parameters

limitinteger · min: 1 · max: 1000Optional

Maximum number of items to return (1-1000)

Default: 10

cursorstringOptional

Cursor for pagination. Use the value from the 'nextCursor' field of the previous response.

Responses

200

Successful response

application/json

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

get/deleteEmploymentRelations

GET /deleteEmploymentRelations HTTP/1.1
Accept: */*

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "isProposalExecutionFailed": true,
      "isProposalResolved": false,
      "proposalExecutionErrorText": "text",
      "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
      "requestID": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "pagination": {
    "hasMore": true,
    "limit": 1,
    "nextCursor": "text",
    "total": 1
  }
}

Propose deletion of EmploymentRelations

post

Create new proposals to delete EmploymentRelation records. The proposals may be automatically approved or require manual approval depending on system configuration. You can submit multiple proposals in a single request.

Authorizations

Bodyobject · CreateDeleteEmploymentRelationProposalRequest[]

idstring · uuidRequired

repositoryIDstring · uuidRequired

Responses

201

Created successfully

application/json

idstring · uuidRequired

isProposalExecutionFailedbooleanRead-onlyRequired

isProposalResolvedbooleanRead-onlyRequiredExample: false

proposalExecutionErrorTextstringRead-onlyOptional

repositoryIDstring · uuidRequired

requestIDstring · uuidRead-onlyRequired

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

post/deleteEmploymentRelations

POST /deleteEmploymentRelations HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 101

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "repositoryID": "123e4567-e89b-12d3-a456-426614174000"
  }
]

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "isProposalExecutionFailed": true,
    "isProposalResolved": false,
    "proposalExecutionErrorText": "text",
    "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
    "requestID": "123e4567-e89b-12d3-a456-426614174000"
  }
]

Get EmploymentRelation deletion proposal

get

Get details of a specific EmploymentRelation deletion proposal by ID

Authorizations

Path parameters

idstringRequired

DeleteEmploymentRelationProposal ID

Responses

200

Successful response

application/json

idstring · uuidRequired

isProposalExecutionFailedbooleanRead-onlyRequired

isProposalResolvedbooleanRead-onlyRequiredExample: false

proposalExecutionErrorTextstringRead-onlyOptional

repositoryIDstring · uuidRequired

requestIDstring · uuidRead-onlyRequired

401

Unauthorized

application/json

404

Not found

application/json

500

Internal server error

application/json

get/deleteEmploymentRelations/{id}

GET /deleteEmploymentRelations/{id} HTTP/1.1
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "isProposalExecutionFailed": true,
  "isProposalResolved": false,
  "proposalExecutionErrorText": "text",
  "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
  "requestID": "123e4567-e89b-12d3-a456-426614174000"
}

List EmploymentRelation update proposals

get

List all updateEmploymentRelations proposals. These are proposed changes to update existing EmploymentRelation records that may be automatically approved or require manual approval depending on system configuration.

Filter Syntax:

• Filters use exact match only

• Multiple filters are combined with AND logic

• Filterable fields: toEmployeeID, fromEmployeeID, relationTypeID

• Example: ?toEmployeeID=123e4567-e89b-12d3-a456-426614174000&fromEmployeeID=123e4567-e89b-12d3-a456-426614174000

Authorizations

Query parameters

toEmployeeIDstringOptional

Filter by toEmployeeID (exact match)

fromEmployeeIDstringOptional

Filter by fromEmployeeID (exact match)

relationTypeIDstringOptional

Filter by relationTypeID (exact match)

limitinteger · min: 1 · max: 1000Optional

Maximum number of items to return (1-1000)

Default: 10

cursorstringOptional

Cursor for pagination. Use the value from the 'nextCursor' field of the previous response.

Responses

200

Successful response

application/json

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

get/updateEmploymentRelations

GET /updateEmploymentRelations HTTP/1.1
Accept: */*

{
  "data": [
    {
      "activePeriod": "[2023-01-01,2023-12-31)",
      "fromEmployeeID": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "isProposalExecutionFailed": true,
      "isProposalResolved": false,
      "proposalExecutionErrorText": "text",
      "relationTypeID": "123e4567-e89b-12d3-a456-426614174000",
      "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
      "requestID": "123e4567-e89b-12d3-a456-426614174000",
      "toEmployeeID": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "pagination": {
    "hasMore": true,
    "limit": 1,
    "nextCursor": "text",
    "total": 1
  }
}

Propose update of EmploymentRelations

post

Create new proposals to update EmploymentRelation records. All fields are optional - omitted fields will not be changed. Only include fields you want to update. Setting a field to null will clear its value (where applicable). The proposals may be automatically approved or require manual approval depending on system configuration. You can submit multiple proposals in a single request.

Authorizations

Bodyobject · CreateUpdateEmploymentRelationProposalRequest[]

activePeriodstringOptional

Date range in PostgreSQL format [start,end) (omit to keep current value)

Example: [2023-01-01,2023-12-31)

fromEmployeeIDstring · uuidOptional

Omit this field to keep current value

idstring · uuidRequired

relationTypeIDstring · uuidOptional

Omit this field to keep current value

repositoryIDstring · uuidRequired

toEmployeeIDstring · uuidOptional

Omit this field to keep current value

Responses

201

Created successfully

application/json

activePeriodstringOptional

Date range in PostgreSQL format [start,end)

Example: [2023-01-01,2023-12-31)

fromEmployeeIDstring · uuidOptional

idstring · uuidRequired

isProposalExecutionFailedbooleanRead-onlyRequired

isProposalResolvedbooleanRead-onlyRequiredExample: false

proposalExecutionErrorTextstringRead-onlyOptional

relationTypeIDstring · uuidOptional

repositoryIDstring · uuidRequired

requestIDstring · uuidRead-onlyRequired

toEmployeeIDstring · uuidOptional

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

post/updateEmploymentRelations

POST /updateEmploymentRelations HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 308

[
  {
    "activePeriod": "[2023-01-01,2023-12-31)",
    "fromEmployeeID": "123e4567-e89b-12d3-a456-426614174000",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "relationTypeID": "123e4567-e89b-12d3-a456-426614174000",
    "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
    "toEmployeeID": "123e4567-e89b-12d3-a456-426614174000"
  }
]

[
  {
    "activePeriod": "[2023-01-01,2023-12-31)",
    "fromEmployeeID": "123e4567-e89b-12d3-a456-426614174000",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "isProposalExecutionFailed": true,
    "isProposalResolved": false,
    "proposalExecutionErrorText": "text",
    "relationTypeID": "123e4567-e89b-12d3-a456-426614174000",
    "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
    "requestID": "123e4567-e89b-12d3-a456-426614174000",
    "toEmployeeID": "123e4567-e89b-12d3-a456-426614174000"
  }
]

Get EmploymentRelation update proposal

get

Get details of a specific EmploymentRelation update proposal by ID

Authorizations

Path parameters

idstringRequired

UpdateEmploymentRelationProposal ID

Responses

200

Successful response

application/json

activePeriodstringOptional

Date range in PostgreSQL format [start,end)

Example: [2023-01-01,2023-12-31)

fromEmployeeIDstring · uuidOptional

idstring · uuidRequired

isProposalExecutionFailedbooleanRead-onlyRequired

isProposalResolvedbooleanRead-onlyRequiredExample: false

proposalExecutionErrorTextstringRead-onlyOptional

relationTypeIDstring · uuidOptional

repositoryIDstring · uuidRequired

requestIDstring · uuidRead-onlyRequired

toEmployeeIDstring · uuidOptional

401

Unauthorized

application/json

404

Not found

application/json

500

Internal server error

application/json

get/updateEmploymentRelations/{id}

GET /updateEmploymentRelations/{id} HTTP/1.1
Accept: */*

{
  "activePeriod": "[2023-01-01,2023-12-31)",
  "fromEmployeeID": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "isProposalExecutionFailed": true,
  "isProposalResolved": false,
  "proposalExecutionErrorText": "text",
  "relationTypeID": "123e4567-e89b-12d3-a456-426614174000",
  "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
  "requestID": "123e4567-e89b-12d3-a456-426614174000",
  "toEmployeeID": "123e4567-e89b-12d3-a456-426614174000"
}