Jump to

• Request
• Response
• Examples

Update

patch

/fscmRestApi/resources/11.13.18.05/schedules/{ScheduleId}

Request

Path Parameters

• ScheduleId(required): integer(int64)
  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=

Header Parameters

• Metadata-Context: string
  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: string
  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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CategoryCode: string
  Title: Category

  Maximum Length: 30
• DeletedFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: false
• Description: string
  Title: Description

  Maximum Length: 2000
• EffectiveFromDate: string (date)
  Title: Effective from Date
• EffectiveToDate: string (date)
  Title: Effective to Date
• FirstDayOfWorkWeekCode: string
  Title: First Day of Week

  Maximum Length: 30

  Default Value: MONDAY
• HCMScheduleGenerationProfileCode: string
  Maximum Length: 255
• HCMScheduleGenerationProfileId: integer (int64)
• HCMScheduleGenerationProfileName: string
  Maximum Length: 255
• HCMScheduleMappedFlag: boolean
  Maximum Length: 1
• Name: string
  Title: Name

  Maximum Length: 240
• QuarterlyTypeCode: string
  Title: Quarterly Type

  Maximum Length: 30
• scheduleExceptionAssociations: array scheduleExceptionAssociations
• ScheduleTypeCode: string
  Title: Type

  Maximum Length: 30
• scheduleWorkdayPatterns: array scheduleWorkdayPatterns

{
    "type":"object",
    "properties":{
        "CategoryCode":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DeletedFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "nullable":true,
            "default":false
        },
        "Description":{
            "title":"Description",
            "maxLength":2000,
            "type":"string",
            "nullable":true
        },
        "EffectiveFromDate":{
            "title":"Effective from Date",
            "type":"string",
            "format":"date",
            "nullable":false
        },
        "EffectiveToDate":{
            "title":"Effective to Date",
            "type":"string",
            "format":"date",
            "nullable":false
        },
        "FirstDayOfWorkWeekCode":{
            "title":"First Day of Week",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "default":"MONDAY"
        },
        "HCMScheduleGenerationProfileCode":{
            "maxLength":255,
            "type":"string",
            "nullable":true
        },
        "HCMScheduleGenerationProfileId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "HCMScheduleGenerationProfileName":{
            "maxLength":255,
            "type":"string",
            "nullable":true
        },
        "HCMScheduleMappedFlag":{
            "maxLength":1,
            "type":"boolean",
            "nullable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "nullable":false
        },
        "QuarterlyTypeCode":{
            "title":"Quarterly Type",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ScheduleTypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "nullable":false
        },
        "scheduleExceptionAssociations":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/schedules-scheduleExceptionAssociations-item-patch-request"
            }
        },
        "scheduleWorkdayPatterns":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/schedules-scheduleWorkdayPatterns-item-patch-request"
            }
        }
    }
}

Nested Schema : scheduleExceptionAssociations

Type: array

Show Source

• Array of: object schedules-scheduleExceptionAssociations-item-patch-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/schedules-scheduleExceptionAssociations-item-patch-request"
    }
}

Nested Schema : scheduleWorkdayPatterns

Type: array

Show Source

• Array of: object schedules-scheduleWorkdayPatterns-item-patch-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/schedules-scheduleWorkdayPatterns-item-patch-request"
    }
}

Nested Schema : schedules-scheduleExceptionAssociations-item-patch-request

Type: object

Show Source

• ScheduleExceptionName: string

{
    "type":"object",
    "properties":{
        "ScheduleExceptionName":{
            "type":"string",
            "nullable":true
        }
    }
}

Nested Schema : schedules-scheduleWorkdayPatterns-item-patch-request

Type: object

Show Source

• PatternId: integer (int64)
  Title: Workday Pattern
• PatternName: string
• PatternSequenceNumber: integer (int64)
  Title: Sequence

