API

RamBase REST APIs

GET production/resources

List of resources

HTTP method GET
URI https://api.rambase.net/production/resources
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 555, version 34

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"
$showCustomFields Boolean, optional Set to "true" to include custom fields. Default value is false.
$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 Active resources
New() Named filter New resources
NewAndActive() Named filter New and active production resources
AllowGrouping Boolean Allows resource to use work order operation grouping.
AllowMultipleOperators Boolean True if multiple operators can work with one work order operation.
Category String Type of relation to other production resources.
Condition Integer A number which indicates production resource state, 0=OK, 10=warning, 20=stopped.
CreatedAt Datetime Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
Description String Description of production resource.
Name String Name of production resource.
ProductionResourceGroupId Integer Production resource group identifier.
ProductionResourceId Integer Production resource identifier.
ShortName String Short name of production resource.
Status Integer Status of production resource.
Type String Defines the CLASS of the resource.

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

AllowGrouping Boolean Allows resource to use work order operation grouping
AllowMultipleOperators Boolean True if multiple operators can work with one work order operation.
Category String Type of relation to other production resources
Condition Integer A number which indicates production resource state, 0=OK, 10=warning, 20=stopped
CreatedAt Datetime Date and time of creation
Description String Description of production resource
Name String Name of production resource
ProductionResourceGroupId Integer Production resource group identifier
ProductionResourceId Integer Production resource identifier
ShortName String Short name of production resource
Status Integer Status of production resource
Type String Defines the CLASS of the resource.

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
<ProductionResources>
2
     <ProductionResource>
3
          <ProductionResourceId
ProductionResourceId

Production resource identifier

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

Status of production resource

Possible domain values can be found here

>{Integer}</Status>
5
          <Name
Name

Name of production resource

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

Short name of production resource

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

Description of production resource

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

Defines the CLASS of the resource.

Possible domain values can be found here

>{String}</Type>
9
          <AllowMultipleOperators
AllowMultipleOperators

True if multiple operators can work with one work order operation.

>{Boolean}</AllowMultipleOperators>
10
          <WorkOrderOperationGrouping>
11
               <AllowGrouping
AllowGrouping

Allows resource to use work order operation grouping

>{Boolean}</AllowGrouping>
12
               <DistributeHours
DistributeHours

If set to 1 the time logged on the operation is distributed on all woo's.

>{Boolean}</DistributeHours>
13
          </WorkOrderOperationGrouping>
14
          <ProductionResourceGroup>
15
               <ProductionResourceGroupId
ProductionResourceGroupId

Production resource group identifier

>{Integer}</ProductionResourceGroupId>
16
               <Name
Name

Name of production resource group

>{String}</Name>
17
               <ProductionResourceGroupLink
ProductionResourceGroupLink

Production resource group reference

>{String}</ProductionResourceGroupLink>
18
          </ProductionResourceGroup>
19
          <LastWorkOrderOperation
LastWorkOrderOperation

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

>
20
               <WorkOrderOperationId
WorkOrderOperationId

Production work order operation identifier

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

>{Integer}</WorkOrderOperationId>
21
               <StartedAt
StartedAt

Date and time work order operation actually started

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

>{Datetime}</StartedAt>
22
               <FinishedAt
FinishedAt

Date and time of completion

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

>{Datetime}</FinishedAt>
23
               <WorkOrderOperationLink
WorkOrderOperationLink

Work order operation reference

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

>{String}</WorkOrderOperationLink>
24
          </LastWorkOrderOperation>
25
          <Condition>
26
               <Code
Code

A number which indicates production resource state, 0=OK, 10=warning, 20=stopped

Possible domain values can be found here

>{Integer}</Code>
27
               <Note
Note

A description which explains a reason for setting production resource state

>{String}</Note>
28
          </Condition>
29
          <ProductionResourceLink
ProductionResourceLink

Production resource reference

>{String}</ProductionResourceLink>
30
     </ProductionResource>
31
     <Paging
Paging

Detailed paging information for this list.

>
32
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
35
          <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>
36
          <FirstPage
FirstPage

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

>{String}</FirstPage>
37
          <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>
38
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
39
          <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>
40
          <NextPage
NextPage

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

>{String}</NextPage>
41
          <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>
42
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
44
     </Paging>
45
</ProductionResources>
1
{
2
     "productionResources": [
3
          {
4
               "productionResourceId
ProductionResourceId

Production resource identifier

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

Status of production resource

Possible domain values can be found here

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

Name of production resource

": "{String}",
7
               "shortName
ShortName

Short name of production resource

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

Description of production resource

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

Defines the CLASS of the resource.

Possible domain values can be found here

": "{String}",
10
               "allowMultipleOperators
AllowMultipleOperators

True if multiple operators can work with one work order operation.

": "{Boolean}",
11
               "workOrderOperationGrouping": {
12
                    "allowGrouping
AllowGrouping

Allows resource to use work order operation grouping

": "{Boolean}",
13
                    "distributeHours
DistributeHours

If set to 1 the time logged on the operation is distributed on all woo's.

": "{Boolean}"
14
               },
15
               "productionResourceGroup": {
16
                    "productionResourceGroupId
ProductionResourceGroupId

Production resource group identifier

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

Name of production resource group

": "{String}",
18
                    "productionResourceGroupLink
ProductionResourceGroupLink

Production resource group reference

": "{String}"
19
               },
20
               "lastWorkOrderOperation
LastWorkOrderOperation

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

": {
21
                    "workOrderOperationId
WorkOrderOperationId

Production work order operation identifier

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

": "{Integer}",
22
                    "startedAt
StartedAt

Date and time work order operation actually started

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

": "{Datetime}",
23
                    "finishedAt
FinishedAt

Date and time of completion

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

": "{Datetime}",
24
                    "workOrderOperationLink
WorkOrderOperationLink

Work order operation reference

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

": "{String}"
25
               },
26
               "condition": {
27
                    "code
Code

A number which indicates production resource state, 0=OK, 10=warning, 20=stopped

Possible domain values can be found here

": "{Integer}",
28
                    "note
Note

A description which explains a reason for setting production resource state

": "{String}"
29
               },
30
               "productionResourceLink
ProductionResourceLink

Production resource reference

": "{String}"
31
          }
32
     ],
33
     "paging
Paging

Detailed paging information for this list.

": {
34
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

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

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

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

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

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

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

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

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

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

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

": "{Integer}"
46
     }
47
}

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:

Error 103366 HTTP 404 Production resource group not found.