Jump to

• Request
• Response

Promote Project Calendars To Workspace

put

/api/restapi/calendar/promote

Send a request to this endpoint to promote the project calendars provided in the payload to their immediate workspaces.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : List<ApiEntityPromoteProjectCalendar>

Type: array

Title: List<ApiEntityPromoteProjectCalendar>

Show Source

• Array of: object ApiEntityPromoteProjectCalendar
  Title: ApiEntityPromoteProjectCalendar

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

Nested Schema : ApiEntityPromoteProjectCalendar

Type: object

Title: ApiEntityPromoteProjectCalendar

Show Source

• calendarCode: string
  Maximum Length: 255

  The unique code for the calendar.
• calendarId: integer (int64)
  The unique identifier for the calendar.
• link: string (url)
  Read Only: true

  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project for which the calendar belongs.
• updateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.
• workspaceCode: string
  Maximum Length: 60

  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier for the workspace for which the calendar belongs.

{
    "title":"ApiEntityPromoteProjectCalendar",
    "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",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project for which the calendar belongs.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "calendarId":{
            "type":"integer",
            "description":"The unique identifier for the calendar.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "calendarCode":{
            "maxLength":"255",
            "type":"string",
            "description":"The unique code for the calendar.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier for the workspace for which the calendar belongs.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Examples

Select an example Promote Project Calendar to Parent Workspace

Back to Top

Response

200 Response

A collection of object IDs mapped to a canonical link of the object. For example - {"links":{"1":"https://[host]:[port]/api/restapi/[object]/1","2":"https://[host]:[port]/api/restapi/[object]/2"}}

400 Response

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

Back to Top