API

Production APIs

GET production/work-order-operations/work-log

List of all work hour periods registered in provided work order operation

HTTP method GET
URI https://api.rambase.net/production/work-order-operations/work-log
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 4089, 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
$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.

AllowManHours Boolean True if man hours can be added to the work log of work order operations.
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()
IsManHour Boolean True if work period is man hour (and not machine).
ManHourType String Type of man hours. Blank implies that the work period was done by machine.
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.
UpdatedAt Datetime Date and time of update. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
UserId Integer User identifier.
WorkOrderOperationId Integer Production work order operation identifier.
WorkPeriodId Integer Work period identifier.

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

AllowManHours Boolean True if man hours can be added to the work log of work order operations
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
IsManHour Boolean True if work period is man hour (and not machine)
ManHourType String Type of man hours. Blank implies that the work period was done by machine.
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
UpdatedAt Datetime Date and time of update
UserId Integer User identifier
WorkOrderOperationId Integer Production work order operation 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.

Format:
1
<WorkLogs>
2
     <WorkLog>
3
          <WorkPeriod>
4
               <CreatedAt
CreatedAt

Date and time of creation

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

Work period identifier

>{Integer}</WorkPeriodId>
6
               <Comment
Comment

Comment of the work hour period. Why the work hour period is edited / changed.

>{String}</Comment>
7
               <StartedAt
StartedAt

Date and time the work period started

>{Datetime}</StartedAt>
8
               <EndedAt
EndedAt

Date and time the work period ended

>{Datetime}</EndedAt>
9
               <TotalHours
TotalHours

Total hours of work in this work period

>{Decimal}</TotalHours>
10
               <Step
Step

Step this work period was in.

Possible domain values can be found here

>{String}</Step>
11
               <ManHourType
ManHourType

Type of man hours. Blank implies that the work period was done by machine.

Possible domain values can be found here

>{String}</ManHourType>
12
               <User>
13
                    <UserId
UserId

User identifier

>{Integer}</UserId>
14
                    <Name
Name

Name of the user

>{String}</Name>
15
                    <FirstName
FirstName

First name of the user

>{String}</FirstName>
16
                    <UserLink
UserLink

User reference

>{String}</UserLink>
17
               </User>
18
               <WorkOrderOperation>
19
                    <WorkOrderOperationId
WorkOrderOperationId

Production work order operation identifier

>{Integer}</WorkOrderOperationId>
20
                    <ProductionWorkOrder
ProductionWorkOrder

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

>
21
                         <ProductionWorkOrderId
ProductionWorkOrderId

Production work order identifier

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

>{Integer}</ProductionWorkOrderId>
22
                         <ProductionWorkOrderLink
ProductionWorkOrderLink

Production work order reference

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

>{String}</ProductionWorkOrderLink>
23
                    </ProductionWorkOrder>
24
                    <ProductStructureOperation>
25
                         <ProductionOperation
ProductionOperation

This field is greyed out because it is an expandable field. You have to add $expand=WorkLog.WorkPeriod.WorkOrderOperation.ProductStructureOperation.ProductionOperation in your request URI to get this field

>
26
                              <ProductionOperationId
ProductionOperationId

Production operation identifier

This field is greyed out because it is an expandable field. You have to add $expand=WorkLog.WorkPeriod.WorkOrderOperation.ProductStructureOperation.ProductionOperation in your request URI to get this field

>{Integer}</ProductionOperationId>
27
                              <Name
Name

Name of production operation

This field is greyed out because it is an expandable field. You have to add $expand=WorkLog.WorkPeriod.WorkOrderOperation.ProductStructureOperation.ProductionOperation in your request URI to get this field

>{String}</Name>
28
                              <ProductionOperationLink
ProductionOperationLink

Production operation reference

This field is greyed out because it is an expandable field. You have to add $expand=WorkLog.WorkPeriod.WorkOrderOperation.ProductStructureOperation.ProductionOperation in your request URI to get this field

