Jump to

• Request
• Response

Create a work schedule

post

/fscmRestApi/resources/11.13.18.05/publicSectorWorkSchedules

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 ()

The following table describes the body parameters in the request for this task.

Root Schema : schema

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The agency identifier of the public sector entity to which this work schedule applies.
• BetwRecurNum: integer (int32)
  Title: Weeks Between Occurrences

  The number of weeks between occurrences of the schedule. If Recurrence is true, this is a required field.
• BreakTimeFrom: string (date-time)
  Title: Break Start Time

  The start time for a break within the work schedule.
• BreakTimeTo: string (date-time)
  Title: Break End Time

  The end time for a break within the work schedule.
• Description: string
  Title: Description

  Maximum Length: 100

  The description of the work schedule.
• FriFlag: string
  Maximum Length: 1

  Indicates that the work schedule is active on Friday.
• MonFlag: string
  Maximum Length: 1

  Indicates that the work schedule is active on Monday.
• Recurrence: string
  Title: Recurrence

  Maximum Length: 3

  The recurrence indicates whether the schedule repeats on a weekly basis. If true, the schedule repeats every BetwRecurNum weeks. If false, the schedule does not repeat. The default value is true.
• SatFlag: string
  Maximum Length: 1

  Indicates that the work schedule is active on Saturday.
• ScheduleId: string
  Title: Schedule ID

  Maximum Length: 30

  The unique identifier for the work schedule.
• SunFlag: string
  Maximum Length: 1

  Indicates that the work schedule is active on Sunday.
• ThuFlag: string
  Maximum Length: 1

  Indicates that the work schedule is active on Thursday.
• TueFlag: string
  Maximum Length: 1

  Indicates that the work schedule is active on Tuesday.
• ValidFromDate: string (date)
  Title: Start Date

  The start date on which the work schedule becomes effective.
• ValidToDate: string (date)
  Title: End Date

  The end date after which the work schedule is no longer effective.
• WedFlag: string
  Maximum Length: 1

  Indicates that the work schedule is active on Wednesday.
• WorkTimeFrom: string (date-time)
  Title: Work Start Time

  The work start time for the work schedule.
• WorkTimeRange: string
  Title: Work Time

  Maximum Length: 80

  The time range (start time to end time) for the work schedule. This attribute is read-only and cannot be updated by the resource consumer.
• WorkTimeTo: string (date-time)
  Title: Work End Time

  The work end time for the work schedule.

{
    "type":"object",
    "properties":{
        "ValidToDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date after which the work schedule is no longer effective.",
            "format":"date",
            "nullable":false
        },
        "Recurrence":{
            "title":"Recurrence",
            "maxLength":3,
            "type":"string",
            "description":"The recurrence indicates whether the schedule repeats on a weekly basis. If true, the schedule repeats every BetwRecurNum weeks. If false, the schedule does not repeat. The default value is true.",
            "nullable":false
        },
        "MonFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the work schedule is active on Monday.",
            "nullable":false
        },
        "SunFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the work schedule is active on Sunday.",
            "nullable":false
        },
        "Description":{
            "title":"Description",
            "maxLength":100,
            "type":"string",
            "description":"The description of the work schedule.",
            "nullable":false
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this work schedule applies.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            }
        },
        "WorkTimeRange":{
            "title":"Work Time",
            "maxLength":80,
            "type":"string",
            "description":"The time range (start time to end time) for the work schedule. This attribute is read-only and cannot be updated by the resource consumer.",
            "nullable":true,
            "x-queryable":false
        },
        "ScheduleId":{
            "title":"Schedule ID",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the work schedule.",
            "nullable":false
        },
        "FriFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the work schedule is active on Friday.",
            "nullable":false
        },
        "WorkTimeTo":{
            "title":"Work End Time",
            "type":"string",
            "description":"The work end time for the work schedule.",
            "format":"date-time",
            "nullable":false
        },
        "BreakTimeTo":{
            "title":"Break End Time",
            "type":"string",
            "description":"The end time for a break within the work schedule.",
            "format":"date-time",
            "nullable":true
        },
        "WorkTimeFrom":{
            "title":"Work Start Time",
            "type":"string",
            "description":"The work start time for the work schedule.",
            "format":"date-time",
            "nullable":false
        },
        "TueFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the work schedule is active on Tuesday.",
            "nullable":false
        },
        "BetwRecurNum":{
            "title":"Weeks Between Occurrences",
            "type":"integer",
            "description":"The number of weeks between occurrences of the schedule. If Recurrence is true, this is a required field.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":2
            }
        },
        "ValidFromDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date on which the work schedule becomes effective.",
            "format":"date",
            "nullable":false
        },
        "BreakTimeFrom":{
            "title":"Break Start Time",
            "type":"string",
            "description":"The start time for a break within the work schedule.",
            "format":"date-time",
            "nullable":true
        },
        "WedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the work schedule is active on Wednesday.",
            "nullable":false
        },
        "ThuFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the work schedule is active on Thursday.",
            "nullable":false
        },
        "SatFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the work schedule is active on Saturday.",
            "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 : publicSectorWorkSchedules-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The agency identifier of the public sector entity to which this work schedule applies.
