Jump to

• Request
• Response

Get a workforce schedule definition

get

/hcmRestApi/resources/11.13.18.05/workforceScheduleDefinitions/{ScheduleId}

Request

Path Parameters

• ScheduleId(required): integer
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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 : workforceScheduleDefinitions-item-response

Type: object

Show Source

• Comments: string
  Read Only: true

  Maximum Length: 4000

  Notes entered by the schedule manager when publishing the workforce schedule.
• CreationDate: string (date-time)
  Read Only: true

  Date when the workforce schedule was created.
• DepartmentId: integer
  Read Only: true

  Unique identifier for the workforce schedule department.
• DepartmentName: string
  Read Only: true

  Maximum Length: 240

  Name of the workforce schedule department.
• EndDate: string (date)
  Read Only: true

  Date when the workforce schedule ends.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the workforce schedule was most recently updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationCode: string
  Read Only: true

  Maximum Length: 60

  Code for the workforce schedule location.
• LocationId: integer (int64)
  Read Only: true

  Unique identifier for the workforce schedule location.
• LocationName: string
  Read Only: true

  Maximum Length: 240

  Name of the workforce schedule location.
• OpenDate: string (date)
  Read Only: true

  Date when the workforce schedule generation window opens.
• PublishDueDate: string (date)
  Read Only: true

  Date when the workforce schedule generation window closes and schedule is due to be published.
• PublishedBy: integer
  Read Only: true

  Unique identifier for the workforce schedule publisher.
• PublishedByPersonNumber: string
  Read Only: true

  Maximum Length: 30

  Person number for the workforce schedule publisher.
• PublishedDate: string (date)
  Read Only: true

  Date when the workforce schedule was published.
• SchedGenProfileId: integer (int64)
  Read Only: true

  Unique identifier for the schedule generation profile used to generate the workforce schedule.
• SchedProfileCode: string
  Read Only: true

  Maximum Length: 30

  Code for the schedule generation profile used to generate the workforce schedule.
• ScheduleId: integer
  Read Only: true

  Unique identifier for the workforce schedule.
• SchedulePhaseCode: string
  Read Only: true

  Maximum Length: 23

  Code for the workforce schedule phase, such as ORA_HTS_PLANNING or ORA_HTS_COMPLETED.
• SchedulePhaseMeaning: string
  Read Only: true

  Maximum Length: 80

  Name of the workforce schedule phase, such as Current or Planning.
• ScheduleStatus: string
  Read Only: true

  Maximum Length: 80

  Name of the workforce schedule status, such as In Progress or Published.
• ScheduleUnitId: integer
  Read Only: true

  Unique identifier for the schedule unit of the workforce schedule.
• SelfScheduleCloseDate: string (date)
  Read Only: true

  Date when the self-scheduling window closes.
• SelfScheduleOpenDate: string (date)
  Read Only: true

  Date when the self-scheduling window opens.
• StartDate: string (date)
  Read Only: true

  Date when the workforce schedule starts.
• StatusCode: string
  Read Only: true

  Maximum Length: 30

  Code for the workforce schedule status, such as ORA_HTS_PUBLISHED, ORA_HTS_UNPUBLISHED, ORA_HTS_IN_PROGRESS, ORA_HTS_NOT_STARTED, or ORA_HTS_GEN_ERROR.
• UnpublishDate: string (date-time)
  Read Only: true

  Date when the workforce schedule was unpublished.
• UnpublishedBy: integer (int64)
  Read Only: true

  Unique identifier for the workforce schedule publisher.
• UnpublishedByPersonNumber: string
  Read Only: true

  Maximum Length: 30

  Person number for the workforce schedule publisher.
• WorkloadUpdateDate: string (date-time)
  Read Only: true

  Date when the workload was most recently updated.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date when the workforce schedule was created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduleUnitId":{
            "type":"integer",
            "description":"Unique identifier for the schedule unit of the workforce schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OpenDate":{
            "type":"string",
            "description":"Date when the workforce schedule generation window opens.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UnpublishedByPersonNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Person number for the workforce schedule publisher.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SchedGenProfileId":{
            "type":"integer",
            "description":"Unique identifier for the schedule generation profile used to generate the workforce schedule.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PublishedBy":{
            "type":"integer",
            "description":"Unique identifier for the workforce schedule publisher.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code for the workforce schedule status, such as ORA_HTS_PUBLISHED, ORA_HTS_UNPUBLISHED, ORA_HTS_IN_PROGRESS, ORA_HTS_NOT_STARTED, or ORA_HTS_GEN_ERROR.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the workforce schedule location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Date when the workforce schedule starts.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PublishDueDate":{
            "type":"string",
            "description":"Date when the workforce schedule generation window closes and schedule is due to be published.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SchedProfileCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code for the schedule generation profile used to generate the workforce schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PublishedByPersonNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Person number for the workforce schedule publisher.",
            "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"
            }
        },
        "WorkloadUpdateDate":{
            "type":"string",
            "description":"Date when the workload was most recently updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SelfScheduleOpenDate":{
            "type":"string",
            "description":"Date when the self-scheduling window opens.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Comments":{
            "maxLength":4000,
            "type":"string",
            "description":"Notes entered by the schedule manager when publishing the workforce schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationId":{
            "type":"integer",
            "description":"Unique identifier for the workforce schedule location.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LocationCode":{
            "maxLength":60,
            "type":"string",
            "description":"Code for the workforce schedule location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SchedulePhaseCode":{
            "maxLength":23,
            "type":"string",
            "description":"Code for the workforce schedule phase, such as ORA_HTS_PLANNING or ORA_HTS_COMPLETED.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UnpublishDate":{
            "type":"string",
            "description":"Date when the workforce schedule was unpublished.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduleId":{
            "type":"integer",
            "description":"Unique identifier for the workforce schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"Date when the workforce schedule ends.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SelfScheduleCloseDate":{
            "type":"string",
            "description":"Date when the self-scheduling window closes.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UnpublishedBy":{
            "type":"integer",
            "description":"Unique identifier for the workforce schedule publisher.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DepartmentName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the workforce schedule department.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PublishedDate":{
            "type":"string",
            "description":"Date when the workforce schedule was published.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DepartmentId":{
            "type":"integer",
            "description":"Unique identifier for the workforce schedule department.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SchedulePhaseMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the workforce schedule phase, such as Current or Planning.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduleStatus":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the workforce schedule status, such as In Progress or Published.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the workforce schedule was most recently updated.",
            "format":"date-time",
            "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