API

Human resource APIs

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

Gets a list of competence requirement

HTTP method GET
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
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 6225, version 27

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
$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.
$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.
$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.
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$top String, optional Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10.
$pageKey String, optional Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response.
$filter String, optional Use to filter the result list, see the Filtering and sorting page for more information.
$orderby String, optional Use to order the result list, see the Filtering and sorting page for more information.
$inlinecount String, optional Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none"

Read more about filters and sorting on how to use filter parameters and named filters.

Active() Named filter Named filter showing only active requirements
AddedAt Datetime Automatically generated timestamp when creating a competence requirements. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
CompetenceRequirementId Integer Competence requirements identifier.
CoSignRequirement Integer What type of cosign is required. 0: "No requirement", 1: "Cosign", 2: "Cosign within department".
DeactivatedAt Datetime Date and time the competence requirement was deactivated. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
DocumentCollectionId Integer Identifier of the document collection.
QualityDocumentId Integer Identifier of the quality document.
QualityDocumentTitle String Title of the document.
ReadFrequencyMonths Integer The frequency, in months, at which the document must be re-read.
ReadWithinDays Integer The number of days within which the document must be read.
Status Integer Competence requirement status.

Read more about filters and sorting on how to use sortable parameters

AddedAt Datetime Automatically generated timestamp when creating a competence requirements
CompetenceRequirementId Integer Competence requirements identifier
CoSignRequirement Integer What type of cosign is required. 0: "No requirement", 1: "Cosign", 2: "Cosign within department"
DeactivatedAt Datetime Date and time the competence requirement was deactivated
DocumentCollectionId Integer Identifier of the document collection
QualityDocumentId Integer Identifier of the quality document
QualityDocumentTitle String Title of the document
ReadFrequencyMonths Integer The frequency, in months, at which the document must be re-read
ReadWithinDays Integer The number of days within which the document must be read
Status Integer Competence requirement status

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
<CompetenceRequirements>
2
     <CompetenceRequirement>
3
          <CompetenceRequirementId
CompetenceRequirementId

Competence requirements identifier

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

Automatically generated timestamp when creating a competence requirements

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

Automatically generated timestamp when a competence profile is updated

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

Date and time the competence requirement was deactivated

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

Competence requirement status

Possible domain values can be found here

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

The number of days within which the document must be read

Possible domain values can be found here

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

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

>{Boolean}</NotifyImmediately>
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}</NotifyBy>
12
          <ReadFrequencyMonths
ReadFrequencyMonths

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

Possible domain values can be found here

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

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

>
14
               <QualityDocumentId
QualityDocumentId

Identifier of the quality document

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

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

Status of the document

Possible domain values can be found here

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

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

Title of the document

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

>{String}</Title>
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=CompetenceRequirement.QualityDocument in your request URI to get this field

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

Description of document

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

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

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

>
20
                    <QualityDocumentVersionId
QualityDocumentVersionId

Quality Document Version identifier

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

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

Status of quality document version

Possible domain values can be found here

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

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

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

Possible domain values can be found here

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

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

Date until which the quality document version is valid

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

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

Number of the latest document version.

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

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

API reference to the item

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

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

Quality document reference

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

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

This field is greyed out because it is an expandable field. You have to add $expand=CompetenceRequirement.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=CompetenceRequirement.DocumentCollection in your request URI to get this field

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

Title of document collection

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

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

Document collection reference

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

>{String}</DocumentCollectionLink>
33
          </DocumentCollection>
34
          <CompetenceRequirementLink
CompetenceRequirementLink

API reference to the item

>{String}</CompetenceRequirementLink>
35
     </CompetenceRequirement>
36
     <Paging
Paging

Detailed paging information for this list.

>
37
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>
38
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
39
          <Page
Page

Page index

>{Integer}</Page>
40
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

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

>{String}</FirstPageKey>
41
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>
42
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

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

>{String}</PreviousPageKey>
43
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>
44
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

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

>{String}</NextPageKey>
45
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>
46
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

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

>{String}</LastPageKey>
47
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>
48
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>
49
     </Paging>
50
</CompetenceRequirements>
1
{
2
     "competenceRequirements": [
3
          {
4
               "competenceRequirementId
CompetenceRequirementId

Competence requirements identifier

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

Automatically generated timestamp when creating a competence requirements

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

Automatically generated timestamp when a competence profile is updated

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

Date and time the competence requirement was deactivated

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

Competence requirement status

Possible domain values can be found here

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

The number of days within which the document must be read

Possible domain values can be found here

": "{Integer}",
10
               "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}",
11
               "notifyImmediately
NotifyImmediately

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

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

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

Possible domain values can be found here

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

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

Possible domain values can be found here

": "{Integer}",
14
               "qualityDocument
QualityDocument

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

": {
15
                    "qualityDocumentId
QualityDocumentId

Identifier of the quality document

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

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

Status of the document

Possible domain values can be found here

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

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

Title of the document

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

": "{String}",
18
                    "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=CompetenceRequirement.QualityDocument in your request URI to get this field

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

Description of document

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

": "{String}",
20
                    "lastVersion
LastVersion

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

": {
21
                         "qualityDocumentVersionId
QualityDocumentVersionId

Quality Document Version identifier

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

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

Status of quality document version

Possible domain values can be found here

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

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

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

Possible domain values can be found here

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

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

Date until which the quality document version is valid

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

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

Number of the latest document version.

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

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

API reference to the item

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

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

Quality document reference

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

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

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

": {
31
                    "documentCollectionId
DocumentCollectionId

Identifier of the document collection

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

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

Title of document collection

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

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

Document collection reference

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

": "{String}"
34
               },
35
               "competenceRequirementLink
CompetenceRequirementLink

API reference to the item

": "{String}"
36
          }
37
     ],
38
     "paging
Paging

Detailed paging information for this list.

": {
39
          "pageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

": "{Integer}",
40
          "position
Position

Position of the first element in the list

": "{Integer}",
41
          "page
Page

Page index

": "{Integer}",
42
          "firstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

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

": "{String}",
43
          "firstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

": "{String}",
44
          "previousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

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

": "{String}",
45
          "previousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

": "{String}",
46
          "nextPageKey
NextPageKey

Page key to use for navigating to next page in the list

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

": "{String}",
47
          "nextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

": "{String}",
48
          "lastPageKey
LastPageKey

Page key to use for navigating to last page in the list

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

": "{String}",
49
          "lastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

": "{String}",
50
          "size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

": "{Integer}"
51
     }
52
}

Possible error codes the response might return: