Production APIs
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.
Comment
Comment of the work hour period. Why the work hour period is edited / changed.
This field is optional.
>{String}</Comment>StartedAt
Required/mandatory field
Date and time the work period started
>{Datetime}</StartedAt>TotalHours
Required/mandatory field
Total hours of work in this work period
Minimum value: 0
>{Decimal}</TotalHours>Step
Required/mandatory field
Step this work period was in.
Applicable domain values can be found here
>{String}</Step>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>User
This field is optional.
>UserId
User identifier
Minimum value: 100
This field is optional.
>{Integer}</UserId>Comment
Comment of the work hour period. Why the work hour period is edited / changed.
This field is optional.
": "{String}",StartedAt
Required/mandatory field
Date and time the work period started
": "{Datetime}",TotalHours
Required/mandatory field
Total hours of work in this work period
Minimum value: 0
": "{Decimal}",Step
Required/mandatory field
Step this work period was in.
Applicable domain values can be found here
": "{String}",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}",User
This field is optional.
": {UserId
User identifier
Minimum value: 100
This field is optional.
": "{Integer}"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.
WorkPeriodId
Work period identifier
>{Integer}</WorkPeriodId>Comment
Comment of the work hour period. Why the work hour period is edited / changed.
>{String}</Comment>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>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>UpdatedAt
Date and time of last worklog update
>{Datetime}</UpdatedAt>Type
A type of work order operation's worklog
Possible domain values can be found here
>{String}</Type>IsSplitSource
A flag to indicate if work log element has been splitted
>{Boolean}</IsSplitSource>WorkPeriodId
Identifier of work period which is a source of that worklog element
>{Integer}</WorkPeriodId>WorkOrderOperationId
Identifier of the work order operation which is a source of that worklog element
>{Integer}</WorkOrderOperationId>WorkOrderOperationLink
Identifier of the work order operation which is a source of that worklog element
>{String}</WorkOrderOperationLink>WorkPeriodLink
Work period reference
>{String}</WorkPeriodLink>IsCorrectionSource
A flag to indicate if work log element has been corrected
>{Boolean}</IsCorrectionSource>WorkPeriodId
Identifier of corrected work log element
>{Integer}</WorkPeriodId>WorkPeriodLink
Work period reference
>{String}</WorkPeriodLink>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>WorkPeriodId
Work period identifier
": "{Integer}",Comment
Comment of the work hour period. Why the work hour period is edited / changed.
": "{String}",CreatedAt
Date and time of creation
": "{Datetime}",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}",UpdatedAt
Date and time of last worklog update
": "{Datetime}",Type
A type of work order operation's worklog
Possible domain values can be found here
": "{String}",IsSplitSource
A flag to indicate if work log element has been splitted
": "{Boolean}",WorkPeriodId
Identifier of work period which is a source of that worklog element
": "{Integer}",WorkOrderOperationId
Identifier of the work order operation which is a source of that worklog element
": "{Integer}",WorkOrderOperationLink
Identifier of the work order operation which is a source of that worklog element
": "{String}"WorkPeriodLink
Work period reference
": "{String}"IsCorrectionSource
A flag to indicate if work log element has been corrected
": "{Boolean}",WorkPeriodId
Identifier of corrected work log element
": "{Integer}",WorkPeriodLink
Work period reference
": "{String}"UserId
User identifier
": "{Integer}",Name
Name of the user
": "{String}",FirstName
First name of the user
": "{String}",UserLink
User reference
": "{String}"
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 102049 HTTP 400 | Effective date must be higher than, or equal to, current date. |
| Error 103491 HTTP 400 | Invalid expiration date |
| Error 102038 HTTP 400 | The expiration date must be higher than, or equal to, the effective date. |
| Error 103479 HTTP 400 | Expiration date is in conflict with existing effective date of another item |
| Error 108844 HTTP 400 | Manufacturer part number is not active on the product |
| Error 102115 HTTP 400 | All purchase price conversion fields must be blanked, or all must be filled in |
| Error 100167 HTTP 404 | Measurement unit not found |
| Error 102116 HTTP 400 | Selected measurement unit is not activated in your system |
| Error 102112 HTTP 400 | Purchase price can not be set when using price convesrsion by measurement units |
| Error 103478 HTTP 400 | Purchase price is required |
| Error 102109 HTTP 400 | Supplier is required |
| Error 100047 HTTP 404 | Supplier not found |
| Error 101097 HTTP 404 | Given currency {0} mismatch with currencies of supplier {1} |