• BetwRecurNum: integer (int32)
  Title: Weeks Between Occurrences

  The number of weeks between occurrences of the schedule. If Recurrence is true, this is a required field.
• BreakTimeFrom: string (date-time)
  Title: Break Start Time

  The start time for a break within the work schedule.
• BreakTimeTo: string (date-time)
  Title: Break End Time

  The end time for a break within the work schedule.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the work schedule.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time that the work schedule was created.
• Description: string
  Title: Description

  Maximum Length: 100

  The description of the work schedule.
• FriFlag: string
  Maximum Length: 1

  Indicates that the work schedule is active on Friday.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time that the work schedule was last modified.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last modified the work schedule.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MonFlag: string
  Maximum Length: 1

  Indicates that the work schedule is active on Monday.
• Recurrence: string
  Title: Recurrence

  Maximum Length: 3

  The recurrence indicates whether the schedule repeats on a weekly basis. If true, the schedule repeats every BetwRecurNum weeks. If false, the schedule does not repeat. The default value is true.
• SatFlag: string
  Maximum Length: 1

  Indicates that the work schedule is active on Saturday.
• ScheduleId: string
  Title: Schedule ID

  Maximum Length: 30

  The unique identifier for the work schedule.
• SunFlag: string
  Maximum Length: 1

  Indicates that the work schedule is active on Sunday.
• ThuFlag: string
  Maximum Length: 1

  Indicates that the work schedule is active on Thursday.
• TueFlag: string
  Maximum Length: 1

  Indicates that the work schedule is active on Tuesday.
• ValidFromDate: string (date)
  Title: Start Date

  The start date on which the work schedule becomes effective.
• ValidToDate: string (date)
  Title: End Date

  The end date after which the work schedule is no longer effective.
• WedFlag: string
  Maximum Length: 1

  Indicates that the work schedule is active on Wednesday.
• WorkTimeFrom: string (date-time)
  Title: Work Start Time

  The work start time for the work schedule.
• WorkTimeRange: string
  Title: Work Time

  Maximum Length: 80

  The time range (start time to end time) for the work schedule. This attribute is read-only and cannot be updated by the resource consumer.
• WorkTimeTo: string (date-time)
  Title: Work End Time

  The work end time for the work schedule.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last modified the work schedule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time that the work schedule was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ValidToDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date after which the work schedule is no longer effective.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "Recurrence":{
            "title":"Recurrence",
            "maxLength":3,
            "type":"string",
            "description":"The recurrence indicates whether the schedule repeats on a weekly basis. If true, the schedule repeats every BetwRecurNum weeks. If false, the schedule does not repeat. The default value is true.",
            "nullable":false,
            "x-queryable":true
        },
        "MonFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the work schedule is active on Monday.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the work schedule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SunFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the work schedule is active on Sunday.",
            "nullable":false,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":100,
            "type":"string",
            "description":"The description of the work schedule.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this work schedule applies.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "WorkTimeRange":{
            "title":"Work Time",
            "maxLength":80,
            "type":"string",
            "description":"The time range (start time to end time) for the work schedule. This attribute is read-only and cannot be updated by the resource consumer.",
            "nullable":true,
            "x-queryable":false
        },
        "ScheduleId":{
            "title":"Schedule ID",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the work schedule.",
            "nullable":false,
            "x-queryable":true
        },
        "FriFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the work schedule is active on Friday.",
            "nullable":false,
            "x-queryable":true
        },
        "WorkTimeTo":{
            "title":"Work End Time",
            "type":"string",
            "description":"The work end time for the work schedule.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "BreakTimeTo":{
            "title":"Break End Time",
            "type":"string",
            "description":"The end time for a break within the work schedule.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "WorkTimeFrom":{
            "title":"Work Start Time",
            "type":"string",
            "description":"The work start time for the work schedule.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "TueFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the work schedule is active on Tuesday.",
            "nullable":false,
            "x-queryable":true
        },
        "BetwRecurNum":{
            "title":"Weeks Between Occurrences",
            "type":"integer",
            "description":"The number of weeks between occurrences of the schedule. If Recurrence is true, this is a required field.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":2
            },
            "x-queryable":true
        },
        "ValidFromDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date on which the work schedule becomes effective.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "BreakTimeFrom":{
            "title":"Break Start Time",
            "type":"string",
            "description":"The start time for a break within the work schedule.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "WedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the work schedule is active on Wednesday.",
            "nullable":false,
            "x-queryable":true
        },
        "ThuFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the work schedule is active on Thursday.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SatFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the work schedule is active on Saturday.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time that the work schedule was last modified.",
            "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