Jump to

• Request
• Response

Promote Project Code Types To Workspace

put

/api/restapi/codeType/promote

Send a request to this endpoint to promote the project code types 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<ApiEntityPromoteProjectCodeType>

Type: array

Title: List<ApiEntityPromoteProjectCodeType>

Show Source

• Array of: object ApiEntityPromoteProjectCodeType
  Title: ApiEntityPromoteProjectCodeType

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

Nested Schema : ApiEntityPromoteProjectCodeType

Type: object

Title: ApiEntityPromoteProjectCodeType

Show Source

• codeTypeCode: string
  Minimum Length: 1

  Maximum Length: 60

  Displays the code or ID of the Code Type.
• codeTypeId: integer (int64)
  The system-generated identifier of a code type.
• 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 code of a Project of a Project CodeType.
• projectId: integer (int64)
  The system generated identifier of a project.
• 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 ID of the owning workspace.

{
    "title":"ApiEntityPromoteProjectCodeType",
    "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"
            ]
        },
        "codeTypeId":{
            "type":"integer",
            "description":"The system-generated identifier of a code type.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeTypeCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"Displays the code or ID of the Code Type.",
            "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 ID of the owning workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The system generated identifier of a project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":60,
            "type":"string",
            "description":"The code of a Project of a Project CodeType.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Back to Top

Response

204 Response

Successful operation with no content.

400 Response

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

Back to Top