Jump to

• Request
• Response

Create schedule exceptions

post

/fscmRestApi/resources/11.13.18.05/scheduleExceptions

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

• AllDayFlag: boolean
  Title: All Day

  Maximum Length: 1

  Default Value: true

  Contains one of the following values: true or false. If true, then the exception is for the entire day and the Exception Start and the Exception End values are dates. If false, then the exception is for a subset of hours within each day in the exception range and the Exception Start and the Exception End values include date and time values. The default value is false.
• CategoryCode: string
  Title: Category

  Maximum Length: 30

  The abbreviation that identifies the category, such as Holiday and Training.
• Description: string
  Title: Description

  Maximum Length: 2000

  The description of the exception that you provide when creating an instance.
• ExceptionEndDate: string
  The date when the schedule no longer uses the exception.
• ExceptionStartDate: string
  The date when the schedule starts to use the exception.
• Name: string
  Title: Name

  Maximum Length: 240

  The name of the schedule exception that you provide when creating an instance. This attribute is required.
• PeriodTypeCode: string
  Title: Period Type

  Maximum Length: 30

  The abbreviation that identifies the type of period, such as Off period and Work period.
• ShortCode: string
  Title: Code

  Maximum Length: 3

  The abbreviation that identifies the exception that is displayed.

{
    "type":"object",
    "properties":{
        "ShortCode":{
            "title":"Code",
            "maxLength":3,
            "type":"string",
            "description":"The abbreviation that identifies the exception that is displayed.",
            "nullable":true
        },
        "CategoryCode":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The abbreviation that identifies the category, such as Holiday and Training.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ExceptionEndDate":{
            "type":"string",
            "description":"The date when the schedule no longer uses the exception.",
            "nullable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":2000,
            "type":"string",
            "description":"The description of the exception that you provide when creating an instance.",
            "nullable":true
        },
        "PeriodTypeCode":{
            "title":"Period Type",
            "maxLength":30,
            "type":"string",
            "description":"The abbreviation that identifies the type of period, such as Off period and Work period.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ExceptionStartDate":{
            "type":"string",
            "description":"The date when the schedule starts to use the exception.",
            "nullable":true
        },
        "AllDayFlag":{
            "title":"All Day",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the exception is for the entire day and the Exception Start and the Exception End values are dates. If false, then the exception is for a subset of hours within each day in the exception range and the Exception Start and the Exception End values include date and time values. The default value is false.",
            "nullable":false,
            "default":true
        },
        "Name":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"The name of the schedule exception that you provide when creating an instance. This attribute is required.",
            "nullable":false
        }
    }
}

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

Type: object

Show Source

• AllDayFlag: boolean
  Title: All Day

  Maximum Length: 1

  Default Value: true

  Contains one of the following values: true or false. If true, then the exception is for the entire day and the Exception Start and the Exception End values are dates. If false, then the exception is for a subset of hours within each day in the exception range and the Exception Start and the Exception End values include date and time values. The default value is false.
• CategoryCode: string
  Title: Category

  Maximum Length: 30

  The abbreviation that identifies the category, such as Holiday and Training.
• 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 exception that you provide when creating an instance.
• ExceptionEndDate: string
  The date when the schedule no longer uses the exception.
• ExceptionId: integer (int64)
  Read Only: true

  The value that uniquely identifies the schedule exception. It is a primary key that the application generates when it creates an exception. This attribute is required.
• ExceptionStartDate: string
  The date when the schedule starts to use the exception.
• 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.
• Name: string
  Title: Name

  Maximum Length: 240

  The name of the schedule exception that you provide when creating an instance. This attribute is required.
• PeriodTypeCode: string
  Title: Period Type

  Maximum Length: 30

  The abbreviation that identifies the type of period, such as Off period and Work period.
• ShortCode: string
  Title: Code

  Maximum Length: 3

  The abbreviation that identifies the exception that is displayed.

{
    "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
        },
        "ShortCode":{
            "title":"Code",
            "maxLength":3,
            "type":"string",
            "description":"The abbreviation that identifies the exception that is displayed.",
            "nullable":true,
            "x-queryable":true
        },
        "CategoryCode":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The abbreviation that identifies the category, such as Holiday and Training.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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 exception that you provide when creating an instance.",
            "nullable":true,
            "x-queryable":true
        },
        "ExceptionStartDate":{
            "type":"string",
            "description":"The date when the schedule starts to use the exception.",
            "nullable":true,
            "x-queryable":true
        },
        "ExceptionId":{
            "type":"integer",
            "description":"The value that uniquely identifies the schedule exception. It is a primary key that the application generates when it creates an exception. This attribute is required.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"The name of the schedule exception that you provide when creating an instance. This attribute is required.",
            "nullable":false,
            "x-queryable":true
        },
        "ExceptionEndDate":{
            "type":"string",
            "description":"The date when the schedule no longer uses the exception.",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodTypeCode":{
            "title":"Period Type",
            "maxLength":30,
            "type":"string",
            "description":"The abbreviation that identifies the type of period, such as Off period and Work period.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AllDayFlag":{
            "title":"All Day",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the exception is for the entire day and the Exception Start and the Exception End values are dates. If false, then the exception is for a subset of hours within each day in the exception range and the Exception Start and the Exception End values include date and time values. The default value is false.",
            "nullable":false,
            "default":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