Jump to

• Request
• Response
• Examples

Create patterns

post

/fscmRestApi/resources/11.13.18.05/workdayPatterns

Request

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Description: string
  Title: Description

  Maximum Length: 2000

  The description of the pattern that you provide when creating an instance.
• LengthInDays: integer (int64)
  Title: Length in Days

  The value of the number of days in a workday pattern. Specifies how many days the pattern will consume in a schedule and the assigned shifts in the pattern filling in this set of days, before the pattern repeats. This attribute is required.
• Name(required): string
  Title: Name

  Maximum Length: 240

  The name of the pattern that you provide when creating an instance. This attribute is required.
• PatternTypeCode(required): string
  Title: Type

  Maximum Length: 30

  The abbreviation that identifies the type of pattern being created. Valid values are Time, Duration, and Elapsed. This attribute is required.
• workdayPatternShifts: array Pattern Shifts
  Title: Pattern Shifts

  The Pattern Shifts resource gets the collection of shifts that you assign to a pattern.

{
    "required":[
        "Name",
        "PatternTypeCode"
    ],
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":2000,
            "type":"string",
            "description":"The description of the pattern that you provide when creating an instance.",
            "nullable":true
        },
        "workdayPatternShifts":{
            "title":"Pattern Shifts",
            "type":"array",
            "description":"The Pattern Shifts resource gets the collection of shifts that you assign to a pattern.",
            "items":{
                "$ref":"#/components/schemas/workdayPatterns-workdayPatternShifts-item-post-request"
            }
        },
        "LengthInDays":{
            "title":"Length in Days",
            "type":"integer",
            "description":"The value of the number of days in a workday pattern. Specifies how many days the pattern will consume in a schedule and the assigned shifts in the pattern filling in this set of days, before the pattern repeats. This attribute is required.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PatternTypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The abbreviation that identifies the type of pattern being created. Valid values are Time, Duration, and Elapsed. This attribute is required.",
            "nullable":false
        },
        "Name":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"The name of the pattern that you provide when creating an instance. This attribute is required.",
            "nullable":false
        }
    }
}

Nested Schema : Pattern Shifts

Type: array

Title: Pattern Shifts

The Pattern Shifts resource gets the collection of shifts that you assign to a pattern.

Show Source

• Array of: object workdayPatterns-workdayPatternShifts-item-post-request

{
    "title":"Pattern Shifts",
    "type":"array",
    "description":"The Pattern Shifts resource gets the collection of shifts that you assign to a pattern.",
    "items":{
        "$ref":"#/components/schemas/workdayPatterns-workdayPatternShifts-item-post-request"
    }
}

Nested Schema : workdayPatterns-workdayPatternShifts-item-post-request

Type: object

Show Source

• EndDay: integer (int64)
  Title: End Day

  The day within the pattern when you stop using the shift.
• SequenceNumber: integer (int64)
  Title: Sequence

  The number that identifies the order of the assigned shift for the Duration pattern. This number is not currently used for Time or Elapsed patterns.
• ShiftId: integer (int64)
  The value that uniquely identifies the shift within the pattern. This attribute is required.
• StartDay: integer (int64)
  Title: Start Day

  The day within the pattern when you begin using the shift.

