API

Human resource APIs

GET human-resources/competence-profiles/{competenceProfileId}/document-collections

Gets a list of document collections that are used in a competence profile

HTTP method GET
URI https://api.rambase.net/human-resources/competence-profiles/{competenceProfileId}/document-collections
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 6342, version 16

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 List of active document collection in competence profile
AddedAt Datetime Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
DeactivatedAt Datetime Date and time a document collection was removed from a competence profile. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
Description String Description of the document collection.
DocumentCollectionId Integer Identifier of the document collection.
ProfileDocumentCollectionId Integer Identifier of the document collection.
Status Integer Competence profile document collection status. 4 Active, 9 Disabled.
Title String Title of document collection.

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

AddedAt Datetime Date and time of creation
DeactivatedAt Datetime Date and time a document collection was removed from a competence profile
Description String Description of the document collection
DocumentCollectionId Integer Identifier of the document collection
ProfileDocumentCollectionId Integer Identifier of the document collection
Status Integer Competence profile document collection status. 4 Active, 9 Disabled
Title String Title of document collection

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
<ProfileDocumentCollections>
2
     <ProfileDocumentCollection>
3
          <ProfileDocumentCollectionId
ProfileDocumentCollectionId

Document collection member identifier

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

Date and time of creation

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

Competence profile document collection status. 4 Active, 9 Disabled

Possible domain values can be found here

>{Integer}</Status>
6
          <RemovedAt
RemovedAt

Date and time a document collection was removed from a competence profile

>{Datetime}</RemovedAt>
7
          <ProfileDocumentCollectionLink
ProfileDocumentCollectionLink

API reference to the object

>{String}</ProfileDocumentCollectionLink>
8
          <DocumentCollection>
9
               <DocumentCollectionId
DocumentCollectionId

Identifier of the document collection

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

Title of document collection

>{String}</Title>
11
               <Description
Description

Description of the document collection

>{String}</Description>
12
               <NumberOfQualityDocuments
NumberOfQualityDocuments

Number of documents contained in this collection

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

>{Integer}</NumberOfQualityDocuments>
13
               <DocumentCollectionLink
DocumentCollectionLink

API reference to the object

>{String}</DocumentCollectionLink>
14
          </DocumentCollection>
15
     </ProfileDocumentCollection>
16
     <Paging
Paging

Detailed paging information for this list.

>
17
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
20
          <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>
21
          <FirstPage
FirstPage

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

>{String}</FirstPage>
22
          <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>
23
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
24
          <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>
25
          <NextPage
NextPage

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

>{String}</NextPage>
26
          <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>
27
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
29
     </Paging>
30
</ProfileDocumentCollections>
1
{
2
     "profileDocumentCollections": [
3
          {
4
               "profileDocumentCollectionId
ProfileDocumentCollectionId

Document collection member identifier

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

Date and time of creation

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

Competence profile document collection status. 4 Active, 9 Disabled

Possible domain values can be found here

": "{Integer}",
7
               "removedAt
RemovedAt

Date and time a document collection was removed from a competence profile

": "{Datetime}",
8
               "profileDocumentCollectionLink
ProfileDocumentCollectionLink

API reference to the object

": "{String}",
9
               "documentCollection": {
10
                    "documentCollectionId
DocumentCollectionId

Identifier of the document collection

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

Title of document collection

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

Description of the document collection

": "{String}",
13
                    "numberOfQualityDocuments
NumberOfQualityDocuments

Number of documents contained in this collection

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

": "{Integer}",
14
                    "documentCollectionLink
DocumentCollectionLink

API reference to the object

": "{String}"
15
               }
16
          }
17
     ],
18
     "paging
Paging

Detailed paging information for this list.

": {
19
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

": "{Integer}",
22
          "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}",
23
          "firstPage
FirstPage

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

": "{String}",
24
          "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}",
25
          "previousPage
PreviousPage

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

": "{String}",
26
          "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}",
27
          "nextPage
NextPage

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

": "{String}",
28
          "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}",
29
          "lastPage
LastPage

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

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

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

": "{Integer}"
31
     }
32
}

Possible error codes the response might return: