Jump to

• Request
• Response

Batch Create Holiday Lists

post

/api/restapi/holidayList/batch

Send a request to this endpoint to create one or more holiday lists. An application object will be created for each JSON object provided in the request body.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : List<ApiEntityHolidayGroupInput>

Type: array

Title: List<ApiEntityHolidayGroupInput>

Show Source

• Array of: object ApiEntityHolidayGroupInput
  Title: ApiEntityHolidayGroupInput

  This entity represents a HolidayGroup object, a unique HolidayGroup object can be identified by the following combinations of the fields.

  • holidayListId
  • holidayGroupName,workspaceId
  • holidayGroupName,workspaceCode

{
    "title":"List<ApiEntityHolidayGroupInput>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityHolidayGroupInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityHolidayGroupInput

Type: object

Title: ApiEntityHolidayGroupInput

This entity represents a HolidayGroup object, a unique HolidayGroup object can be identified by the following combinations of the fields.

• holidayListId
• holidayGroupName,workspaceId
• holidayGroupName,workspaceCode

Show Source

• holidayGroupName(required): string
  Maximum Length: 60

  The name of the holiday list.
• holidayListId: integer (int64)
  The unique identifier for the holiday list. This value should not be provided in create operation request data, however, it is required for update requests.
• holidays: array holidays
  The list of holidays associated with the holiday group.
• link: string (url)
  Read Only: true

  Deprecated. As of 24.4.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 24.4.
  Date when the record was last updated.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.
• workspaceId(required): integer (int64)
  The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.

{
    "title":"ApiEntityHolidayGroupInput",
    "required":[
        "holidayGroupName",
        "workspaceId"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.4</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.4</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "holidayListId":{
            "type":"integer",
            "description":"The unique identifier for the holiday list. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "holidays":{
            "type":"array",
            "description":"The list of holidays associated with the holiday group.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityHolidayInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "holidayGroupName":{
            "maxLength":"60",
            "type":"string",
            "description":"The name of the holiday list.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a HolidayGroup object, a unique HolidayGroup object can be identified by the following combinations of the fields.<ul><li>holidayListId</li><li>holidayGroupName,workspaceId</li><li>holidayGroupName,workspaceCode</li>",
    "exampleSetFlag":false
}

Nested Schema : holidays

Type: array

The list of holidays associated with the holiday group.

Show Source

• Array of: object ApiEntityHolidayInput
  Title: ApiEntityHolidayInput

{
    "type":"array",
    "description":"The list of holidays associated with the holiday group.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityHolidayInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityHolidayInput

Type: object

Title: ApiEntityHolidayInput

Show Source

• dayOfMonth: integer (int32)
  The day of the month the holiday is on.
• dayOfWeek: integer (int32)
  The day of the week the holiday is on.
• holidayDate(required): string (date-time)
  The date of the holiday.
• holidayGroupName: string
  Read Only: true

  Maximum Length: 60

  Deprecated. As of 24.4.
  The name of the holiday list.
• holidayId: integer (int64)
  The unique identifier for the holiday.
• holidayListId(required): integer (int64)
  The unique identifier for the holiday list.
• holidayName(required): string
  Maximum Length: 60

  The name of the holiday.
• link: string (url)
  Read Only: true

  Deprecated. As of 24.4.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• month: integer (int32)
  The month the holiday is in.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 24.4.
  Date when the record was last updated.
• week: integer (int32)
  The week of the month the holiday is in.
• workspaceCode: string
  Read Only: true

  Minimum Length: 0

  Maximum Length: 60

  Deprecated. As of 24.4.
  The user-specified identifier of a workspace.

{
    "title":"ApiEntityHolidayInput",
    "required":[
        "holidayDate",
        "holidayListId",
        "holidayName"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.4</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "dayOfMonth":{
            "type":"integer",
            "description":"The day of the month the holiday is on.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "dayOfWeek":{
            "type":"integer",
            "description":"The day of the week the holiday is on.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "week":{
            "type":"integer",
            "description":"The week of the month the holiday is in.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "month":{
            "type":"integer",
            "description":"The month the holiday is in.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.4</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.4</i>.</br>The user-specified identifier of a workspace.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "holidayListId":{
            "type":"integer",
            "description":"The unique identifier for the holiday list.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "holidayId":{
            "type":"integer",
            "description":"The unique identifier for the holiday.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "holidayName":{
            "maxLength":"60",
            "type":"string",
            "description":"The name of the holiday.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "holidayDate":{
            "type":"string",
            "description":"The date of the holiday.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "holidayGroupName":{
            "maxLength":"60",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.4</i>.</br>The name of the holiday list.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Examples

Select an example Batch Create Holiday Lists

Back to Top

Response

Supported Media Types

• application/json

201 Response

The object was successfully created.

Body ()

Root Schema : List<ApiEntityHolidayGroup>

Type: array

Title: List<ApiEntityHolidayGroup>

Show Source

• Array of: object ApiEntityHolidayGroup
  Title: ApiEntityHolidayGroup

{
    "title":"List<ApiEntityHolidayGroup>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityHolidayGroup",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityHolidayGroup

Type: object

Title: ApiEntityHolidayGroup

Show Source

• holidayGroupName: string
  Maximum Length: 60

  The name of the holiday list.
• holidayListId: integer (int64)
  The unique identifier for the holiday list. This value should not be provided in create operation request data, however, it is required for update requests.
• holidays: array holidays
  The list of holidays associated with the holiday group.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• updateDate: string (date-time)
  Date when the record was last updated.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.

{
    "title":"ApiEntityHolidayGroup",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "holidayListId":{
            "type":"integer",
            "description":"The unique identifier for the holiday list. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "holidays":{
            "type":"array",
            "description":"The list of holidays associated with the holiday group.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityHoliday",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "holidayGroupName":{
            "maxLength":"60",
            "type":"string",
            "description":"The name of the holiday list.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : holidays

Type: array

The list of holidays associated with the holiday group.

Show Source

• Array of: object ApiEntityHoliday
  Title: ApiEntityHoliday

{
    "type":"array",
    "description":"The list of holidays associated with the holiday group.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityHoliday",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityHoliday

Type: object

Title: ApiEntityHoliday

Show Source

• dayOfMonth: integer (int32)
  The day of the month the holiday is on.
• dayOfWeek: integer (int32)
  The day of the week the holiday is on.
• holidayDate: string (date-time)
  The date of the holiday.
• holidayGroupName: string
  Maximum Length: 60

  The name of the holiday list.
• holidayId: integer (int64)
  The unique identifier for the holiday.
• holidayListId: integer (int64)
  The unique identifier for the holiday list.
• holidayName: string
  Maximum Length: 60

  The name of the holiday.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• month: integer (int32)
  The month the holiday is in.
• updateDate: string (date-time)
  Date when the record was last updated.
• week: integer (int32)
  The week of the month the holiday is in.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityHoliday",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "dayOfMonth":{
            "type":"integer",
            "description":"The day of the month the holiday is on.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "dayOfWeek":{
            "type":"integer",
            "description":"The day of the week the holiday is on.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "week":{
            "type":"integer",
            "description":"The week of the month the holiday is in.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "month":{
            "type":"integer",
            "description":"The month the holiday is in.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "holidayListId":{
            "type":"integer",
            "description":"The unique identifier for the holiday list.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "holidayId":{
            "type":"integer",
            "description":"The unique identifier for the holiday.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "holidayName":{
            "maxLength":"60",
            "type":"string",
            "description":"The name of the holiday.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "holidayDate":{
            "type":"string",
            "description":"The date of the holiday.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "holidayGroupName":{
            "maxLength":"60",
            "type":"string",
            "description":"The name of the holiday list.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

400 Response

Invalid input for the Holiday List service. Verify the request contains valid data, then resubmit the request.

Back to Top