DevOps Component Actions

On This Page

Properties

DevOps Component actions that can be performed by Jira users.

Each action is optional (unless indicated otherwise). The absence of an action indicates that the action is not supported by the provider.

Properties

associate

Type

object

Required

Yes

Description

Action to associate a devops component entity with a Jira issue.

When invoked: - The provider must send the entity to Jira using the devops component information REST API. - The entity must include the Jira issue association. - The provider must respond with the entity.

If a devops component entity identified by the given URL does not exist, the response should be HTTP 404.

After sending the entity to Jira, the provider may use this action to notify their system that an association has been made with the Jira issue. Note that the association is eventually consistent and may not exist at the time this action completes. Use the onEntityAssociated action if strong consistency is required.

Example request

The templateUrl property of this action will receive a POST request with userId query param when this action is invoked.


 {
    "entity": {
       "url": "https://www.my-component-provider.com/components/pEiVZHXlgwF9hmsToT0Z"
     },
     "associateWith": {
       "ati": "ati:cloud:jira:issue,
       "ari": "ari:cloud:jira:496ad24e-0c63-4b50-a991-46ed81b3d6d6:issue/10001",
       "cloudId": "496ad24e-0c63-4b50-a991-46ed81b3d6d6",
       "id": "10001"
     }
 }

Example response

The response must match the devops component entity provider schema from the Jira component information REST API.

Properties

templateUrl

Type	string
Format	uri-template
Required	Yes

disassociate

Type

object

Required

Yes

Description

Action to disassociate a devops component entity from a Jira issue.

When invoked: - The provider must send the entity to Jira. - The entity must remove the Jira issue association.

If a devops component entity identified by the given ID does not exist, the provider should delete the entity from Jira.

After sending the entity to Jira, the provider may use this action to notify their system that an association has been removed from the Jira issue. Note that the association is eventually consistent and may not have been removed at the time this action completes. Use the onEntityDisassociated action if strong consistency is required.

Example request

The templateUrl property of this action will receive a POST request with userId query param when this action is invoked.


 {
   "entity": {
     "ari": "ari:cloud:jira:496ad24e-0c63-4b50-a991-46ed81b3d6d6:devops-component/activation/3d9e817c-f9e5-495a-b5bd-53d1dabdab99/94a52bf6-9c47-4bd0-ba09-0f9f32b17d07",
     "id": "kBsdWH8uXfziTGDTIN7oLE/0-1"
   },
   "disassociateFrom": {
     "ati": "ati:cloud:jira:issue",
     "ari": "ari:cloud:jira:496ad24e-0c63-4b50-a991-46ed81b3d6d6:issue/234678",
     "cloudId": "496ad24e-0c63-4b50-a991-46ed81b3d6d6",
     "id": "234678"
   }
 }

Properties

templateUrl

Type	string
Format	uri-template
Required	Yes

onEntityAssociated

Type

object

Description

Action to notify the component provider when a devops component has been associated with a Jira issue.

Example request

The templateUrl property of this action will receive a PUT request when this action is invoked. The entity.id is the providers external ID


 {
    "entity": {
      // This is the devops component Atlassian Resource Identifier (ARI). This should be in format: ari:cloud:jira:{siteId}:devops-component/activation/{activationId}/{devOpsComponentId}
      "ari": "ari:cloud:jira:f730ce9c-3442-4f8a-93a4-a44f3b35c46b:devops-component/activation/111-222-333/111111",
      // This is the component identifier provided by the provider
      "id": "1234"
    },
    "associatedWith": {
      // This is the Jira issue Atlassian Type Identifier (ATI)
      "ati": "ati:cloud:jira:issue",
      // This is the Jira issue Atlassian Resource Identifier (ARI) that was associated with the component. This should be in format: ari:cloud:jira:{siteId}:issue/{issueId}
      "ari": "ari:cloud:jira:f730ce9c-3442-4f8a-93a4-a44f3b35c46b:issue/1234"
      // This is the siteId
      "cloudId": "f730ce9c-3442-4f8a-93a4-a44f3b35c46b",
      // This is the Jira issue identifier
      "id": "1234"
    }
  }

Properties

templateUrl

Type	string
Format	uri-template
Required	Yes

onEntityDisassociated

Type

object

Description

Action to notify the component provider when a devops component has been disassociated from a Jira issue.

Example request

The templateUrl property of this action will receive a PUT request when this action is invoked. The entity.id is the providers external ID


  {
    "entity": {
      // This is the component Atlassian Resource Identifier (ARI). This should be in the format: ari:cloud:jira:{siteId}:devops-component/activation/{activationId}/{devOpsComponentId}
      "ari": "ari:cloud:jira:f730ce9c-3442-4f8a-93a4-a44f3b35c46b:devops-component/activation/111-222-333/111111",
      // This is the component identifier provided by the provider
      "id": "1234"
    },
    "disassociatedFrom": {
      // This is the Jira issue Atlassian Type Identifier (ATI)
      "ati": "ati:cloud:jira:issue",
      // This is the Jira issue Atlassian Resource Identifier (ARI) that was disassociated from the component. This should be in format: ari:cloud:jira:{siteId}:issue/{issueId}
      "ari": "ari:cloud:jira:f730ce9c-3442-4f8a-93a4-a44f3b35c46b:issue/1234"
      // This is the siteId
      "cloudId": "f730ce9c-3442-4f8a-93a4-a44f3b35c46b",
      // This is the Jira issue identifier
      "id": "1234"
    }
  }

Properties

templateUrl

Type	string
Format	uri-template
Required	Yes