AG5.comSupportRequest a demo

TypesOfProof

Operations for TypesOfProof

List typesOfProof

get

List typesOfProof

Filter Syntax:

  • Filters use exact match only

  • Multiple filters are combined with AND logic

  • Filterable fields: skillDefinitionID

  • Example: ?skillDefinitionID=123e4567-e89b-12d3-a456-426614174000

Authorizations
Query parameters
skillDefinitionIDstringOptional

Filter by skillDefinitionID (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 /typesOfProof HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "activePeriod": "[2023-01-01,2023-12-31)",
      "code": "text",
      "createdAt": "2025-08-14T13:59:55.019Z",
      "customValues": {
        "department": "Engineering",
        "employeeId": "EMP-12345",
        "location": "Amsterdam"
      },
      "description": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "lastModifiedAt": "2025-08-14T13:59:55.019Z",
      "name": {
        "en": "English text",
        "nl": "Nederlandse tekst"
      },
      "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
      "skillDefinitionID": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "pagination": {
    "count": 1,
    "hasMore": true,
    "limit": 1,
    "nextCursor": "text",
    "total": 1
  }
}

Get TypeOfProof

get

Get a single TypeOfProof by ID

Authorizations
Path parameters
idstringRequired

TypeOfProof ID

Responses
200

Successful response

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

{
  "activePeriod": "[2023-01-01,2023-12-31)",
  "code": "text",
  "createdAt": "2025-08-14T13:59:55.019Z",
  "customValues": {
    "department": "Engineering",
    "employeeId": "EMP-12345",
    "location": "Amsterdam"
  },
  "description": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "lastModifiedAt": "2025-08-14T13:59:55.019Z",
  "name": {
    "en": "English text",
    "nl": "Nederlandse tekst"
  },
  "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
  "skillDefinitionID": "123e4567-e89b-12d3-a456-426614174000"
}

List TypesOfProof creation proposals

get

List all createTypesOfProof proposals. These are proposed changes to create new TypesOfProof 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: skillDefinitionID

  • Example: ?skillDefinitionID=123e4567-e89b-12d3-a456-426614174000

Authorizations
Query parameters
skillDefinitionIDstringOptional

Filter by skillDefinitionID (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 /createTypesOfProof HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "activePeriod": "[2023-01-01,2023-12-31)",
      "code": "text",
      "customValues": {
        "department": "Engineering",
        "employeeId": "EMP-12345",
        "location": "Amsterdam"
      },
      "description": "text",
      "isProposalExecutionFailed": true,
      "isProposalResolved": false,
      "name": {
        "en": "English text",
        "nl": "Nederlandse tekst"
      },
      "proposalExecutionErrorText": "text",
      "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
      "requestID": "123e4567-e89b-12d3-a456-426614174000",
      "skillDefinitionID": "123e4567-e89b-12d3-a456-426614174000",
      "subjectID": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "pagination": {
    "count": 1,
    "hasMore": true,
    "limit": 1,
    "nextCursor": "text",
    "total": 1
  }
}

Propose creation of TypesOfProofs

post

Create new proposals to add TypesOfProof 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)
codestringOptional
descriptionstringOptional
repositoryIDstring · uuidRequired
skillDefinitionIDstring · uuidRequired
Responses
201

Created successfully

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

[
  {
    "activePeriod": "[2023-01-01,2023-12-31)",
    "code": "text",
    "customValues": {
      "department": "Engineering",
      "employeeId": "EMP-12345",
      "location": "Amsterdam"
    },
    "description": "text",
    "name": {
      "en": "English text",
      "nl": "Nederlandse tekst"
    },
    "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
    "skillDefinitionID": "123e4567-e89b-12d3-a456-426614174000"
  }
]
[
  {
    "activePeriod": "[2023-01-01,2023-12-31)",
    "code": "text",
    "customValues": {
      "department": "Engineering",
      "employeeId": "EMP-12345",
      "location": "Amsterdam"
    },
    "description": "text",
    "isProposalExecutionFailed": true,
    "isProposalResolved": false,
    "name": {
      "en": "English text",
      "nl": "Nederlandse tekst"
    },
    "proposalExecutionErrorText": "text",
    "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
    "requestID": "123e4567-e89b-12d3-a456-426614174000",
    "skillDefinitionID": "123e4567-e89b-12d3-a456-426614174000",
    "subjectID": "123e4567-e89b-12d3-a456-426614174000"
  }
]

Get TypesOfProof creation proposal

get

Get details of a specific TypesOfProof creation proposal by ID

Authorizations
Path parameters
idstringRequired

CreateTypeOfProofProposal ID

Responses
200

