View Reason by Workspace and Name
get
/primeapi/restapi/reason/workspace/{workspaceId}/name/{reasonName}
This endpoint returns reasons that meet the following requirements:
- The object has a name that matches the value of the {name} path parameter.
Request
Path Parameters
-
reasonName: string
The name of a reason.
-
workspaceId: integer(int64)
The system-generated identifier of a workspace.
Response
Supported Media Types
- application/json
200 Response
successful operation
Root Schema : ApiEntityReason
Type:
Show Source
object
-
abbreviation:
string
The abbreviation of the reason for recommitting to a task.
-
appliesTo(optional):
array appliesTo
The type of the reason.
-
link(optional):
string(url)
Read Only:
true
-
pushDownType(optional):
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(optional):
integer(int64)
The unique identifier of a reason.
-
reasonName:
string
The name of the reason for recommitting to a task.
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
workspaceId:
integer(int64)
The unique identifier of a workspace.
Nested Schema : appliesTo
Type:
array
The type of the reason.
Show Source
-
[0]:
string
Allowed Values:
[ "TASKS", "CHANGE_EVENT" ]
404 Response
The requested reason does not exist, or you do not have access to it.