Jump to

• Request
• Response

Update a Reason

put

/api/restapi/reason

Send a request to this endpoint to update a reason.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ApiEntityReasonInput

Type: object

Title: ApiEntityReasonInput

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

• reasonId
• reasonName,workspaceId
• reasonName,workspaceCode

Show Source

• abbreviation(required): string
  Minimum Length: 1

  Maximum Length: 60

  The abbreviation of the reason for recommitting to a task.
• appliesTo: array appliesTo
  Indicates the type of object the reason is associated to.
• pushDownType: string
  Allowed Values: [ "MANUAL", "AUTOMATIC" ]

  How data is shared between parent and child workspaces.
  Manual: Data can be pulled down by child workspaces. This is the default option.
  Automatic: Data is automatically shared with all child workspaces.
• reasonId: integer (int64)
  The unique identifier of a reason.
• reasonName(required): string
  Minimum Length: 1

  Maximum Length: 255

  The name of the reason for recommitting to a task.
• 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":"ApiEntityReasonInput",
    "required":[
        "abbreviation",
        "reasonName",
        "workspaceId"
    ],
    "type":"object",
    "properties":{
        "pushDownType":{
            "type":"string",
            "description":"How data is shared between parent and child workspaces. <br />Manual: Data can be pulled down by child workspaces. This is the default option. <br />Automatic: Data is automatically shared with all child workspaces.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "MANUAL",
                "AUTOMATIC"
            ]
        },
        "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"
            ]
        },
        "reasonName":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"The name of the reason for recommitting to a task.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "reasonId":{
            "type":"integer",
            "description":"The unique identifier of a reason.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "abbreviation":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The abbreviation of the reason for recommitting to a task.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "appliesTo":{
            "type":"array",
            "description":"Indicates the type of object the reason is associated to.   ",
            "exampleSetFlag":false,
            "items":{
                "type":"string",
                "exampleSetFlag":false,
                "types":[
                    "string"
                ],
                "enum":[
                    "TASKS",
                    "CHANGE_EVENT"
                ]
            },
            "types":[
                "array"
            ]
        },
        "workspaceCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a Reason object, a unique Reason object can be identified by the following combinations of the fields.<ul><li>reasonId</li><li>reasonName,workspaceId</li><li>reasonName,workspaceCode</li>",
    "exampleSetFlag":false
}

Nested Schema : appliesTo

Type: array

Indicates the type of object the reason is associated to.

Show Source

• Array of: string
  Allowed Values: [ "TASKS", "CHANGE_EVENT" ]

{
    "type":"array",
    "description":"Indicates the type of object the reason is associated to.   ",
    "exampleSetFlag":false,
    "items":{
        "type":"string",
        "exampleSetFlag":false,
        "types":[
            "string"
        ],
        "enum":[
            "TASKS",
            "CHANGE_EVENT"
        ]
    },
    "types":[
        "array"
    ]
}

Examples

Select an example Update a Reason Using Reason ID

Back to Top

Response

204 Response

Successful operation with no content.

400 Response

Invalid input for a baseline reason.

Back to Top