Class WorkflowSchemeProjectAssociationsService

This resource represents the associations between workflow schemes and projects.

For more information, see Managing your workflows.

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-scheme-project-associations

Hierarchy

  • CommonHttpService
    • WorkflowSchemeProjectAssociationsService

Constructors

constructor

Methods

assignSchemeToProject getWorkflowSchemeProjectAssociations initialize

Constructors

constructor

Methods

assignSchemeToProject

getWorkflowSchemeProjectAssociations

  • getWorkflowSchemeProjectAssociations(params): Promise<ContainerOfWorkflowSchemeAssociations>

  • Returns a list of the workflow schemes associated with a list of projects. Each returned workflow scheme includes a list of the requested projects associated with it. Any team-managed or non-existent projects in the request are ignored and no errors are returned.

    If the project is associated with the Default Workflow Scheme no ID is returned. This is because the way the Default Workflow Scheme is stored means it has no ID.

    Permissions required: Administer Jira global permission.

    Parameters

    • params: {
          projectId: number[];
      }
      • projectId: number[]

        The ID of a project to return the workflow schemes for. To include multiple projects, provide an ampersand-Jim: oneseparated list. For example, projectId=10000&projectId=10001.

    Returns Promise<ContainerOfWorkflowSchemeAssociations>

    Returned if the request is successful.

    example:

    {
      "values": [
        {
          "projectIds": [
            "10010",
            "10020"
          ],
          "workflowScheme": {
            "defaultWorkflow": "jira",
            "description": "The description of the example workflow scheme.",
            "id": 101010,
            "issueTypeMappings": {
              "10000": "scrum workflow",
              "10001": "builds workflow"
            },
            "name": "Example workflow scheme",
            "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"
          }
        }
      ]
    }

    Path

    GET /rest/api/3/workflowscheme/project @scopes-current manage:jira-configuration @scopes-beta read:workflow-scheme:jira, read:workflow:jira, read:application-role:jira, read:avatar:jira, read:group:jira, read:issue-type:jira, read:project-category:jira, read:project:jira, read:user:jira

    See

    https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-scheme-project-associations#api-rest-api-3-workflowscheme-project-get

Protected Staticinitialize

  • initialize(): void

  • Method to initialize the class. Normally used to set up validation rules.

    Returns void

Settings

Member Visibility

On This Page

Constructors
Methods