TypesOfProof
Operations for TypesOfProof
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
Filter by skillDefinitionID (exact match)
Maximum number of items to return (1-1000)
10
Cursor for pagination. Use the value from the 'nextCursor' field of the previous response.
Successful response
Bad request
Unauthorized
Internal server error
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-09-12T14:49:01.054Z",
"customValues": {
"department": "Engineering",
"employeeId": "EMP-12345",
"location": "Amsterdam"
},
"description": "text",
"id": "123e4567-e89b-12d3-a456-426614174000",
"lastModifiedAt": "2025-09-12T14:49:01.054Z",
"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 a single TypeOfProof by ID
TypeOfProof ID
Successful response
Unauthorized
Not found
Internal server error
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-09-12T14:49:01.054Z",
"customValues": {
"department": "Engineering",
"employeeId": "EMP-12345",
"location": "Amsterdam"
},
"description": "text",
"id": "123e4567-e89b-12d3-a456-426614174000",
"lastModifiedAt": "2025-09-12T14:49:01.054Z",
"name": {
"en": "English text",
"nl": "Nederlandse tekst"
},
"repositoryID": "123e4567-e89b-12d3-a456-426614174000",
"skillDefinitionID": "123e4567-e89b-12d3-a456-426614174000"
}
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
Filter by skillDefinitionID (exact match)
Maximum number of items to return (1-1000)
10
Cursor for pagination. Use the value from the 'nextCursor' field of the previous response.
Successful response
Bad request
Unauthorized
Internal server error
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
}
}
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.
Date range in PostgreSQL format [start,end)
[2023-01-01,2023-12-31)
Created successfully
Bad request
Unauthorized
Internal server error
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 details of a specific TypesOfProof creation proposal by ID
CreateTypeOfProofProposal ID
Successful response
Unauthorized
Not found
Internal server error
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 all deleteTypesOfProof proposals. These are proposed changes to delete TypesOfProof records that may be automatically approved or require manual approval depending on system configuration.
Maximum number of items to return (1-1000)
10
Cursor for pagination. Use the value from the 'nextCursor' field of the previous response.
Successful response
Bad request
Unauthorized
Internal server error
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
}
}
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.
Created successfully
Bad request
Unauthorized
Internal server error
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 details of a specific TypesOfProof deletion proposal by ID
DeleteTypeOfProofProposal ID
Successful response
Unauthorized
Not found
Internal server error
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 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
Filter by skillDefinitionID (exact match)
Maximum number of items to return (1-1000)
10
Cursor for pagination. Use the value from the 'nextCursor' field of the previous response.
Successful response
Bad request
Unauthorized
Internal server error
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
}
}
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.
Date range in PostgreSQL format [start,end) (omit to keep current value)
[2023-01-01,2023-12-31)
Omit this field to keep current value
Omit this field to keep current value
Omit this field to keep current value
Created successfully
Bad request
Unauthorized
Internal server error
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 details of a specific TypesOfProof update proposal by ID
UpdateTypeOfProofProposal ID
Successful response
Unauthorized
Not found
Internal server error
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"
}
Was this helpful?