API

Production APIs

GET production/work-order-operations/{workOrderOperationId}/work-log/{workPeriodId}

Details of provided work hour period

HTTP method GET
URI https://api.rambase.net/production/work-order-operations/{workOrderOperationId}/work-log/{workPeriodId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {workOrderOperationId} Production work order operation identifier
Integer, minimum 100000
- URI parameter {workPeriodId} Work period identifier
Integer, minimum 1
Successful HTTP status code 200
API resource identifier 2860, version 10

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
<WorkPeriod>
2
     <WorkPeriodId
WorkPeriodId

Work period identifier

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

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

>{String}</Comment>
4
     <CreatedAt
CreatedAt

Date and time of creation

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

Date and time the work period started

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

Date and time the work period ended

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

Total hours of work in this work period

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

Step this work period was in.

Possible domain values can be found here

>{String}</Step>
9
     <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>
10
     <UpdatedAt
UpdatedAt

Date and time of last worklog update

>{Datetime}</UpdatedAt>
11
     <Type
Type

A type of work order operation's worklog

Possible domain values can be found here

>{String}</Type>
12
     <Split>
13
          <TotalHoursSplitted
TotalHoursSplitted

A sum of all splitted from split source total hours

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

>{Decimal}</TotalHoursSplitted>
14
          <IsSplitSource
IsSplitSource

A flag to indicate if work log element has been splitted

>{Boolean}</IsSplitSource>
15
          <SplittedFrom>
16
               <WorkPeriodId
WorkPeriodId

Identifier of work period which is a source of that worklog element

>{Integer}</WorkPeriodId>
17
               <WorkOrderOperation>
18
                    <WorkOrderOperationId
WorkOrderOperationId

Identifier of the work order operation which is a source of that worklog element

>{Integer}</WorkOrderOperationId>
19
                    <WorkOrderOperationLink
WorkOrderOperationLink

Identifier of the work order operation which is a source of that worklog element

>{String}</WorkOrderOperationLink>
20
               </WorkOrderOperation>
21
               <WorkPeriodLink
WorkPeriodLink

Work period reference

>{String}</WorkPeriodLink>
22
          </SplittedFrom>
23
     </Split>
24
     <Correction>
25
          <TotalHoursCorrected
TotalHoursCorrected

A sum of all corrected hours from correction source

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

>{Decimal}</TotalHoursCorrected>
26
          <IsCorrectionSource
IsCorrectionSource

A flag to indicate if work log element has been corrected

>{Boolean}</IsCorrectionSource>
27
          <CorrectionOf>
28
               <WorkPeriodId
WorkPeriodId

Identifier of corrected work log element

>{Integer}</WorkPeriodId>
29
               <WorkPeriodLink
WorkPeriodLink

Work period reference

>{String}</WorkPeriodLink>
30
          </CorrectionOf>
31
     </Correction>
32
     <User>
33
          <UserId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

>{String}</UserLink>
37
     </User>
38
</WorkPeriod>
1
{
2
     "workPeriod": {
3
          "workPeriodId
WorkPeriodId

Work period identifier

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

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

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

Date and time of creation

": "{Datetime}",
6
          "startedAt
StartedAt

Date and time the work period started

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

Date and time the work period ended

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

Total hours of work in this work period

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

Step this work period was in.

Possible domain values can be found here

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

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

Possible domain values can be found here

": "{String}",
11
          "updatedAt
UpdatedAt

Date and time of last worklog update

": "{Datetime}",
12
          "type
Type

A type of work order operation's worklog

Possible domain values can be found here

": "{String}",
13
          "split": {
14
               "totalHoursSplitted
TotalHoursSplitted

A sum of all splitted from split source total hours

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

": "{Decimal}",
15
               "isSplitSource
IsSplitSource

A flag to indicate if work log element has been splitted

": "{Boolean}",
16
               "splittedFrom": {
17
                    "workPeriodId
WorkPeriodId

Identifier of work period which is a source of that worklog element

": "{Integer}",
18
                    "workOrderOperation": {
19
                         "workOrderOperationId
WorkOrderOperationId

Identifier of the work order operation which is a source of that worklog element

": "{Integer}",
20
                         "workOrderOperationLink
WorkOrderOperationLink

Identifier of the work order operation which is a source of that worklog element

": "{String}"
21
                    },
22
                    "workPeriodLink
WorkPeriodLink

Work period reference

": "{String}"
23
               }
24
          },
25
          "correction": {
26
               "totalHoursCorrected
TotalHoursCorrected

A sum of all corrected hours from correction source

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

": "{Decimal}",
27
               "isCorrectionSource
IsCorrectionSource

A flag to indicate if work log element has been corrected

": "{Boolean}",
28
               "correctionOf": {
29
                    "workPeriodId
WorkPeriodId

Identifier of corrected work log element

": "{Integer}",
30
                    "workPeriodLink
WorkPeriodLink

Work period reference

": "{String}"
31
               }
32
          },
33
          "user": {
34
               "userId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

": "{String}"
38
          }
39
     }
40
}

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 102270 HTTP 404 WorkOrderOperation {0} not found