API

Human resource APIs

GET human-resources/competence-profiles/{competenceProfileId}/competence-requirements/{competenceRequirementId}

Gets a competence requirement

HTTP method GET
URI https://api.rambase.net/human-resources/competence-profiles/{competenceProfileId}/competence-requirements/{competenceRequirementId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {competenceProfileId} Competence profile identifier
Integer, minimum 100000
- URI parameter {competenceRequirementId} Competence requirements identifier
Integer, minimum 1
Successful HTTP status code 200
API resource identifier 6228, version 14

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.

Format:
1
1

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.

$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]
$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
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$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.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.

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. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<CompetenceRequirement>
2
     <CompetenceRequirementId
CompetenceRequirementId

Competence requirements identifier

>{Integer}</CompetenceRequirementId>
3
     <AddedAt
AddedAt

Automatically generated timestamp when creating a competence requirements

>{Datetime}</AddedAt>
4
     <UpdatedAt
UpdatedAt

Automatically generated timestamp when a competence profile is updated

>{Datetime}</UpdatedAt>
5
     <DeactivatedAt
DeactivatedAt

Date and time the competence requirement was deactivated

>{Datetime}</DeactivatedAt>
6
     <Status
Status

Competence requirement status

Possible domain values can be found here

>{Integer}</Status>
7
     <ReadWithinDays
ReadWithinDays

The number of days within which the document must be read

Possible domain values can be found here

>{Integer}</ReadWithinDays>
8
     <CoSignRequirement
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>
9
     <NotifyImmediately
NotifyImmediately

Dont wait until next time you have read document. Notification immediately

>{Boolean}</NotifyImmediately>
10
     <NotifyBy
NotifyBy

What type of method should be used for notifications on this requirement. 1: Mail

Possible domain values can be found here

>{Integer}</NotifyBy>
11
     <ReadFrequencyMonths
ReadFrequencyMonths

The frequency, in months, at which the document must be re-read

Possible domain values can be found here

>{Integer}</ReadFrequencyMonths>
12
     <QualityDocument>
13
          <QualityDocumentId
QualityDocumentId

Identifier of the quality document

>{Integer}</QualityDocumentId>
14
          <Status
Status

Status of the document

Possible domain values can be found here

>{Integer}</Status>
15
          <Title
Title

Title of the document

>{String}</Title>
16
          <DisplayTitle
DisplayTitle

Title generated according to the system setting.

This field is greyed out because it is an expandable field. You have to add $expand=QualityDocument.DisplayTitle in your request URI to get this field

>{String}</DisplayTitle>
17
          <Description
Description

Description of document

>{String}</Description>
18
          <LastVersion>
19
               <QualityDocumentVersionId
QualityDocumentVersionId

Quality Document Version identifier

>{Integer}</QualityDocumentVersionId>
20
               <Status
Status

Status of quality document version

Possible domain values can be found here

>{Integer}</Status>
21
               <ContentType
ContentType

Document type. Can be quiz, message, file url or structured content

Possible domain values can be found here

>{String}</ContentType>
22
               <ValidTo
ValidTo

Date until which the quality document version is valid

>{Date}</ValidTo>
23
               <Version
Version

Number of the latest document version.

>{Integer}</Version>
24
               <QualityDocumentVersionLink
QualityDocumentVersionLink

API reference to the item

>{String}</QualityDocumentVersionLink>
25
          </LastVersion>
26
          <QualityDocumentLink
QualityDocumentLink

Quality document reference

>{String}</QualityDocumentLink>
27
     </QualityDocument>
28
     <DocumentCollection
DocumentCollection

This field is greyed out because it is an expandable field. You have to add $expand=DocumentCollection in your request URI to get this field

>
29
          <DocumentCollectionId
DocumentCollectionId

Identifier of the document collection

This field is greyed out because it is an expandable field. You have to add $expand=DocumentCollection in your request URI to get this field

>{Integer}</DocumentCollectionId>
30
          <Title
