Jump to

• Request
• Response

Get one calendar shift

get

/fscmRestApi/resources/11.13.18.05/calendarShifts/{calendarShiftsUniqID}

Request

Path Parameters

• calendarShiftsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- CalendarCode, ShiftNumber, ExceptionStartDate and Sequence ---for the Calendar Shifts resource and used to uniquely identify an instance of Calendar Shifts. The client should not generate the hash key value. Instead, the client should query on the Calendar Shifts collection resource with a filter on the primary key values in order to navigate to a specific instance of Calendar Shifts.
  
  For example: calendarShifts?q=CalendarCode=<value1>;ShiftNumber=<value2>;ExceptionStartDate=<value3>;Sequence=<value4>

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : calendarShifts-item-response

Type: object

Show Source

• Calendar: string
  Title: Calendar

  Read Only: true

  Maximum Length: 240

  Name of the workday calendar.
• CalendarCode: string
  Title: ID

  Read Only: true

  Maximum Length: 255

  Unique identifier for the calendar in the source system.
• EndTime: string
  Title: End Time

  Read Only: true

  Time that the shift ends. Shift times can't overlap. Enter time in seconds.
• ExceptionEndDate: string (date)
  Title: Shift Exception End Date

  Read Only: true

  Last date till which any exception in the calendar is valid. This date must be within the calendar start date and end date.
• ExceptionStartDate: string (date)
  Title: Shift Exception Start Date

  Read Only: true

  Start date from which the exception in the calendar is valid. This date must be within the calendar start date and end date.
• ExceptionType: integer
  Title: Exception Type Code

  Read Only: true

  Code for the exception type. Valid values are 1 - Available and 2 - Not Available.
• ExceptionTypeName: string
  Title: Exception Type

  Read Only: true

  Maximum Length: 4000

  Name of the exception type. For example, Available, or Not Available.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Sequence: integer (int64)
  Title: Sequence

  Read Only: true

  Sequence number of the date on a calendar.
• ShiftDaysOff: integer
  Title: Shift Days Off

  Read Only: true

  Number of consecutive nonworking days.
• ShiftDaysOn: integer
  Title: Shift Days On

  Read Only: true

  Number of consecutive working days.
• ShiftName: string
  Title: Shift Name

  Read Only: true

  Maximum Length: 80

  Name of the calendar shift.
• ShiftNumber: integer
  Title: Shift Number

  Read Only: true

  Number of the calendar shift.
• StartTime: string
  Title: Start Time

  Read Only: true

  Time from which the shift starts. Shift times can't overlap. Enter time in seconds.

{
    "type":"object",
    "properties":{
        "ExceptionType":{
            "title":"Exception Type Code",
            "type":"integer",
            "description":"Code for the exception type. Valid values are 1 - Available and 2 - Not Available.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShiftName":{
            "title":"Shift Name",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the calendar shift.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndTime":{
            "title":"End Time",
            "type":"string",
            "description":"Time that the shift ends. Shift times can't overlap. Enter time in seconds.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Calendar":{
            "title":"Calendar",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the workday calendar.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartTime":{
            "title":"Start Time",
            "type":"string",
            "description":"Time from which the shift starts. Shift times can't overlap. Enter time in seconds.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExceptionStartDate":{
            "title":"Shift Exception Start Date",
            "type":"string",
            "description":"Start date from which the exception in the calendar is valid. This date must be within the calendar start date and end date.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShiftDaysOn":{
            "title":"Shift Days On",
            "type":"integer",
            "description":"Number of consecutive working days.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Sequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"Sequence number of the date on a calendar.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ShiftDaysOff":{
            "title":"Shift Days Off",
            "type":"integer",
            "description":"Number of consecutive nonworking days.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExceptionEndDate":{
            "title":"Shift Exception End Date",
            "type":"string",
            "description":"Last date till which any exception in the calendar is valid. This date must be within the calendar start date and end date.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CalendarCode":{
            "title":"ID",
            "maxLength":"255",
            "type":"string",
            "description":"Unique identifier for the calendar in the source system.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ShiftNumber":{
            "title":"Shift Number",
            "type":"integer",
            "description":"Number of the calendar shift.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExceptionTypeName":{
            "title":"Exception Type",
            "maxLength":"4000",
            "type":"string",
            "description":"Name of the exception type. For example, Available, or Not Available.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top