API

Production APIs

POST production/work-order-operations/{workOrderOperationId}/work-log

Create work hour period for provided work order operation

HTTP method POST
URI https://api.rambase.net/production/work-order-operations/{workOrderOperationId}/work-log
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {workOrderOperationId} Production work order operation identifier
Integer, minimum 100000
Successful HTTP status code 201
API resource identifier 4190, version 3

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

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

This field is optional.

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

Required/mandatory field

Date and time the work period started

>
{Datetime}</StartedAt>
4
     <TotalHours
TotalHours

Required/mandatory field

Total hours of work in this work period

Minimum value: 0

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

Required/mandatory field

Step this work period was in.

Applicable domain values can be found here

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

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

Applicable domain values can be found here

This field is optional.

>
{String}</ManHourType>
7
     <User
User

This field is optional.

>
8
          <UserId
UserId

User identifier

Minimum value: 100

This field is optional.

>
{Integer}</UserId>
9
     </User>
10
</WorkPeriod>
1
{
2
     "workPeriod": {
3
          "comment
Comment

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

This field is optional.

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

Required/mandatory field

Date and time the work period started

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

Required/mandatory field

Total hours of work in this work period

Minimum value: 0

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

Required/mandatory field

Step this work period was in.

Applicable domain values can be found here

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

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

Applicable domain values can be found here

This field is optional.

":
"{String}",
8
          "user
User

This field is optional.

":
{
9
               "userId
UserId

User identifier

Minimum value: 100

This field is optional.

":
"{Integer}"
10
          }
11
     }
12
}

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.

$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
$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.
$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]

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.

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
          <IsSplitSource
IsSplitSource

A flag to indicate if work log element has been splitted

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

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

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

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

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

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

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

Work period reference

>
{String}</WorkPeriodLink>
21
          </SplittedFrom>
22
     </Split>
23
     <Correction>
24
          <IsCorrectionSource
IsCorrectionSource

A flag to indicate if work log element has been corrected

>
{Boolean}</IsCorrectionSource>
25
          <CorrectionOf>
26
               <WorkPeriodId
WorkPeriodId

Identifier of corrected work log element

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

Work period reference

>
{String}</WorkPeriodLink>
28
          </CorrectionOf>
29
     </Correction>
30
     <User>
31
          <UserId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

>
{String}</UserLink>
35
     </User>
36
</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
               "isSplitSource
IsSplitSource

A flag to indicate if work log element has been splitted

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

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

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

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

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

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

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

Work period reference

":
"{String}"
22
               }
23
          },
24
          "correction": {
25
               "isCorrectionSource
IsCorrectionSource

A flag to indicate if work log element has been corrected

":
"{Boolean}",
26
               "correctionOf": {
27
                    "workPeriodId
WorkPeriodId

Identifier of corrected work log element

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

Work period reference

":
"{String}"
29
               }
30
          },
31
          "user": {
32
               "userId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

":
"{String}"
36
          }
37
     }
38
}

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 100089 HTTP 404 Product {0} not found
Error 102070 HTTP 404 Purchase price not found
Error 102190 HTTP 404 Missing mandatory parameter for pick operation id
Error 105808 HTTP 400 Status of picking list line is not valid
Error 103546 HTTP 400 Only product structures can be blocked for production
Error 107762 HTTP 400 Only product structures can auto create work orders for sub production
Error 107763 HTTP 400 Only product structures can be set up for line production
Error 107764 HTTP 400 Only product structures can be externally manufactured
Error 109643 HTTP 400 Safetystock cannot be greater than maximumstock
Error 100984 HTTP 400 Illegal update. The General ledger posting has ST>4
Error 100985 HTTP 400 Illegal update. The General ledger posting has AGIO-calculation