Batch Update Reasons
put
/api/restapi/reason/batch
Send a request to this endpoint to update one or more reasons.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : List<ApiEntityReasonInput>
Type:
array
Title:
Show Source
List<ApiEntityReasonInput>
-
Array of:
object ApiEntityReasonInput
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
Nested 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.
Show Source
- reasonId
- reasonName,workspaceId
- reasonName,workspaceCode
-
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.
-
associationType: stringRead Only:true
Allowed Values:[ "OWNED", "INHERITED" ]
Deprecated. As of 23.12.The type of association in the relationship between the reason and the workspace. Possible values are Owned and Inherited. -
link: string(url)Read Only:true
Deprecated. As of 23.10.The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
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. -
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.10.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.
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" ]
Examples
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 a baseline reason.