Get Activities
get
/workInvoices/{workInvoiceGid}/activities
Request
Path Parameters
-
workInvoiceGid(required): string
Resource ID
Query Parameters
-
expand: string
Comma-delimited string of child resource names that you want to expand so that the contents return with the parent in the same GET request.
-
fields: string
Comma-delimited string of field names that you wanted returned in a GET request.
-
limit: integer(int32)
Positive integer value that specifies the maximum number of items returned by the server.
-
offset: integer(int32)
Non-negative integer values that specifies the index of the first item to be returned. The offset index begins at 0. By default, the offset is 0, which returns all items starting from the first item in the collection.
-
orderBy: string
Comma-separated string of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.
-
q: string
Filter (a 'where'clause) to restrict the items returned in the collection. By default, no filtering is applied.
-
totalResults: boolean
Boolean value that specifies whether to calculate the totalResults property. By default, this value is set to false indicating that totalResults is not calculated.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/vnd.oracle.resource+json;type=collection
Default Response
Default Response.
Nested Schema : workInvoices.activities
Type:
Show Source
object
-
activityDate:
activityDate
Date activity was performed.
-
destLocationGid: string
Destination location of the activity.
-
distance:
distance
Distance for the activity.
-
domainName: string
Database domain where this data is stored.
-
duration:
duration
Duration for the activity.
-
itemPackageCount: number
(int64)
Package item count.
-
links: array
links
Read Only:
true
-
payableIndicatorGid: string
Indicates the payable state of this activity (ex: Payable, Not Payable, Display as Zero, etc.).
-
sequence: number
(int32)
The line number of the activity record.
-
shipmentSpecialServiceSeq: number
(int64)
Shipment special service sequence
-
shipUnitCount: number
(int64)
Count for the activity (such as number of ship units).
-
sourceLocationGid: string
Source location of the activity.
-
specialServiceGid: string
Special Service GID for the activity performed.
-
volume:
volume
Volume for the activity.
-
weight:
weight
Weight for the activity.
Nested Schema : amountType
Type:
Show Source
object
-
unit: string
Unit of measure
-
value: number
Numeric value that specifies an amount