REST API for Oracle Fusion Field Service Cloud Service

Get shifts

get

/rest/ofscMetadata/v1/shifts

This operation retrieves a collection of shifts along with all the information about each shift.

Request

Query Parameters

limit: integer

The number of shift records to be returned in the response. The minimum value that can be specified is 1 and the maximum value that can be specified is 100. If the specified value is zero, greater than 100, or if no value is specified, then it defaults to 100.
offset: integer

The record number from which the retrieval starts. The default value is zero. If no value is specified, then it defaults to zero. The value zero indicates that the retrieval will start from the beginning of the collection.

Response

Supported Media Types

application/schema+json
application/json

200 Response

This section describes the 200 status response for this operation.

Root Schema : Shifts

Type: object

The collection of shifts. It is not returned for an empty collection.

Show Source

hasMore: boolean

Contains one of the following values: true or false.
If true, then there are more results that can be retrieved with successive paging requests.
If false or if the value is not present, then there are no more results or this is the final page. The default value is true.
items: array items
limit: integer

The limit value specified in the request. If the value is not specified in the request or if the specified value is not accepted, then it defaults to 100.
offset: integer

The offset value specified in the request.
totalResults: integer

The total number of shift records in the collection.

{
    "description":"The collection of shifts. It is not returned for an empty collection.",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Shift"
            }
        },
        "totalResults":{
            "type":"integer",
            "description":"The total number of shift records in the collection. "
        },
        "hasMore":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false.<p>If true, then there are more results that can be retrieved with successive paging requests.</p><p>If false or if the value is not present, then there are no more results or this is the final page. The default value is true.</p>"
        },
        "offset":{
            "type":"integer",
            "description":"The offset value specified in the request."
        },
        "limit":{
            "type":"integer",
            "description":"The limit value specified in the request. If the value is not specified in the request or if the specified value is not accepted, then it defaults to 100."
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: object Shift

Title: Shift

The shift object.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Shift"
    }
}

Nested Schema : Shift

Type: object

Title: Shift

The shift object.

Show Source

active(required): boolean

Title: Active

Contains one of the following values: true or false.
If true, then the shift is listed as a possible value in the 'shift' drop-down list in Manage or Mobility apps while creating an activity. If false, then the shift is not listed as a value in the drop-down list. The default value is true.
decoration: string

Title: Type

The decoration of the shift. Mandatory for "on-call" type of shift. Possible values are ["yellow","orange","red","blue","green","purple"].
name(required): string

Title: Name

The label of the shift.
points: integer

Title: Points

Points
type(required): string

Title: Type

The type of the shift. Possible values are ["regular", "on-call"]. Cannot be changed for an existing shift.
workTimeEnd(required): string

Title: WorkTimeStart

The workTimeEnd of the shift. Possible values are 00:00 - 23:59
workTimeStart(required): string

Title: WorkTimeStart

The workTimeStart of the shift. Possible values are 00:00 - 23:59

{
    "type":"object",
    "title":"Shift",
    "description":"The shift object.",
    "properties":{
        "active":{
            "type":"boolean",
            "title":"Active",
            "description":"Contains one of the following values: true or false.<p>If true, then the shift is listed as a possible value in the 'shift' drop-down list in Manage or Mobility apps while creating an activity. If false, then the shift is not listed as a value in the drop-down list. The default value is true."
        },
        "name":{
            "type":"string",
            "title":"Name",
            "description":"The label of the shift."
        },
        "points":{
            "type":"integer",
            "title":"Points",
            "description":"Points"
        },
        "type":{
            "type":"string",
            "title":"Type",
            "description":"The type of the shift. Possible values are [\"regular\", \"on-call\"]. Cannot be changed for an existing shift."
        },
        "workTimeStart":{
            "type":"string",
            "title":"WorkTimeStart",
            "description":"The workTimeStart of the shift. Possible values are 00:00 - 23:59"
        },
        "workTimeEnd":{
            "type":"string",
            "title":"WorkTimeStart",
            "description":"The workTimeEnd of the shift. Possible values are 00:00 - 23:59"
        },
        "decoration":{
            "type":"string",
            "title":"Type",
            "description":"The decoration of the shift. Mandatory for \"on-call\" type of shift. Possible values are [\"yellow\",\"orange\",\"red\",\"blue\",\"green\",\"purple\"]. "
        }
    },
    "required":[
        "name",
        "active",
        "type",
        "workTimeEnd",
        "workTimeStart"
    ]
}

Default Response

This section describes the default error response for this operation.

Root Schema : Error

Type: object

Show Source

detail: string

The detailed description of this error.
status: string

The HTTP status code of this error.
title(required): string

The brief description of this error.
type(required): string

The URL of the web page containing more details about this error.

{
    "properties":{
        "type":{
            "type":"string",
            "description":"The URL of the web page containing more details about this error."
        },
        "title":{
            "type":"string",
            "description":"The brief description of this error."
        },
        "status":{
            "type":"string",
            "description":"The HTTP status code of this error."
        },
        "detail":{
            "type":"string",
            "description":"The detailed description of this error."
        }
    },
    "required":[
        "type",
        "title"
    ]
}

Examples

The following example shows how to get all shifts by submitting a GET request on the REST resource using cURL.

Use the cURL command with the following syntax:

curl -u '<CLIENT-ID>@<INSTANCE-NAME>:<CLIENT-SECRET>' \
     -H 'Accept: application/json' \
     'https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/shifts'

Response Body Example

The following shows an example of the response body in JSON format:

{
    "hasMore": true,
    "totalResults": 294,
    "limit": 100,
    "offset": 0,
    "items": [
        {
            "label": "forActionsLinkMethods",
            "name": "ForAutoTest",
            "active": true,
            "type": "regular",
            "workTimeStart": "09:00:00",
            "workTimeEnd": "18:00:00",
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/shifts/forActionsLinkMethods"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/shifts"
                }
            ]
        },
        {
            "label": "AutoTestGroupActionDeleteOk",
            "name": "AutoTestGroupActionDeleteOk",
            "active": true,
            "type": "regular",
            "workTimeStart": "09:00:00",
            "workTimeEnd": "18:00:00",
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/shifts/AutoTestGroupActionDeleteOk"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/shifts"
                }
            ]
        },
        {
            "label": "AutoTestGroupActionDeleteCancel",
            "name": "AutoTestGroupActionDeleteCancel",
            "active": true,
            "type": "regular",
            "workTimeStart": "09:00:00",
            "workTimeEnd": "18:00:00",
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/shifts/AutoTestGroupActionDeleteCancel"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/shifts"
                }
            ]
        },
        {
            "label": "AutoTestActionActivities",
            "name": "AutoTestActionActivities",
            "active": true,
            "type": "regular",
            "workTimeStart": "09:00:00",
            "workTimeEnd": "18:00:00",
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/shifts/AutoTestActionActivities"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/shifts"
                }
            ]
        },
       
        {
            "label": "shift7608000006",
            "name": "shift7608000006",
            "active": true,
            "type": "on-call",
            "decoration": "red",
            "workTimeStart": "00:00:00",
            "workTimeEnd": "23:59:00",
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/shifts/shift7608000006"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/shifts"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "canonical",
            "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/shifts?limit=100&offset=0"
        },
        {
            "rel": "next",
            "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/shifts?limit=100&offset=100"
        },
        {
            "rel": "describedby",
            "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/shifts"
        }
    ]
}