{
    "type":"object",
    "properties":{
        "PatternId":{
            "title":"Workday Pattern",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PatternName":{
            "type":"string",
            "nullable":true
        },
        "PatternSequenceNumber":{
            "title":"Sequence",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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

Type: object

Show Source

• CategoryCode: string
  Title: Category

  Maximum Length: 30
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true
• DeletedFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: false
• Description: string
  Title: Description

  Maximum Length: 2000
• EffectiveFromDate: string (date)
  Title: Effective from Date
• EffectiveToDate: string (date)
  Title: Effective to Date
• FirstDayOfWorkWeek: string
  Read Only: true
• FirstDayOfWorkWeekCode: string
  Title: First Day of Week

  Maximum Length: 30

  Default Value: MONDAY
• HCMScheduleGenerationProfileCode: string
  Maximum Length: 255
• HCMScheduleGenerationProfileId: integer (int64)
• HCMScheduleGenerationProfileName: string
  Maximum Length: 255
• HCMScheduleMappedFlag: boolean
  Maximum Length: 1
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Title: Name

  Maximum Length: 240
• NumberOfAssignments: integer
  Default Value: 0
• QuarterlyTypeCode: string
  Title: Quarterly Type

  Maximum Length: 30
• scheduleExceptionAssociations: array scheduleExceptionAssociations
• ScheduleId: integer (int64)
  Read Only: true
• ScheduleTypeCode: string
  Title: Type

  Maximum Length: 30
• scheduleWorkdayPatterns: array scheduleWorkdayPatterns

{
    "type":"object",
    "properties":{
        "CategoryCode":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeletedFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":2000,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "EffectiveFromDate":{
            "title":"Effective from Date",
            "type":"string",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "EffectiveToDate":{
            "title":"Effective to Date",
            "type":"string",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "FirstDayOfWorkWeek":{
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "FirstDayOfWorkWeekCode"
                ]
            },
            "x-queryable":true
        },
        "FirstDayOfWorkWeekCode":{
            "title":"First Day of Week",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "default":"MONDAY",
            "x-queryable":true
        },
        "HCMScheduleGenerationProfileCode":{
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "HCMScheduleGenerationProfileId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "HCMScheduleGenerationProfileName":{
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "HCMScheduleMappedFlag":{
            "maxLength":1,
            "type":"boolean",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "NumberOfAssignments":{
            "type":"integer",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "QuarterlyTypeCode":{
            "title":"Quarterly Type",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ScheduleId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ScheduleTypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "scheduleExceptionAssociations":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/schedules-scheduleExceptionAssociations-item-response"
            }
        },
        "scheduleWorkdayPatterns":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/schedules-scheduleWorkdayPatterns-item-response"
            }
        }
    }
}

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 : scheduleExceptionAssociations

Type: array

Show Source

• Array of: object schedules-scheduleExceptionAssociations-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/schedules-scheduleExceptionAssociations-item-response"
    }
}

Nested Schema : scheduleWorkdayPatterns

Type: array

Show Source

• Array of: object schedules-scheduleWorkdayPatterns-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/schedules-scheduleWorkdayPatterns-item-response"
    }
}

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."
        }
    }
}

Nested Schema : schedules-scheduleExceptionAssociations-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ScheduleExceptionAssociationId: integer (int64)
  Read Only: true
• ScheduleExceptionId: integer (int64)
  Title: Exception Name
• ScheduleExceptionName: string
• ScheduleId: integer (int64)

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduleExceptionAssociationId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ScheduleExceptionId":{
            "title":"Exception Name",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ScheduleExceptionName":{
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ScheduleId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : schedules-scheduleWorkdayPatterns-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PatternId: integer (int64)
  Title: Workday Pattern
• PatternName: string
• PatternSequenceNumber: integer (int64)
  Title: Sequence
• SchedulePatternId: integer (int64)
  Read Only: true

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PatternId":{
            "title":"Workday Pattern",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PatternName":{
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "PatternSequenceNumber":{
            "title":"Sequence",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SchedulePatternId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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"
    }
}

Links

scheduleExceptionAssociations

Operation: /fscmRestApi/resources/11.13.18.05/schedules/{ScheduleId}/child/scheduleExceptionAssociations

Parameters:

• ScheduleId: $request.path.ScheduleId

scheduleWorkdayPatterns

Operation: /fscmRestApi/resources/11.13.18.05/schedules/{ScheduleId}/child/scheduleWorkdayPatterns

Parameters:

• ScheduleId: $request.path.ScheduleId

Back to Top

Examples

This example describes how to update one schedule.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/schedules/ScheduleId"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

{
	"Name" : "Schedule-Example", 
	"EffectiveToDate" : "2022-12-31", 
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{ 
	"ScheduleId" : 300100126667088, 
	"ScheduleTypeCode" : "TIME", 
	"Name" : "Schedule-Example", 
	"Description" : "Schedule Example of Post", 
	"EffectiveFromDate" : "2018-01-01", 
	"EffectiveToDate" : "2021-12-31", 
	"CategoryCode" : "WORK", 
	"DeletedFlag" : false, 
	"QuarterlyTypeCode" : "13_PERIODS", 
	"NumberOfAssignments" : 0, 
	"scheduleWorkdayPatterns" : [ { 
		"SchedulePatternId" : 300100126667089, 
		"PatternSequenceNumber" : 1, 
		"PatternId" : 999990012726001, 
		"PatternName" : "6 day working 9-5 Time", 
		"links" : [ {
			...
		}]
	}]
	...
}

Back to Top