Jump to

• Request
• Response

Create workday patterns assigned to a schedule

post

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

Request

Path Parameters

• ScheduleId(required): integer(int64)
  The value that uniquely identifies the schedule. It is a primary key that the application generates when it creates a schedule. This attribute is required.

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

• PatternId: integer (int64)
  The value that uniquely identifies the foreign key reference to the associated pattern within the schedule. This attribute is a required input.
• PatternName: string
  The name of the associated pattern.
• PatternSequenceNumber: integer (int64)
  Title: Sequence

  The number that identifies the sequence order of each pattern assigned to a schedule.

{
    "type":"object",
    "properties":{
        "PatternSequenceNumber":{
            "title":"Sequence",
            "type":"integer",
            "description":"The number that identifies the sequence order of each pattern assigned to a schedule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PatternName":{
            "type":"string",
            "description":"The name of the associated pattern.",
            "nullable":true
        },
        "PatternId":{
            "type":"integer",
            "description":"The value that uniquely identifies the foreign key reference to the associated pattern within the schedule. This attribute is a required input.",
            "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(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 : schedules-scheduleWorkdayPatterns-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.
• 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.
• PatternId: integer (int64)
  The value that uniquely identifies the foreign key reference to the associated pattern within the schedule. This attribute is a required input.
• PatternName: string
  The name of the associated pattern.
• PatternSequenceNumber: integer (int64)
  Title: Sequence

  The number that identifies the sequence order of each pattern assigned to a schedule.
• SchedulePatternId: integer (int64)
  Read Only: true

  The value that uniquely identifies the pattern assignment to the parent schedule. It is a primary key that the application generates when a pattern is assigned to a schedule. This attribute is required.

{
    "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
        },
        "PatternId":{
            "type":"integer",
            "description":"The value that uniquely identifies the foreign key reference to the associated pattern within the schedule. This attribute is a required input.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SchedulePatternId":{
            "type":"integer",
            "description":"The value that uniquely identifies the pattern assignment to the parent schedule. It is a primary key that the application generates when a pattern is assigned to a schedule. This attribute is required.",
            "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"
            }
        },
        "PatternSequenceNumber":{
            "title":"Sequence",
            "type":"integer",
            "description":"The number that identifies the sequence order of each pattern assigned to a schedule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PatternName":{
            "type":"string",
            "description":"The name of the associated pattern.",
            "nullable":true,
            "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"
    }
}

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