Successful response

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

{
  "activePeriod": "[2023-01-01,2023-12-31)",
  "code": "text",
  "customValues": {
    "department": "Engineering",
    "employeeId": "EMP-12345",
    "location": "Amsterdam"
  },
  "description": "text",
  "isProposalExecutionFailed": true,
  "isProposalResolved": false,
  "name": {
    "en": "English text",
    "nl": "Nederlandse tekst"
  },
  "proposalExecutionErrorText": "text",
  "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
  "requestID": "123e4567-e89b-12d3-a456-426614174000",
  "skillDefinitionID": "123e4567-e89b-12d3-a456-426614174000",
  "subjectID": "123e4567-e89b-12d3-a456-426614174000"
}

List TypesOfProof deletion proposals

get

List all deleteTypesOfProof proposals. These are proposed changes to delete TypesOfProof 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 /deleteTypesOfProof 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 TypesOfProofs

post

Create new proposals to delete TypesOfProof 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 /deleteTypesOfProof 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 TypesOfProof deletion proposal

get

Get details of a specific TypesOfProof deletion proposal by ID

Authorizations
Path parameters
idstringRequired

DeleteTypeOfProofProposal ID

Responses
200

Successful response

application/json
get
GET /deleteTypesOfProof/{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 TypesOfProof update proposals

get

List all updateTypesOfProof proposals. These are proposed changes to update existing TypesOfProof 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: skillDefinitionID

  • Example: ?skillDefinitionID=123e4567-e89b-12d3-a456-426614174000

Authorizations
Query parameters
skillDefinitionIDstringOptional

Filter by skillDefinitionID (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 /updateTypesOfProof HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "activePeriod": "[2023-01-01,2023-12-31)",
      "code": "text",
      "customValues": {
        "department": "Engineering",
        "employeeId": "EMP-12345",
        "location": "Amsterdam"
      },
      "description": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "isProposalExecutionFailed": true,
      "isProposalResolved": false,
      "name": {
        "en": "English text",
        "nl": "Nederlandse tekst"
      },
      "proposalExecutionErrorText": "text",
      "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
      "requestID": "123e4567-e89b-12d3-a456-426614174000",
      "skillDefinitionID": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "pagination": {
    "count": 1,
    "hasMore": true,
    "limit": 1,
    "nextCursor": "text",
    "total": 1
  }
}

Propose update of TypesOfProofs

post

Create new proposals to update TypesOfProof 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)
codestringOptional

Omit this field to keep current value

descriptionstringOptional

Omit this field to keep current value

idstring · uuidRequired
repositoryIDstring · uuidRequired
skillDefinitionIDstring · uuidOptional

Omit this field to keep current value

Responses
201

Created successfully

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

[
  {
    "activePeriod": "[2023-01-01,2023-12-31)",
    "code": "text",
    "customValues": {
      "department": "Engineering",
      "employeeId": "EMP-12345",
      "location": "Amsterdam"
    },
    "description": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": {
      "en": "English text",
      "nl": "Nederlandse tekst"
    },
    "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
    "skillDefinitionID": "123e4567-e89b-12d3-a456-426614174000"
  }
]
[
  {
    "activePeriod": "[2023-01-01,2023-12-31)",
    "code": "text",
    "customValues": {
      "department": "Engineering",
      "employeeId": "EMP-12345",
      "location": "Amsterdam"
    },
    "description": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "isProposalExecutionFailed": true,
    "isProposalResolved": false,
    "name": {
      "en": "English text",
      "nl": "Nederlandse tekst"
    },
    "proposalExecutionErrorText": "text",
    "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
    "requestID": "123e4567-e89b-12d3-a456-426614174000",
    "skillDefinitionID": "123e4567-e89b-12d3-a456-426614174000"
  }
]

Get TypesOfProof update proposal

get

Get details of a specific TypesOfProof update proposal by ID

Authorizations
Path parameters
idstringRequired

UpdateTypeOfProofProposal ID

Responses
200

Successful response

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

{
  "activePeriod": "[2023-01-01,2023-12-31)",
  "code": "text",
  "customValues": {
    "department": "Engineering",
    "employeeId": "EMP-12345",
    "location": "Amsterdam"
  },
  "description": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "isProposalExecutionFailed": true,
  "isProposalResolved": false,
  "name": {
    "en": "English text",
    "nl": "Nederlandse tekst"
  },
  "proposalExecutionErrorText": "text",
  "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
  "requestID": "123e4567-e89b-12d3-a456-426614174000",
  "skillDefinitionID": "123e4567-e89b-12d3-a456-426614174000"
}
PreviousSkillResultsNextModels

Was this helpful?