Cloud

Jira Service Management ops / Reference / REST API

Other operations

Postman Collection

OpenAPI

Operations

GET/v1/jec/channels POST/v1/jec/channels GET/v1/jec/channels/{id}DEL/v1/jec/channels/{id}POST/v1/jec/action

GET

List JEC channelsExperimental

Lists JEC channels according to the provided filters.

The user should have view permission for JEC

OAuth 2.0 scopes required:

read:ops-config:jira-service-management

Request

Query parameters

ownerDomain

string

size

string

Responses

Returned if the request is successful

application/json

JecChannelList

GET/v1/jec/channels

curl

Node.js

Java

Python

PHP

curl --request GET \
  --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/jec/channels' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

200Response

{
  "links": {
    "next": "<string>"
  },
  "values": [
    {
      "id": "<string>",
      "name": "<string>",
      "ownerId": "<string>",
      "ownerDomain": "<string>",
      "authorAccountId": "<string>"
    }
  ]
}

POST

Create JEC ChannelExperimental

Create JEC Channel

OAuth 2.0 scopes required:

read:ops-config:jira-service-management

write:ops-config:jira-service-management

Request

Request bodyapplication/json

name

string

Required

ownerId

string

Required

ownerDomain

boolean

Required

Responses

Returned if the request is successful.

application/json

JecChannelWithApiKey

POST/v1/jec/channels

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/jec/channels' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "ownerId": "<string>",
  "ownerDomain": true
}'

200Response

{
  "id": "<string>",
  "name": "<string>",
  "ownerId": "<string>",
  "ownerDomain": "<string>",
  "authorAccountId": "<string>",
  "apiKey": "<string>"
}

GET

Get JEC channelExperimental

Returns JEC channel

OAuth 2.0 scopes required:

read:ops-config:jira-service-management

Request

Path parameters

string

Required

Responses

Returned if the request is successful.

application/json

JecChannelWithApiKey

GET/v1/jec/channels/{id}

curl

Node.js

Java

Python

PHP

curl --request GET \
  --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/jec/channels/{id}' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

200Response

{
  "id": "<string>",
  "name": "<string>",
  "ownerId": "<string>",
  "ownerDomain": "<string>",
  "authorAccountId": "<string>",
  "apiKey": "<string>"
}

DEL

Delete JEC channelExperimental

Delete JEC channel

OAuth 2.0 scopes required:

read:ops-config:jira-service-management

delete:ops-config:jira-service-management

Request

Path parameters

string

Required

Responses

Returned if the request is successful

DEL/v1/jec/channels/{id}

curl

Node.js

Java

Python

PHP

1
2
3

curl --request DELETE \
  --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/jec/channels/{id}' \
  --user 'email@example.com:<api_token>'

POST

Send JEC ActionExperimental

Send JEC Channel Action

OAuth 2.0 scopes required:

read:ops-config:jira-service-management

write:ops-config:jira-service-management

Request

Query parameters

channelId

string

Request bodyapplication/json

action

string

Required

actionType

string

Required

details

object

Responses

Returned if the request is successfully accepted.

POST/v1/jec/action

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/jec/action' \
  --user 'email@example.com:<api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "action": "<string>",
  "actionType": "<string>",
  "details": {}
}'