View a Reason by Workspace and Name
get
/api/restapi/reason/workspace/{workspaceId}/name/{reasonName}
This endpoint returns reasons that meet the following requirements:
- The object is associated with a workspace with an ID value that matches the value of the {workspaceId} path parameter.
- The object has a name that matches the value of the {reasonName} path parameter.
Request
Path Parameters
-
reasonName(required): string
The name of a reason.
-
workspaceId(required): integer(int64)
The system-generated identifier of a workspace.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : ApiEntityReason
Type:
object
Title:
Show Source
ApiEntityReason
-
abbreviation: 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: string
Allowed Values:
[ "OWNED", "INHERITED" ]
The type of association in the relationship between the reason and the workspace. Possible values are Owned and Inherited. -
link: string
(url)
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: string
Minimum Length:
1
Maximum Length:255
The name of the reason for recommitting to a task. -
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.
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" ]
404 Response
The requested reason does not exist, or you do not have access to it.