Title

Title of document collection

This field is greyed out because it is an expandable field. You have to add $expand=DocumentCollection in your request URI to get this field

>{String}</Title>
31
          <DocumentCollectionLink
DocumentCollectionLink

Document collection reference

This field is greyed out because it is an expandable field. You have to add $expand=DocumentCollection in your request URI to get this field

>{String}</DocumentCollectionLink>
32
     </DocumentCollection>
33
</CompetenceRequirement>
1
{
2
     "competenceRequirement": {
3
          "competenceRequirementId
CompetenceRequirementId

Competence requirements identifier

": "{Integer}",
4
          "addedAt
AddedAt

Automatically generated timestamp when creating a competence requirements

": "{Datetime}",
5
          "updatedAt
UpdatedAt

Automatically generated timestamp when a competence profile is updated

": "{Datetime}",
6
          "deactivatedAt
DeactivatedAt

Date and time the competence requirement was deactivated

": "{Datetime}",
7
          "status
Status

Competence requirement status

Possible domain values can be found here

": "{Integer}",
8
          "readWithinDays
ReadWithinDays

The number of days within which the document must be read

Possible domain values can be found here

": "{Integer}",
9
          "coSignRequirement
CoSignRequirement

What type of cosign is required. 0: "No requirement", 1: "Cosign", 2: "Cosign within department"

Possible domain values can be found here

": "{Integer}",
10
          "notifyImmediately
NotifyImmediately

Dont wait until next time you have read document. Notification immediately

": "{Boolean}",
11
          "notifyBy
NotifyBy

What type of method should be used for notifications on this requirement. 1: Mail

Possible domain values can be found here

": "{Integer}",
12
          "readFrequencyMonths
ReadFrequencyMonths

The frequency, in months, at which the document must be re-read

Possible domain values can be found here

": "{Integer}",
13
          "qualityDocument": {
14
               "qualityDocumentId
QualityDocumentId

Identifier of the quality document

": "{Integer}",
15
               "status
Status

Status of the document

Possible domain values can be found here

": "{Integer}",
16
               "title
Title

Title of the document

": "{String}",
17
               "displayTitle
DisplayTitle

Title generated according to the system setting.

This field is greyed out because it is an expandable field. You have to add $expand=QualityDocument.DisplayTitle in your request URI to get this field

": "{String}",
18
               "description
Description

Description of document

": "{String}",
19
               "lastVersion": {
20
                    "qualityDocumentVersionId
QualityDocumentVersionId

Quality Document Version identifier

": "{Integer}",
21
                    "status
Status

Status of quality document version

Possible domain values can be found here

": "{Integer}",
22
                    "contentType
ContentType

Document type. Can be quiz, message, file url or structured content

Possible domain values can be found here

": "{String}",
23
                    "validTo
ValidTo

Date until which the quality document version is valid

": "{Date}",
24
                    "version
Version

Number of the latest document version.

": "{Integer}",
25
                    "qualityDocumentVersionLink
QualityDocumentVersionLink

API reference to the item

": "{String}"
26
               },
27
               "qualityDocumentLink
QualityDocumentLink

Quality document reference

": "{String}"
28
          },
29
          "documentCollection
DocumentCollection

This field is greyed out because it is an expandable field. You have to add $expand=DocumentCollection in your request URI to get this field

": {
30
               "documentCollectionId
DocumentCollectionId

Identifier of the document collection

This field is greyed out because it is an expandable field. You have to add $expand=DocumentCollection in your request URI to get this field

": "{Integer}",
31
               "title
Title

Title of document collection

This field is greyed out because it is an expandable field. You have to add $expand=DocumentCollection in your request URI to get this field

": "{String}",
32
               "documentCollectionLink
DocumentCollectionLink

Document collection reference

This field is greyed out because it is an expandable field. You have to add $expand=DocumentCollection in your request URI to get this field

": "{String}"
33
          }
34
     }
35
}

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: