Jump to

• Request
• Response
• Examples

Get one pattern

get

/fscmRestApi/resources/11.13.18.05/workdayPatterns/{PatternId}

Request

Path Parameters

• PatternId(required): integer(int64)
  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.

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(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 get one work day pattern.

Example cURL Command

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

curl -u username:password "server/fscmRestApi/resources/release_number/workdayPatterns?finder=PrimaryKey;PatternId=PatternId"

For example, the following command gets a work day pattern where the pattern identifier is 999990012726001:

curl -u username:password "server/fscmRestApi/resources/release_number/workdayPatterns?finder=PrimaryKey;PatternId=999990012726001"

Example Response Body

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

{
  "items" : [ {
    "PatternId" : 999990012726001,
    "Name" : "6 day working 9-5 Time",
    "Description" : "pattern desc",
    "PatternTypeCode" : "TIME",
    "LengthInDays" : 7,
...
  } ],
...
}

Back to Top