Base APIs
Creates an organizational unit
| HTTP method | POST |
| URI | https://api.rambase.net/base/organizational-units |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Successful HTTP status code | 201 |
| API resource identifier | 6427, version 8 |
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.
Title
Title of the organizational unit
This field is optional.
>{String}</Title>Description
Description of the organizational unit
This field is optional.
>{String}</Description>Type
Required/mandatory field
Domain value reference
Applicable domain values can be found here
>{Integer}</Type>AddDefaultCompetenceProfilesFromParent
Required/mandatory field
Add default competence profile from parent node if true
>{Boolean}</AddDefaultCompetenceProfilesFromParent>ParentUnit
Identifier for the parent unit
This field is optional.
>OrganizationalUnitId
Identifier for organizational unit
Minimum value: 100000
This field is optional.
>{Integer}</OrganizationalUnitId>ObjectReference
Required for types >= 10 and types <= 100 (country, company, location, departments etc)
This field is optional.
>ObjectId
Identifier of the object
Minimum value: 100000
This field is optional.
>{Integer}</ObjectId>Title
Title of the organizational unit
This field is optional.
": "{String}",Description
Description of the organizational unit
This field is optional.
": "{String}",Type
Required/mandatory field
Domain value reference
Applicable domain values can be found here
": "{Integer}",AddDefaultCompetenceProfilesFromParent
Required/mandatory field
Add default competence profile from parent node if true
": "{Boolean}",ParentUnit
Identifier for the parent unit
This field is optional.
": {OrganizationalUnitId
Identifier for organizational unit
Minimum value: 100000
This field is optional.
": "{Integer}"ObjectReference
Required for types >= 10 and types <= 100 (country, company, location, departments etc)
This field is optional.
": {ObjectId
Identifier of the object
Minimum value: 100000
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.
OrganizationalUnitId
Identifier for organizational unit
>{Integer}</OrganizationalUnitId>Status
Status of organizational unit
Possible domain values can be found here
>{Integer}</Status>Title
Title of the organizational unit
>{String}</Title>CreatedAt
Date and time for when an organizational unit was created
>{Datetime}</CreatedAt>UpdatedAt
Date and time for when an organizational unit was updated
>{Datetime}</UpdatedAt>Description
Description of the organizational unit
>{String}</Description>AddDefaultCompetenceProfilesFromParent
Add default competence profile from parent node if true
>{Boolean}</AddDefaultCompetenceProfilesFromParent>ParentUnit
Identifier for the parent unit
>OrganizationalUnitId
Identifier for organizational unit
>{Integer}</OrganizationalUnitId>OrganizationalUnitLink
API reference to the item
>{String}</OrganizationalUnitLink>ObjectReference
Required for types >= 10 and types <= 100 (country, company, location, departments etc)
>ObjectId
Identifier of the object
>{Integer}</ObjectId>ObjectType
Type of object
>{String}</ObjectType>ObjectLink
API reference to the item
>{String}</ObjectLink>OrganizationalUnitId
Identifier for organizational unit
>{String}</OrganizationalUnitId>Title
Title of the organizational unit
>{String}</Title>OrganizationalUnitLink
Identifier of the organizational unit
>{String}</OrganizationalUnitLink>OrganizationalUnitsChildrenCount
The amount organizational unit that is thildren to this unit
>{Integer}</OrganizationalUnitsChildrenCount>DefaultCompetenceProfilesChildrenCount
The amount of competence profile that are children to this unit
>{Integer}</DefaultCompetenceProfilesChildrenCount>OrganizationalUnitId
Identifier for organizational unit
": "{Integer}",Status
Status of organizational unit
Possible domain values can be found here
": "{Integer}",Title
Title of the organizational unit
": "{String}",CreatedAt
Date and time for when an organizational unit was created
": "{Datetime}",UpdatedAt
Date and time for when an organizational unit was updated
": "{Datetime}",Description
Description of the organizational unit
": "{String}",Type
Domain value reference
Possible domain values can be found here
": "{Integer}",AddDefaultCompetenceProfilesFromParent
Add default competence profile from parent node if true
": "{Boolean}",ParentUnit
Identifier for the parent unit
": {OrganizationalUnitId
Identifier for organizational unit
": "{Integer}",OrganizationalUnitLink
API reference to the item
": "{String}"ObjectReference
Required for types >= 10 and types <= 100 (country, company, location, departments etc)
": {ObjectId
Identifier of the object
": "{Integer}",ObjectType
Type of object
": "{String}",ObjectLink
API reference to the item
": "{String}",OrganizationalUnitId
Identifier for organizational unit
": "{String}",Title
Title of the organizational unit
": "{String}",OrganizationalUnitLink
Identifier of the organizational unit
": "{String}"OrganizationalUnitsChildrenCount
The amount organizational unit that is thildren to this unit
": "{Integer}",DefaultCompetenceProfilesChildrenCount
The amount of competence profile that are children to this unit
": "{Integer}"
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: