Sales APIs
Work log entriy details for the provided identifier
| HTTP method | GET |
| URI | https://api.rambase.net/sales/project-orders/{projectOrderId}/items/{itemId}/work-log/{workLogId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {projectOrderId} |
Project order identifier
Integer, minimum 100000 |
| - URI parameter {itemId} |
Project order item identifier
Integer, minimum 1 |
| - URI parameter {workLogId} |
Work log identifier
Integer, minimum 100000 |
| Successful HTTP status code | 200 |
| API resource identifier | 4249, version 11 |
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 |
| $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. |
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.
WorkLogId
Work log identifier
>{Integer}</WorkLogId>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>InternalNote
Internal note
>{String}</InternalNote>ExternalNote
External note
>{String}</ExternalNote>StartedAt
Start date and time of work log entry
>{Datetime}</StartedAt>EndedAt
End date and time of work log entry
>{Datetime}</EndedAt>TotalHours
Total hours of work log entry
>{Decimal}</TotalHours>BillableHours
Billable hours of work log entry
>{Decimal}</BillableHours>EmployeeId
Employee identifier
>{Integer}</EmployeeId>LastName
Last name of employee
>{String}</LastName>FirstName
First name of employee
>{String}</FirstName>EmployeeLink
Employee reference
>{String}</EmployeeLink>ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>ProductLink
Product reference
>{String}</ProductLink>Price
Cost pr hour in local currency
>{Decimal}</Price>Total
Total cost in local currency
>{Decimal}</Total>ApprovedAt
The date and time the work log entry was approved to status 4 by manager
>{Datetime}</ApprovedAt>ApprovedBy
The id of the manager who approved the work log entry to status 4
>EmployeeId
Employee identifier
>{Integer}</EmployeeId>LastName
Last name of employee
>{String}</LastName>FirstName
First name of employee
>{String}</FirstName>EmployeeLink
Employee reference
>{String}</EmployeeLink>InitialWorkLog
Reference to the initial worklog entry if there are several versions
>WorkLogId
Work log identifier
>{Integer}</WorkLogId>ProjectOrderItemId
Project order item identifier
>{Integer}</ProjectOrderItemId>ProjectOrderId
Project order identifier
>{Integer}</ProjectOrderId>ProjectOrderLink
Project order reference
>{String}</ProjectOrderLink>ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>ProductLink
Product reference
>{String}</ProductLink>ProjectOrderItemLink
Project order item reference
>{String}</ProjectOrderItemLink>WorkLogId
Work log identifier
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",Status
Status of work log
Possible domain values can be found here
": "{Integer}",InternalNote
Internal note
": "{String}",ExternalNote
External note
": "{String}",StartedAt
Start date and time of work log entry
": "{Datetime}",EndedAt
End date and time of work log entry
": "{Datetime}",TotalHours
Total hours of work log entry
": "{Decimal}",BillableHours
Billable hours of work log entry
": "{Decimal}"EmployeeId
Employee identifier
": "{Integer}",LastName
Last name of employee
": "{String}",FirstName
First name of employee
": "{String}",EmployeeLink
Employee reference
": "{String}"ProductId
Product identifier
": "{Integer}",Name
Name of the product
": "{String}",ProductLink
Product reference
": "{String}"Price
Cost pr hour in local currency
": "{Decimal}",Total
Total cost in local currency
": "{Decimal}"ApprovedAt
The date and time the work log entry was approved to status 4 by manager
": "{Datetime}",ApprovedBy
The id of the manager who approved the work log entry to status 4
": {EmployeeId
Employee identifier
": "{Integer}",LastName
Last name of employee
": "{String}",FirstName
First name of employee
": "{String}",EmployeeLink
Employee reference
": "{String}"InitialWorkLog
Reference to the initial worklog entry if there are several versions
": {WorkLogId
Work log identifier
": "{Integer}"ProjectOrderItemId
Project order item identifier
": "{Integer}",ProjectOrderId
Project order identifier
": "{Integer}",ProjectOrderLink
Project order reference
": "{String}"ProductId
Product identifier
": "{Integer}",Name
Name of the product
": "{String}",ProductLink
Product reference
": "{String}"ProjectOrderItemLink
Project order item 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 99946 HTTP 400 | {0}: Missing mandatory arguments {1} |
| Error 100089 HTTP 404 | Product {0} not found |