Human resource APIs
Creates a competence requirement
| HTTP method | POST |
| URI | https://api.rambase.net/human-resources/competence-profiles/{competenceProfileId}/competence-requirements |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {competenceProfileId} |
Competence profile identifier
Integer, minimum 100000 |
| Successful HTTP status code | 201 |
| API resource identifier | 6226, version 4 |
The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.
ReadWithinDays
Required/mandatory field
The number of days within which the document must be read
Applicable domain values can be found here
>{Integer}</ReadWithinDays>CoSignRequirement
What type of cosign is required. 0: "No requirement", 1: "Cosign", 2: "Cosign within department"
Applicable domain values can be found here
This field is optional.
>{Integer}</CoSignRequirement>NotifyImmediately
Dont wait until next time you have read document. Notification immediately
Default value: False
This field is optional.
>{Boolean}</NotifyImmediately>NotifyBy
What type of method should be used for notifications on this requirement. 1: Mail
Applicable domain values can be found here
This field is optional.
>{Integer}</NotifyBy>ReadFrequencyMonths
The frequency, in months, at which the document must be re-read
Applicable domain values can be found here
This field is optional.
>{Integer}</ReadFrequencyMonths>QualityDocument
This field is optional.
>QualityDocumentId
Identifier of the quality document
Minimum value: 1
This field is optional.
>{Integer}</QualityDocumentId>ReadWithinDays
Required/mandatory field
The number of days within which the document must be read
Applicable domain values can be found here
": "{Integer}",CoSignRequirement
What type of cosign is required. 0: "No requirement", 1: "Cosign", 2: "Cosign within department"
Applicable domain values can be found here
This field is optional.
": "{Integer}",NotifyImmediately
Dont wait until next time you have read document. Notification immediately
Default value: False
This field is optional.
": "{Boolean}",NotifyBy
What type of method should be used for notifications on this requirement. 1: Mail
Applicable domain values can be found here
This field is optional.
": "{Integer}",ReadFrequencyMonths
The frequency, in months, at which the document must be re-read
Applicable domain values can be found here
This field is optional.
": "{Integer}",QualityDocument
This field is optional.
": {QualityDocumentId
Identifier of the quality document
Minimum value: 1
This field is optional.
": "{Integer}"The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.
| $access_token String, optional | After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time. |
| $db String, optional | Set the database/company for the request |
| $useMinimumVersion Integer, optional | Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information. |
| $showDomainDescriptions Boolean, optional | Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false. |
| $lang String, optional | Specifies the language used in the response, following the 3-letter ISO-639-1 [lll] |
Read more about filters and sorting on how to use filter parameters and named filters.
Read more about filters and sorting on how to use sortable parameters
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
CompetenceRequirementId
Competence requirements identifier
>{Integer}</CompetenceRequirementId>AddedAt
Automatically generated timestamp when creating a competence requirements
>{Datetime}</AddedAt>UpdatedAt
Automatically generated timestamp when a competence profile is updated
>{Datetime}</UpdatedAt>DeactivatedAt
Date and time the competence requirement was deactivated
>{Datetime}</DeactivatedAt>Status
Competence requirement status
Possible domain values can be found here
>{Integer}</Status>ReadWithinDays
The number of days within which the document must be read
Possible domain values can be found here
>{Integer}</ReadWithinDays>CoSignRequirement
What type of cosign is required. 0: "No requirement", 1: "Cosign", 2: "Cosign within department"
Possible domain values can be found here
>{Integer}</CoSignRequirement>NotifyImmediately
Dont wait until next time you have read document. Notification immediately
>{Boolean}</NotifyImmediately>NotifyBy
What type of method should be used for notifications on this requirement. 1: Mail
Possible domain values can be found here
>{Integer}</NotifyBy>ReadFrequencyMonths
The frequency, in months, at which the document must be re-read
Possible domain values can be found here
>{Integer}</ReadFrequencyMonths>QualityDocumentId
Identifier of the quality document
>{Integer}</QualityDocumentId>Title
Title of the document
>{String}</Title>Description
Description of document
>{String}</Description>QualityDocumentVersionId
Quality Document Version identifier
>{Integer}</QualityDocumentVersionId>Status
Status of quality document version
Possible domain values can be found here
>{Integer}</Status>ContentType
Document type. Can be quiz, message, file url or structured content
Possible domain values can be found here
>{String}</ContentType>ValidTo
Date until which the quality document version is valid
>{Date}</ValidTo>Version
Number of the latest document version.
>{Integer}</Version>QualityDocumentVersionLink
API reference to the item
>{String}</QualityDocumentVersionLink>QualityDocumentLink
Quality document reference
>{String}</QualityDocumentLink>DocumentCollectionId
Identifier of the document collection
>{Integer}</DocumentCollectionId>Title
Title of document collection
>{String}</Title>DocumentCollectionLink
Document collection reference
>{String}</DocumentCollectionLink>CompetenceRequirementId
Competence requirements identifier
": "{Integer}",AddedAt
Automatically generated timestamp when creating a competence requirements
": "{Datetime}",UpdatedAt
Automatically generated timestamp when a competence profile is updated
": "{Datetime}",DeactivatedAt
Date and time the competence requirement was deactivated
": "{Datetime}",Status
Competence requirement status
Possible domain values can be found here
": "{Integer}",ReadWithinDays
The number of days within which the document must be read
Possible domain values can be found here
": "{Integer}",CoSignRequirement
What type of cosign is required. 0: "No requirement", 1: "Cosign", 2: "Cosign within department"
Possible domain values can be found here
": "{Integer}",NotifyImmediately
Dont wait until next time you have read document. Notification immediately
": "{Boolean}",NotifyBy
What type of method should be used for notifications on this requirement. 1: Mail
Possible domain values can be found here
": "{Integer}",ReadFrequencyMonths
The frequency, in months, at which the document must be re-read
Possible domain values can be found here
": "{Integer}",QualityDocumentId
Identifier of the quality document
": "{Integer}",Status
Status of the document
Possible domain values can be found here
": "{Integer}",Title
Title of the document
": "{String}",Description
Description of document
": "{String}",QualityDocumentVersionId
Quality Document Version identifier
": "{Integer}",Status
Status of quality document version
Possible domain values can be found here
": "{Integer}",ContentType
Document type. Can be quiz, message, file url or structured content
Possible domain values can be found here
": "{String}",ValidTo
Date until which the quality document version is valid
": "{Date}",Version
Number of the latest document version.
": "{Integer}",QualityDocumentVersionLink
API reference to the item
": "{String}"QualityDocumentLink
Quality document reference
": "{String}",DocumentCollectionId
Identifier of the document collection
": "{Integer}",Title
Title of document collection
": "{String}",DocumentCollectionLink
Document collection reference
": "{String}"
List of available operations/actions for this resource.
See the operations documentation for more information about API operations.
Possible error codes the response might return: