PositionAssignments

List positionAssignments

get

List positionAssignments

Filter Syntax:

Filters use exact match only
Multiple filters are combined with AND logic
Filterable fields: employeeID
Example: ?employeeID=123e4567-e89b-12d3-a456-426614174000

Authorizations

Path parameters

orgkeepIDstringRequired

Organization identifier

Query parameters

employeeIDstringOptional

Filter by employeeID (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

GET /api/orgkeep/v4/{orgkeepID}/positionAssignments HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "activePeriod": "[2023-01-01,2023-12-31)",
      "createdAt": "2025-07-18T20:01:43.185Z",
      "employeeID": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "lastModifiedAt": "2025-07-18T20:01:43.185Z",
      "remark": "text",
      "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
      "tagIDs": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "pagination": {
    "hasMore": true,
    "limit": 1,
    "nextCursor": "text",
    "total": 1
  }
}

Get PositionAssignment

get

Get a single positionAssignment by ID

Authorizations

Path parameters

orgkeepIDstringRequired

Organization identifier

idstringRequired

PositionAssignment ID

Responses

200

Successful response

application/json

401

Unauthorized

application/json

404

Not found

application/json

500

Internal server error

application/json

get

GET /api/orgkeep/v4/{orgkeepID}/positionAssignments/{id} HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "activePeriod": "[2023-01-01,2023-12-31)",
  "createdAt": "2025-07-18T20:01:43.185Z",
  "employeeID": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "lastModifiedAt": "2025-07-18T20:01:43.185Z",
  "remark": "text",
  "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
  "tagIDs": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

List PositionAssignment creation proposals

get

List all createPositionAssignments proposals. These are proposed changes to create new PositionAssignment 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: employeeID
Example: ?employeeID=123e4567-e89b-12d3-a456-426614174000

Authorizations

Path parameters

orgkeepIDstringRequired

Organization identifier

Query parameters

employeeIDstringOptional

Filter by employeeID (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

GET /api/orgkeep/v4/{orgkeepID}/createPositionAssignments HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Accept: */*

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

Propose creation of PositionAssignment

post

Create a new proposal to add a PositionAssignment record. The proposal may be automatically approved or require manual approval depending on system configuration.

Authorizations

Path parameters

orgkeepIDstringRequired

Organization identifier

Body

activePeriodstringRequired

Date range in PostgreSQL format [start,end)

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

employeeIDstring · uuidRequired

remarkstringOptional

repositoryIDstring · uuidRequired

tagIDsstring · uuid[]Required

Responses

201

Created successfully

application/json

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

post

POST /api/orgkeep/v4/{orgkeepID}/createPositionAssignments HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 214

{
  "activePeriod": "[2023-01-01,2023-12-31)",
  "employeeID": "123e4567-e89b-12d3-a456-426614174000",
  "remark": "text",
  "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
  "tagIDs": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

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

Get PositionAssignment creation proposal

get

Get details of a specific PositionAssignment creation proposal by ID

Authorizations

Path parameters

orgkeepIDstringRequired

Organization identifier

idstringRequired

CreatePositionAssignment ID

Responses

200

Successful response

application/json

401

Unauthorized

application/json

404

Not found

application/json

500

Internal server error

application/json

get

GET /api/orgkeep/v4/{orgkeepID}/createPositionAssignments/{id} HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Accept: */*

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

List PositionAssignment deletion proposals

get

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

Authorizations

Path parameters

orgkeepIDstringRequired

Organization identifier

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

GET /api/orgkeep/v4/{orgkeepID}/deletePositionAssignments HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Accept: */*

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

Propose creation of PositionAssignment

post

Create a new proposal to add a PositionAssignment record. The proposal may be automatically approved or require manual approval depending on system configuration.

Authorizations

Path parameters

orgkeepIDstringRequired

Organization identifier

Body

idstring · uuidRequired

repositoryIDstring · uuidRequired

Responses

201

Created successfully

application/json

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

post

POST /api/orgkeep/v4/{orgkeepID}/deletePositionAssignments HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 99

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

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

Get PositionAssignment deletion proposal

get

Get details of a specific PositionAssignment deletion proposal by ID

Authorizations

Path parameters

orgkeepIDstringRequired

Organization identifier

idstringRequired

DeletePositionAssignment ID

Responses

200

Successful response

application/json

401

Unauthorized

application/json

404

Not found

application/json

500

Internal server error

application/json

get

GET /api/orgkeep/v4/{orgkeepID}/deletePositionAssignments/{id} HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Accept: */*

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

List PositionAssignment update proposals

get

List all updatePositionAssignments proposals. These are proposed changes to update existing PositionAssignment 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: employeeID
Example: ?employeeID=123e4567-e89b-12d3-a456-426614174000

Authorizations

Path parameters

orgkeepIDstringRequired

Organization identifier

Query parameters

employeeIDstringOptional

Filter by employeeID (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

GET /api/orgkeep/v4/{orgkeepID}/updatePositionAssignments HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Accept: */*

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

Propose creation of PositionAssignment

post

Create a new proposal to add a PositionAssignment record. The proposal may be automatically approved or require manual approval depending on system configuration.

Authorizations

Path parameters

orgkeepIDstringRequired

Organization identifier

Body

activePeriodstringRequired

Date range in PostgreSQL format [start,end)

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

employeeIDstring · uuidRequired

idstring · uuidRequired

remarkstringOptional

repositoryIDstring · uuidRequired

tagIDsstring · uuid[]Required

Responses

201

Created successfully

application/json

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

post

POST /api/orgkeep/v4/{orgkeepID}/updatePositionAssignments HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 258

{
  "activePeriod": "[2023-01-01,2023-12-31)",
  "employeeID": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "remark": "text",
  "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
  "tagIDs": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

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

Get PositionAssignment update proposal

get

Get details of a specific PositionAssignment update proposal by ID

Authorizations

Path parameters

orgkeepIDstringRequired

Organization identifier

idstringRequired

UpdatePositionAssignment ID

Responses

200

Successful response

application/json

401

Unauthorized

application/json

404

Not found

application/json

500

Internal server error

application/json

get

GET /api/orgkeep/v4/{orgkeepID}/updatePositionAssignments/{id} HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Accept: */*

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