{
    "type":"object",
    "properties":{
        "SequenceNumber":{
            "title":"Sequence",
            "type":"integer",
            "description":"The number that identifies the order of the assigned shift for the Duration pattern. This number is not currently used for Time or Elapsed patterns.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ShiftId":{
            "type":"integer",
            "description":"The value that uniquely identifies the shift within the pattern. This attribute is required.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "EndDay":{
            "title":"End Day",
            "type":"integer",
            "description":"The day within the pattern when you stop using the shift.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "StartDay":{
            "title":"Start Day",
            "type":"integer",
            "description":"The day within the pattern when you begin using the shift.",
            "format":"int64",
            "nullable":true,
            "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(required):
  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(required):
  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 : workdayPatterns-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date and time when the user created the record.
• Description: string
  Title: Description

  Maximum Length: 2000

  The description of the pattern that you provide when creating an instance.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Date and time when the user most recently updated the record.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User who most recently updated the record.
• LengthInDays: integer (int64)
  Title: Length in Days

  The value of the number of days in a workday pattern. Specifies how many days the pattern will consume in a schedule and the assigned shifts in the pattern filling in this set of days, before the pattern repeats. This attribute is required.
• links: array Links
  Title: Links

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

  Maximum Length: 240

  The name of the pattern that you provide when creating an instance. This attribute is required.
• PatternId: integer (int64)
  Read Only: true

  The value that uniquely identifies the workday pattern. It is a primary key that the application generates when it creates a pattern. This attribute is required.
• PatternTypeCode: string
  Title: Type

  Maximum Length: 30

  The abbreviation that identifies the type of pattern being created. Valid values are Time, Duration, and Elapsed. This attribute is required.
• workdayPatternShifts: array Pattern Shifts
  Title: Pattern Shifts

  The Pattern Shifts resource gets the collection of shifts that you assign to a pattern.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":2000,
            "type":"string",
            "description":"The description of the pattern that you provide when creating an instance.",
            "nullable":true,
            "x-queryable":true
        },
        "PatternId":{
            "type":"integer",
            "description":"The value that uniquely identifies the workday pattern. It is a primary key that the application generates when it creates a pattern. This attribute is required.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PatternTypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The abbreviation that identifies the type of pattern being created. Valid values are Time, Duration, and Elapsed. This attribute is required.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "workdayPatternShifts":{
            "title":"Pattern Shifts",
            "type":"array",
            "description":"The Pattern Shifts resource gets the collection of shifts that you assign to a pattern.",
            "items":{
                "$ref":"#/components/schemas/workdayPatterns-workdayPatternShifts-item-response"
            }
        },
        "LengthInDays":{
            "title":"Length in Days",
            "type":"integer",
            "description":"The value of the number of days in a workday pattern. Specifies how many days the pattern will consume in a schedule and the assigned shifts in the pattern filling in this set of days, before the pattern repeats. This attribute is required.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"The name of the pattern that you provide when creating an instance. This attribute is required.",
            "nullable":false,
            "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 : Pattern Shifts

Type: array

Title: Pattern Shifts

The Pattern Shifts resource gets the collection of shifts that you assign to a pattern.

Show Source

• Array of: object workdayPatterns-workdayPatternShifts-item-response

{
    "title":"Pattern Shifts",
    "type":"array",
    "description":"The Pattern Shifts resource gets the collection of shifts that you assign to a pattern.",
    "items":{
        "$ref":"#/components/schemas/workdayPatterns-workdayPatternShifts-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 : workdayPatterns-workdayPatternShifts-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date and time when the user created the record.
• EndDay: integer (int64)
  Title: End Day

  The day within the pattern when you stop using the shift.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Date and time when the user most recently updated the record.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User who most recently updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PatternDetailId: integer (int64)
  Read Only: true

  The value that uniquely identifies the workday pattern detail. It is a primary key that the application generates when it creates a pattern detail. This attribute is required.
• SequenceNumber: integer (int64)
  Title: Sequence

  The number that identifies the order of the assigned shift for the Duration pattern. This number is not currently used for Time or Elapsed patterns.
• ShiftId: integer (int64)
  The value that uniquely identifies the shift within the pattern. This attribute is required.
• ShiftName: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  The name of the shift detail.
• StartDay: integer (int64)
  Title: Start Day

  The day within the pattern when you begin using the shift.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PatternDetailId":{
            "type":"integer",
            "description":"The value that uniquely identifies the workday pattern detail. It is a primary key that the application generates when it creates a pattern detail. This attribute is required.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ShiftName":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"The name of the shift detail.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SequenceNumber":{
            "title":"Sequence",
            "type":"integer",
            "description":"The number that identifies the order of the assigned shift for the Duration pattern. This number is not currently used for Time or Elapsed patterns.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ShiftId":{
            "type":"integer",
            "description":"The value that uniquely identifies the shift within the pattern. This attribute is required.",
            "format":"int64",
            "nullable":false,
            "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"
            }
        },
        "EndDay":{
            "title":"End Day",
            "type":"integer",
            "description":"The day within the pattern when you stop using the shift.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StartDay":{
            "title":"Start Day",
            "type":"integer",
            "description":"The day within the pattern when you begin using the shift.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "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"
    }
}

Links

workdayPatternShifts

Operation: /fscmRestApi/resources/11.13.18.05/workdayPatterns/{PatternId}/child/workdayPatternShifts

Parameters:

• PatternId: $request.path.PatternId

The Pattern Shifts resource gets the collection of shifts that you assign to a pattern.

Back to Top

Examples

This example describes how to create patterns.

Example cURL Command

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

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

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 creates.

{ 
	"Name" : "WDP-Example", 
	"Description" : "Workday Pattern Example of Post", 
	"PatternTypeCode" : "TIME", 
	"LengthInDays" : 7, 
	"workdayPatternShifts" : [ { 
		"StartDay" : 1, 
		"EndDay" : 5, 
		"ShiftId" : 999990012722001 
	} ] 
} 

Example Response Body

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

{ 
	"PatternId" : 300100126663177, 
	"Name" : "WDP-Example", 
	"Description" : "Workday Pattern Example of Post", 
	"PatternTypeCode" : "TIME", 
	"LengthInDays" : 7, 
	"workdayPatternShifts" : [ { 
		"PatternDetailId" : 300100126663178, 
		"SequenceNumber" : null, 
		"StartDay" : 1, 
		"EndDay" : 5, 
		"ShiftId" : 999990012722001, 
		"ShiftName" : "9-5 Time Shift",
		"links" : [ ... ]
	} ]
	...
}

Back to Top