Jump to

• Request
• Response

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 Top

Response

Supported Media Types

• application/vnd.oracle.resource+json;type=collection

Default Response

Default Response.

Body ()

Root Schema : schema

Type: object

Show Source

• items(required): array items
• links: array links

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/workInvoices.activities"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object workInvoices.activities

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/workInvoices.activities"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    }
}

Nested Schema : workInvoices.activities

Type: object

Show Source

• 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.

{
    "properties":{
        "sequence":{
            "description":"The line number of the activity record.",
            "type":"number",
            "format":"int32"
        },
        "activityDate":{
            "description":"Date activity was performed.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "specialServiceGid":{
            "description":"Special Service GID for the activity performed.",
            "type":"string"
        },
        "sourceLocationGid":{
            "description":"Source location of the activity.",
            "type":"string"
        },
        "destLocationGid":{
            "description":"Destination location of the activity.",
            "type":"string"
        },
        "payableIndicatorGid":{
            "description":"Indicates the payable state of this activity (ex: Payable, Not Payable, Display as Zero, etc.).",
            "type":"string"
        },
        "distance":{
            "description":"Distance for the activity.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "duration":{
            "description":"Duration for the activity.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "weight":{
            "description":"Weight for the activity.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "volume":{
            "description":"Volume for the activity.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "shipUnitCount":{
            "description":"Count for the activity (such as number of ship units).",
            "type":"number",
            "format":"int64"
        },
        "itemPackageCount":{
            "description":"Package item count.",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "shipmentSpecialServiceSeq":{
            "description":"Shipment special service sequence",
            "type":"number",
            "format":"int64"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : activityDate

Date activity was performed.

Match All

Date activity was performed.

Show Source

• object dateType

{
    "description":"Date activity was performed.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : distance

Distance for the activity.

Match All

Distance for the activity.

Show Source

• object amountType

{
    "description":"Distance for the activity.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : duration

Duration for the activity.

Match All

Duration for the activity.

Show Source

• object amountType

{
    "description":"Duration for the activity.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : volume

Volume for the activity.

Match All

Volume for the activity.

Show Source

• object amountType

{
    "description":"Volume for the activity.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : weight

Weight for the activity.

Match All

Weight for the activity.

Show Source

• object amountType

{
    "description":"Weight for the activity.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : dateType

Type: object

Show Source

• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : amountType

Type: object

Show Source

• unit: string
  Unit of measure
• value: number
  Numeric value that specifies an amount

{
    "properties":{
        "value":{
            "description":"Numeric value that specifies an amount",
            "type":"number"
        },
        "unit":{
            "description":"Unit of measure",
            "type":"string"
        }
    }
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Back to Top