Get Calendars
get
/locations/{locationGid}/roleProfiles/{locationRoleGid}/calendars
Request
Path Parameters
-
locationGid(required): string
Resource ID
-
locationRoleGid(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 : locations.roleProfiles.calendars
Type:
Show Source
object
-
calendarGid: string
The GID for the calendar entry associated with each row of the location role profile calendar entry.
-
domainName: string
Database domain where this data is stored.
-
flexCommodityProfileGid: string
The GID for the flex commodity profile. Used to specify when commodity specific activities can occur at the location.
-
inboundLocationProfileGid: string
The GID for the inbound location profile. Used to specify when shipments from locations in the inbound location profile can be received at the location.
-
links: array
links
Read Only:
true
-
locationRoleProfCalSeq: number
(int32)
The internal sequence number for the location role profile calendar combination.
-
modeProfileGid: string
The GID for the mode profile. Used to specify when shipments of a certain mode can be shipped or received from the location.
-
outboundLocationProfileGid: string
The GID for the outbound location profile. Used to specify when shipments to locations in the outbound location profile can be shipped to.