Production APIs
List of worklogs related to this production work order
| HTTP method | GET |
| URI | https://api.rambase.net/production/work-orders/{productionWorkOrderId}/work-log |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {productionWorkOrderId} |
Production work order identifier
Integer, minimum 100000 |
| Maximum page size ($top) | 80 |
| Successful HTTP status code | 200 |
| API resource identifier | 4618, version 5 |
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.
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.
| Cleanup() Named filter | List of cleanup step worklogs |
| Machine() Named filter | List of machine type worklogs |
| Manhours() Named filter | List of manhour type worklogs |
| MyWorklogs() Named filter | List of current user's worklogs |
| Processing() Named filter | List of processing step worklogs |
| Setup() Named filter | List of setup step worklogs |
| Today() Named filter | List of all worklogs started today |
| Comment String | Comment of the work hour period. Why the work hour period is edited / changed. |
| CreatedAt Datetime | Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| EndedAt Datetime | Date and time the work period ended. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| ManHourType String | Type of man hours. Blank implies that the work period was done by machine. |
| ProductionOperationName String | Name of production operation. |
| SequenceNumber Integer | Sequence number of the product structure operation. Unique within a product structure. |
| StartedAt Datetime | Date and time the work period started. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| Step String | Step this work period was in. |
| TotalHours Decimal | Total hours of work in this work period. |
| UserId Integer | User identifier. |
| WorkPeriodId Integer | Work period identifier. |
Read more about filters and sorting on how to use sortable parameters
| Comment String | Comment of the work hour period. Why the work hour period is edited / changed. |
| CreatedAt Datetime | Date and time of creation |
| EndedAt Datetime | Date and time the work period ended |
| ManHourType String | Type of man hours. Blank implies that the work period was done by machine. |
| ProductionOperationName String | Name of production operation |
| SequenceNumber Integer | Sequence number of the product structure operation. Unique within a product structure. |
| StartedAt Datetime | Date and time the work period started |
| Step String | Step this work period was in. |
| TotalHours Decimal | Total hours of work in this work period |
| UserId Integer | User identifier |
| WorkPeriodId Integer | Work period identifier |
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.
WorkOrderOperationId
Production work order operation identifier
>{Integer}</WorkOrderOperationId>Status
Production work order operation status
Possible domain values can be found here
>{Integer}</Status>StartedAt
Date and time work order operation actually started
>{Datetime}</StartedAt>FinishedAt
Date and time of completion
>{Datetime}</FinishedAt>ProductStructureOperationId
Product structure operation identifier
>{Integer}</ProductStructureOperationId>SequenceNumber
Sequence number of the product structure operation. Unique within a product structure.
>{Integer}</SequenceNumber>ProductionOperationId
Production operation identifier
>{Integer}</ProductionOperationId>Name
Name of production operation
>{String}</Name>ProductionOperationLink
Production operation reference
>{String}</ProductionOperationLink>WorkOrderOperationLink
Work order operation reference
>{String}</WorkOrderOperationLink>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>WorkPeriodId
Work period identifier
>{Integer}</WorkPeriodId>Comment
Comment of the work hour period. Why the work hour period is edited / changed.
>{String}</Comment>StartedAt
Date and time the work period started
>{Datetime}</StartedAt>EndedAt
Date and time the work period ended
>{Datetime}</EndedAt>TotalHours
Total hours of work in this work period
>{Decimal}</TotalHours>ManHourType
Type of man hours. Blank implies that the work period was done by machine.
Possible domain values can be found here
>{String}</ManHourType>Type
A type of work order operation's worklog
Possible domain values can be found here
>{String}</Type>UserId
User identifier
>{Integer}</UserId>Name
Name of the user
>{String}</Name>FirstName
First name of the user
>{String}</FirstName>UserLink
User reference
>{String}</UserLink>WorkPeriodLink
Work period reference
>{String}</WorkPeriodLink>Paging
Detailed paging information for this list.
>PageSize
Number of elements in the list, as defined in $top. Default is 10.
>{Integer}</PageSize>Position
Position of the first element in the list
>{Integer}</Position>Page
Page index
>{Integer}</Page>FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
>{String}</FirstPage>PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
>{String}</PreviousPage>NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
>{String}</NextPage>LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
>{String}</LastPage>Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
>{Integer}</Size>WorkOrderOperationId
Production work order operation identifier
": "{Integer}",Status
Production work order operation status
Possible domain values can be found here
": "{Integer}",StartedAt
Date and time work order operation actually started
": "{Datetime}",FinishedAt
Date and time of completion
": "{Datetime}",ProductStructureOperationId
Product structure operation identifier
": "{Integer}",SequenceNumber
Sequence number of the product structure operation. Unique within a product structure.
": "{Integer}",ProductionOperationId
Production operation identifier
": "{Integer}",Name
Name of production operation
": "{String}",ProductionOperationLink
Production operation reference
": "{String}"WorkOrderOperationLink
Work order operation reference
": "{String}"CreatedAt
Date and time of creation
": "{Datetime}",WorkPeriodId
Work period identifier
": "{Integer}",Comment
Comment of the work hour period. Why the work hour period is edited / changed.
": "{String}",StartedAt
Date and time the work period started
": "{Datetime}",EndedAt
Date and time the work period ended
": "{Datetime}",TotalHours
Total hours of work in this work period
": "{Decimal}",Step
Step this work period was in.
Possible domain values can be found here
": "{String}",ManHourType
Type of man hours. Blank implies that the work period was done by machine.
Possible domain values can be found here
": "{String}",Type
A type of work order operation's worklog
Possible domain values can be found here
": "{String}",UserId
User identifier
": "{Integer}",Name
Name of the user
": "{String}",FirstName
First name of the user
": "{String}",UserLink
User reference
": "{String}"WorkPeriodLink
Work period reference
": "{String}"Paging
Detailed paging information for this list.
": {PageSize
Number of elements in the list, as defined in $top. Default is 10.
": "{Integer}",Position
Position of the first element in the list
": "{Integer}",Page
Page index
": "{Integer}",FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
": "{String}",PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
": "{String}",NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
": "{String}",LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
": "{String}",Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
": "{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:
| Error 101814 HTTP 404 | Employee not found |