AG5.comSupportRequest a demo

PositionAssignments

Operations for 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
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
get
GET /positionAssignments HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

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

Get PositionAssignment

get

Get a single PositionAssignment by ID

Authorizations
Path parameters
idstringRequired

PositionAssignment ID

Responses
200

Successful response

application/json
get
GET /positionAssignments/{id} HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "activePeriod": "[2023-01-01,2023-12-31)",
  "createdAt": "2025-09-12T14:28:24.058Z",
  "employeeID": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "lastModifiedAt": "2025-09-12T14:28:24.058Z",
  "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
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
get
GET /createPositionAssignments HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "activePeriod": "[2023-01-01,2023-12-31)",
      "employeeID": "123e4567-e89b-12d3-a456-426614174000",
      "isProposalExecutionFailed": true,
      "isProposalResolved": false,
      "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": {
    "count": 1,
    "hasMore": true,
    "limit": 1,
    "nextCursor": "text",
    "total": 1
  }
}

Propose creation of PositionAssignments

post

Create new proposals to add PositionAssignment 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[]
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
post
POST /createPositionAssignments HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 216

[
  {
    "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": false,
    "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
idstringRequired

CreatePositionAssignmentProposal ID

Responses
200

Successful response

application/json
get
GET /createPositionAssignments/{id} HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "activePeriod": "[2023-01-01,2023-12-31)",
  "employeeID": "123e4567-e89b-12d3-a456-426614174000",
  "isProposalExecutionFailed": true,
  "isProposalResolved": false,
  "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
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
get
GET /deletePositionAssignments HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
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": {
    "count": 1,
    "hasMore": true,
    "limit": 1,
    "nextCursor": "text",
    "total": 1
  }
}

Propose deletion of PositionAssignments

post

Create new proposals to delete PositionAssignment 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[]
idstring · uuidRequired
repositoryIDstring · uuidRequired
Responses
201

Created successfully

application/json
post
POST /deletePositionAssignments HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
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 PositionAssignment deletion proposal

get

Get details of a specific PositionAssignment deletion proposal by ID

Authorizations
Path parameters
idstringRequired

DeletePositionAssignmentProposal ID

Responses
200

Successful response

application/json
get
GET /deletePositionAssignments/{id} HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
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 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
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
get
GET /updatePositionAssignments HTTP/1.1
Host: 
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": false,
      "proposalExecutionErrorText": "text",
      "remark": "text",
      "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
      "requestID": "123e4567-e89b-12d3-a456-426614174000",
      "tagIDs": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "pagination": {
    "count": 1,
    "hasMore": true,
    "limit": 1,
    "nextCursor": "text",
    "total": 1
  }
}

Propose update of PositionAssignments

post

Create new proposals to update PositionAssignment 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[]
activePeriodstringOptional

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

Example: [2023-01-01,2023-12-31)
employeeIDstring · uuidOptional

Omit this field to keep current value

idstring · uuidRequired
remarkstringOptional

Omit this field to keep current value

repositoryIDstring · uuidRequired
tagIDsstring · uuid[]Optional

Omit this field to keep current value

Responses
201

Created successfully

application/json
post
POST /updatePositionAssignments HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 260

[
  {
    "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": false,
    "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
idstringRequired

UpdatePositionAssignmentProposal ID

Responses
200

Successful response

application/json
get
GET /updatePositionAssignments/{id} HTTP/1.1
Host: 
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": false,
  "proposalExecutionErrorText": "text",
  "remark": "text",
  "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
  "requestID": "123e4567-e89b-12d3-a456-426614174000",
  "tagIDs": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}
PreviousMonitoringTracesNextRatingScaleLevelDescriptors

Was this helpful?