API

Base APIs

GET base/organizational-units/{organizationalUnitId}

Returns an organizational unit

HTTP method GET
URI https://api.rambase.net/base/organizational-units/{organizationalUnitId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {organizationalUnitId} Identifier for organizational unit
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 6429, version 15

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
<OrganizationalUnit>
2
     <OrganizationalUnitId
OrganizationalUnitId

Identifier for organizational unit

>{Integer}</OrganizationalUnitId>
3
     <Status
Status

Status of organizational unit

Possible domain values can be found here

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

Title of the organizational unit

>{String}</Title>
5
     <CreatedAt
CreatedAt

Date and time for when an organizational unit was created

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

Date and time for when an organizational unit was updated

>{Datetime}</UpdatedAt>
7
     <Description
Description

Description of the organizational unit

>{String}</Description>
8
     <Type
Type

Domain value reference

Possible domain values can be found here

>{Integer}</Type>
9
     <AddDefaultCompetenceProfilesFromParent
AddDefaultCompetenceProfilesFromParent

Add default competence profile from parent node if true

>{Boolean}</AddDefaultCompetenceProfilesFromParent>
10
     <ParentUnit
ParentUnit

Identifier for the parent unit

>
11
          <OrganizationalUnitId
OrganizationalUnitId

Identifier for organizational unit

>{Integer}</OrganizationalUnitId>
12
          <OrganizationalUnitLink
OrganizationalUnitLink

API reference to the item

>{String}</OrganizationalUnitLink>
13
     </ParentUnit>
14
     <ObjectReference
ObjectReference

Required for types >= 10 and types <= 100 (country, company, location, departments etc)

>
15
          <ObjectId
ObjectId

Identifier of the object

>{Integer}</ObjectId>
16
          <ObjectType
ObjectType

Type of object

>{String}</ObjectType>
17
          <ObjectLink
ObjectLink

API reference to the item

>{String}</ObjectLink>
18
     </ObjectReference>
19
     <ParentUnits
ParentUnits

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

>
20
          <OrganizationalUnit
OrganizationalUnit

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

>
21
               <OrganizationalUnitId
OrganizationalUnitId

Identifier for organizational unit

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

>{String}</OrganizationalUnitId>
22
               <Title
Title

Title of the organizational unit

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

>{String}</Title>
23
               <OrganizationalUnitLink
OrganizationalUnitLink

Identifier of the organizational unit

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

>{String}</OrganizationalUnitLink>
24
          </OrganizationalUnit>
25
     </ParentUnits>
26
     <Totals
Totals

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

>
27
          <OrganizationalUnitsChildrenCount
OrganizationalUnitsChildrenCount

The amount organizational unit that is thildren to this unit

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

>{Integer}</OrganizationalUnitsChildrenCount>
28
          <DefaultCompetenceProfilesChildrenCount
DefaultCompetenceProfilesChildrenCount

The amount of competence profile that are children to this unit

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

>{Integer}</DefaultCompetenceProfilesChildrenCount>
29
     </Totals>
30
</OrganizationalUnit>
1
{
2
     "organizationalUnit": {
3
          "organizationalUnitId
OrganizationalUnitId

Identifier for organizational unit

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

Status of organizational unit

Possible domain values can be found here

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

Title of the organizational unit

": "{String}",
6
          "createdAt
CreatedAt

Date and time for when an organizational unit was created

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

Date and time for when an organizational unit was updated

": "{Datetime}",
8
          "description
Description

Description of the organizational unit

": "{String}",
9
          "type
Type

Domain value reference

Possible domain values can be found here

": "{Integer}",
10
          "addDefaultCompetenceProfilesFromParent
AddDefaultCompetenceProfilesFromParent

Add default competence profile from parent node if true

": "{Boolean}",
11
          "parentUnit
ParentUnit

Identifier for the parent unit

": {
12
               "organizationalUnitId
OrganizationalUnitId

Identifier for organizational unit

": "{Integer}",
13
               "organizationalUnitLink
OrganizationalUnitLink

API reference to the item

": "{String}"
14
          },
15
          "objectReference
ObjectReference

Required for types >= 10 and types <= 100 (country, company, location, departments etc)

": {
16
               "objectId
ObjectId

Identifier of the object

": "{Integer}",
17
               "objectType
ObjectType

Type of object

": "{String}",
18
               "objectLink
ObjectLink

API reference to the item

": "{String}"
19
          },
20
          "parentUnits
ParentUnits

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

": [
21
               {
22
                    "organizationalUnitId
OrganizationalUnitId

Identifier for organizational unit

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

": "{String}",
23
                    "title
Title

Title of the organizational unit

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

": "{String}",
24
                    "organizationalUnitLink
OrganizationalUnitLink

Identifier of the organizational unit

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

": "{String}"
25
               }
26
          ],
27
          "totals
Totals

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

": {
28
               "organizationalUnitsChildrenCount
OrganizationalUnitsChildrenCount

The amount organizational unit that is thildren to this unit

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

": "{Integer}",
29
               "defaultCompetenceProfilesChildrenCount
DefaultCompetenceProfilesChildrenCount

The amount of competence profile that are children to this unit

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

": "{Integer}"
30
          }
31
     }
32
}

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: