Class WorkflowTransitionPropertiesService

This resource represents workflow transition properties, which provides for storing custom data against a workflow transition. Use it to get, create, and delete workflow transition properties as well as get a list of property keys for a workflow transition. Workflow transition properties are a type of entity property.

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-transition-properties

Hierarchy

CommonHttpService
- WorkflowTransitionPropertiesService

Index

Constructors

constructor

Methods

createWorkflowTransitionProperty deleteWorkflowTransitionProperty getWorkflowTransitionProperties updateWorkflowTransitionProperty initialize

Constructors

constructor

new WorkflowTransitionPropertiesService(getClientInstance): WorkflowTransitionPropertiesService
Internal
Create a new instance of the service.
Parameters
- getClientInstance: (() => CommonHttpClient)
  - - (): CommonHttpClient
    - Returns CommonHttpClient
Returns WorkflowTransitionPropertiesService
Inherited from CommonHttpService.constructor

Methods

createWorkflowTransitionProperty

createWorkflowTransitionProperty(params): Promise<WorkflowTransitionProperty>
Adds a property to a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see Transition properties and Workflow properties.

Permissions required: Administer Jira global permission.
Parameters
- params: {
      key: string;
      transitionId: number;
      workflowMode?: "live" | "draft";
      workflowName: string;
      workflowTransitionProperty: WorkflowTransitionProperty;
  }
  - key: string
    The key of the property being added, also known as the name of the property. Set this to the same value as the key defined in the request body.
  - transitionId: number
    The ID of the transition. To get the ID, view the workflow in text mode in the Jira admin settings. The ID is shown next to the transition.
  - OptionalworkflowMode?: "live" | "draft"
    The workflow status. Set to live for inactive workflows or draft for draft workflows. Active workflows cannot be edited.
  - workflowName: string
    The name of the workflow that the transition belongs to.
  - workflowTransitionProperty: WorkflowTransitionProperty
    Example
Returns Promise<WorkflowTransitionProperty>
200 response

example:
```
{
  "key": "jira.i18n.title",
  "value": "some.title",
  "id": "jira.i18n.title"
}
```
Path
POST /rest/api/3/workflow/transitions/{transitionId}/properties @scopes-current manage:jira-configuration @scopes-beta write:workflow.property:jira, read:workflow.property:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-transition-properties#api-rest-api-3-workflow-transitions-transitionid-properties-post

deleteWorkflowTransitionProperty

deleteWorkflowTransitionProperty(params): Promise<void>
Deletes a property from a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see Transition properties and Workflow properties.

Permissions required: Administer Jira global permission.
Parameters
- params: {
      key: string;
      transitionId: number;
      workflowMode?: "live" | "draft";
      workflowName: string;
  }
  - key: string
    The name of the transition property to delete, also known as the name of the property.
  - transitionId: number
    The ID of the transition. To get the ID, view the workflow in text mode in the Jira admin settings. The ID is shown next to the transition.
  - OptionalworkflowMode?: "live" | "draft"
    The workflow status. Set to live for inactive workflows or draft for draft workflows. Active workflows cannot be edited.
  - workflowName: string
    The name of the workflow that the transition belongs to.
Returns Promise<void>
Path
DELETE /rest/api/3/workflow/transitions/{transitionId}/properties @scopes-current manage:jira-configuration @scopes-beta delete:workflow.property:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-transition-properties#api-rest-api-3-workflow-transitions-transitionid-properties-delete

getWorkflowTransitionProperties

getWorkflowTransitionProperties(params): Promise<WorkflowTransitionProperty>
Returns the properties on a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see Transition properties and Workflow properties.

Permissions required: Administer Jira global permission.
Parameters
- params: {
      includeReservedKeys?: boolean;
      key?: string;
      transitionId: number;
      workflowMode?: "live" | "draft";
      workflowName: string;
  }
  - OptionalincludeReservedKeys?: boolean
    Some properties with keys that have the jira. prefix are reserved, which means they are not editable. To include these properties in the results, set this parameter to true.
  - Optionalkey?: string
    The key of the property being returned, also known as the name of the property. If this parameter is not specified, all properties on the transition are returned.
  - transitionId: number
    The ID of the transition. To get the ID, view the workflow in text mode in the Jira administration console. The ID is shown next to the transition.
  - OptionalworkflowMode?: "live" | "draft"
    The workflow status. Set to live for active and inactive workflows, or draft for draft workflows.
  - workflowName: string
    The name of the workflow that the transition belongs to.
Returns Promise<WorkflowTransitionProperty>
200 response

example:
```
[
  {
    "id": "jira.i18n.title",
    "key": "jira.i18n.title",
    "value": "some.title"
  },
  {
    "id": "jira.permission",
    "key": "jira.permission",
    "value": "createissue"
  }
]
```
Path
GET /rest/api/3/workflow/transitions/{transitionId}/properties @scopes-current manage:jira-configuration @scopes-beta read:workflow.property:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-transition-properties#api-rest-api-3-workflow-transitions-transitionid-properties-get

updateWorkflowTransitionProperty

updateWorkflowTransitionProperty(params): Promise<WorkflowTransitionProperty>
Updates a workflow transition by changing the property value. Trying to update a property that does not exist results in a new property being added to the transition. Transition properties are used to change the behavior of a transition. For more information, see Transition properties and Workflow properties.

Permissions required: Administer Jira global permission.
Parameters
- params: {
      key: string;
      transitionId: number;
      workflowMode?: "live" | "draft";
      workflowName: string;
      workflowTransitionProperty: WorkflowTransitionProperty;
  }
  - key: string
    The key of the property being updated, also known as the name of the property. Set this to the same value as the key defined in the request body.
  - transitionId: number
    The ID of the transition. To get the ID, view the workflow in text mode in the Jira admin settings. The ID is shown next to the transition.
  - OptionalworkflowMode?: "live" | "draft"
    The workflow status. Set to live for inactive workflows or draft for draft workflows. Active workflows cannot be edited.
  - workflowName: string
    The name of the workflow that the transition belongs to.
  - workflowTransitionProperty: WorkflowTransitionProperty
    Example
Returns Promise<WorkflowTransitionProperty>
200 response

example:
```
{
  "key": "jira.i18n.title",
  "value": "some.title",
  "id": "jira.i18n.title"
}
```
Path
PUT /rest/api/3/workflow/transitions/{transitionId}/properties @scopes-current manage:jira-configuration @scopes-beta write:workflow.property:jira, read:workflow.property:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-transition-properties#api-rest-api-3-workflow-transitions-transitionid-properties-put

`Protected` `Static`initialize

initialize(): void
Method to initialize the class. Normally used to set up validation rules.

Returns void
Overrides CommonHttpService.initialize

Class WorkflowTransitionPropertiesService

See

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CommonHttpClient

Returns WorkflowTransitionPropertiesService

Methods

createWorkflowTransitionProperty

Parameters

key: string

transitionId: number

OptionalworkflowMode?: "live" | "draft"

workflowName: string

workflowTransitionProperty: WorkflowTransitionProperty

Example

Returns Promise<WorkflowTransitionProperty>

Path

See

deleteWorkflowTransitionProperty

Parameters

key: string

transitionId: number

OptionalworkflowMode?: "live" | "draft"

workflowName: string

Returns Promise<void>

Path

See

getWorkflowTransitionProperties

Parameters

OptionalincludeReservedKeys?: boolean

Optionalkey?: string

transitionId: number

OptionalworkflowMode?: "live" | "draft"

workflowName: string

Returns Promise<WorkflowTransitionProperty>

Path

See

updateWorkflowTransitionProperty

Parameters

key: string

transitionId: number

OptionalworkflowMode?: "live" | "draft"

workflowName: string

workflowTransitionProperty: WorkflowTransitionProperty

Example

Returns Promise<WorkflowTransitionProperty>

Path

See

Protected Staticinitialize

Returns void

Settings

On This Page

`Optional`workflowMode?: "live" | "draft"

`Optional`workflowMode?: "live" | "draft"

`Optional`includeReservedKeys?: boolean

`Optional`key?: string

`Optional`workflowMode?: "live" | "draft"

`Optional`workflowMode?: "live" | "draft"

`Protected` `Static`initialize