API

Production APIs

GET production/resource-categories/{productionResourceCategoryId}

Details of production resource category

HTTP method GET
URI https://api.rambase.net/production/resource-categories/{productionResourceCategoryId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {productionResourceCategoryId} Production resource category identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 5134, version 7

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
<ProductionResourceCategory>
2
     <ProductionResourceCategoryId
ProductionResourceCategoryId

Production resource category identifier

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

Production resource category status

Possible domain values can be found here

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

Date and time of creation

>{Datetime}</CreatedAt>
5
     <Name
Name

Production resource category name

>{String}</Name>
6
     <Description
Description

Production resource category description

>{String}</Description>
7
     <Label
Label

Unique name for the production resource category . Built using name from this and levels above

>{String}</Label>
8
     <TreeLevel
TreeLevel

Production resource category's tree level

>{Integer}</TreeLevel>
9
     <HasChildren
HasChildren

Flag to indicate if production resource category has children

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

>{Boolean}</HasChildren>
10
     <NumberOfChildren
NumberOfChildren

Production resource category's number of children

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

>{Integer}</NumberOfChildren>
11
     <ParentProductionResourceCategory>
12
          <ProductionResourceCategoryId
ProductionResourceCategoryId

Reference to the level above this production resource category. If empty then this is the top location.

>{Integer}</ProductionResourceCategoryId>
13
          <ProductionResourceCategoryLink
ProductionResourceCategoryLink

Production resource category reference

>{String}</ProductionResourceCategoryLink>
14
     </ParentProductionResourceCategory>
15
     <ParentProductionResourceCategories
ParentProductionResourceCategories

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

>
16
          <ParentProductionResourceCategory
ParentProductionResourceCategory

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

>
17
               <ProductionResourceCategoryId
ProductionResourceCategoryId

Production resource category identifier

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

>{Integer}</ProductionResourceCategoryId>
18
               <Name
Name

Production resource category name

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

>{String}</Name>
19
               <TreeLevel
TreeLevel

Production resource category's tree level

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

>{Integer}</TreeLevel>
20
               <ProductionResourceCategoryLink
ProductionResourceCategoryLink

Production resource category reference

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

>{String}</ProductionResourceCategoryLink>
21
          </ParentProductionResourceCategory>
22
     </ParentProductionResourceCategories>
23
</ProductionResourceCategory>
1
{
2
     "productionResourceCategory": {
3
          "productionResourceCategoryId
ProductionResourceCategoryId

Production resource category identifier

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

Production resource category status

Possible domain values can be found here

": "{Integer}",
5
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
6
          "name
Name

Production resource category name

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

Production resource category description

": "{String}",
8
          "label
Label

Unique name for the production resource category . Built using name from this and levels above

": "{String}",
9
          "treeLevel
TreeLevel

Production resource category's tree level

": "{Integer}",
10
          "hasChildren
HasChildren

Flag to indicate if production resource category has children

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

": "{Boolean}",
11
          "numberOfChildren
NumberOfChildren

Production resource category's number of children

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

": "{Integer}",
12
          "parentProductionResourceCategory": {
13
               "productionResourceCategoryId
ProductionResourceCategoryId

Reference to the level above this production resource category. If empty then this is the top location.

": "{Integer}",
14
               "productionResourceCategoryLink
ProductionResourceCategoryLink

Production resource category reference

": "{String}"
15
          },
16
          "parentProductionResourceCategories
ParentProductionResourceCategories

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

": [
17
               {
18
                    "productionResourceCategoryId
ProductionResourceCategoryId

Production resource category identifier

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

": "{Integer}",
19
                    "name
Name

Production resource category name

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

": "{String}",
20
                    "treeLevel
TreeLevel

Production resource category's tree level

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

": "{Integer}",
21
                    "productionResourceCategoryLink
ProductionResourceCategoryLink

Production resource category reference

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

": "{String}"
22
               }
23
          ]
24
     }
25
}

Possible error codes the response might return:

Error 100036 HTTP 400 Missing required input parameter: {0}