>{String}</ProductionOperationLink>
29
                         </ProductionOperation>
30
                    </ProductStructureOperation>
31
                    <WorkOrderOperationLink
WorkOrderOperationLink

Work order operation reference

>{String}</WorkOrderOperationLink>
32
               </WorkOrderOperation>
33
               <WorkPeriodLink
WorkPeriodLink

Work period reference

>{String}</WorkPeriodLink>
34
          </WorkPeriod>
35
     </WorkLog>
36
     <Paging
Paging

Detailed paging information for this list.

>
37
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
40
          <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>
41
          <FirstPage
FirstPage

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

>{String}</FirstPage>
42
          <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>
43
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
44
          <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>
45
          <NextPage
NextPage

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

>{String}</NextPage>
46
          <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>
47
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
49
     </Paging>
50
</WorkLogs>
1
{
2
     "workLogs": [
3
          {
4
               "workPeriod": {
5
                    "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
6
                    "workPeriodId
WorkPeriodId

Work period identifier

": "{Integer}",
7
                    "comment
Comment

Comment of the work hour period. Why the work hour period is edited / changed.

": "{String}",
8
                    "startedAt
StartedAt

Date and time the work period started

": "{Datetime}",
9
                    "endedAt
EndedAt

Date and time the work period ended

": "{Datetime}",
10
                    "totalHours
TotalHours

Total hours of work in this work period

": "{Decimal}",
11
                    "step
Step

Step this work period was in.

Possible domain values can be found here

": "{String}",
12
                    "manHourType
ManHourType

Type of man hours. Blank implies that the work period was done by machine.

Possible domain values can be found here

": "{String}",
13
                    "user": {
14
                         "userId
UserId

User identifier

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

Name of the user

": "{String}",
16
                         "firstName
FirstName

First name of the user

": "{String}",
17
                         "userLink
UserLink

User reference

": "{String}"
18
                    },
19
                    "workOrderOperation": {
20
                         "workOrderOperationId
WorkOrderOperationId

Production work order operation identifier

": "{Integer}",
21
                         "productionWorkOrder
ProductionWorkOrder

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

": {
22
                              "productionWorkOrderId
ProductionWorkOrderId

Production work order identifier

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

": "{Integer}",
23
                              "productionWorkOrderLink
ProductionWorkOrderLink

Production work order reference

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

": "{String}"
24
                         },
25
                         "productStructureOperation": {
26
                              "productionOperation
ProductionOperation

This field is greyed out because it is an expandable field. You have to add $expand=WorkLog.WorkPeriod.WorkOrderOperation.ProductStructureOperation.ProductionOperation in your request URI to get this field

": {
27
                                   "productionOperationId
ProductionOperationId

Production operation identifier

This field is greyed out because it is an expandable field. You have to add $expand=WorkLog.WorkPeriod.WorkOrderOperation.ProductStructureOperation.ProductionOperation in your request URI to get this field

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

Name of production operation

This field is greyed out because it is an expandable field. You have to add $expand=WorkLog.WorkPeriod.WorkOrderOperation.ProductStructureOperation.ProductionOperation in your request URI to get this field

": "{String}",
29
                                   "productionOperationLink
ProductionOperationLink

Production operation reference

This field is greyed out because it is an expandable field. You have to add $expand=WorkLog.WorkPeriod.WorkOrderOperation.ProductStructureOperation.ProductionOperation in your request URI to get this field

": "{String}"
30
                              }
31
                         },
32
                         "workOrderOperationLink
WorkOrderOperationLink

Work order operation reference

": "{String}"
33
                    },
34
                    "workPeriodLink
WorkPeriodLink

Work period reference

": "{String}"
35
               }
36
          }
37
     ],
38
     "paging
Paging

Detailed paging information for this list.

": {
39
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

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

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

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

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

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

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

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

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

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

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

": "{Integer}"
51
     }
52
}

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.
Error 100207 HTTP 404 Production resource not found {0}