Atlassian The Jira Cloud platform REST API — Screens

naftiko: 1.0.0-alpha2
info:
  label: Atlassian The Jira Cloud platform REST API — Screens
  description: 'Atlassian The Jira Cloud platform REST API — Screens. 7 operations. Lead operation: Atlassian Get Screens
    For A Field. Self-contained Naftiko capability covering one Atlassian business surface.'
  tags:
  - Atlassian
  - Screens
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ATLASSIAN_API_KEY: ATLASSIAN_API_KEY
capability:
  consumes:
  - type: http
    namespace: jira-screens
    baseUri: https://your-domain.atlassian.net
    description: Atlassian The Jira Cloud platform REST API — Screens business capability. Self-contained, no shared references.
    resources:
    - name: rest-api-3-field-fieldId-screens
      path: /rest/api/3/field/{fieldId}/screens
      operations:
      - name: atlassiangetscreensforfield
        method: GET
        description: Atlassian Get Screens For A Field
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: fieldId
          in: path
          type: string
          description: The ID of the field to return screens for.
          required: true
        - name: startAt
          in: query
          type: integer
          description: The index of the first item to return in a page of results (page offset).
        - name: maxResults
          in: query
          type: integer
          description: The maximum number of items to return per page.
        - name: expand
          in: query
          type: string
          description: Use [expand](#expansion) to include additional information about screens in the response. This parameter
            accepts `tab` which returns details about the screen ta
    - name: rest-api-3-screens
      path: /rest/api/3/screens
      operations:
      - name: atlassiangetscreens
        method: GET
        description: Atlassian Get Screens
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: startAt
          in: query
          type: integer
          description: The index of the first item to return in a page of results (page offset).
        - name: maxResults
          in: query
          type: integer
          description: The maximum number of items to return per page.
        - name: id
          in: query
          type: array
          description: The list of screen IDs. To include multiple IDs, provide an ampersand-separated list. For example,
            `id=10000&id=10001`.
        - name: queryString
          in: query
          type: string
          description: String used to perform a case-insensitive partial match with screen name.
        - name: scope
          in: query
          type: array
          description: The scope filter string. To filter by multiple scope, provide an ampersand-separated list. For example,
            `scope=GLOBAL&scope=PROJECT`.
        - name: orderBy
          in: query
          type: string
          description: '[Order](#ordering) the results by a field:'
      - name: atlassiancreatescreen
        method: POST
        description: Atlassian Create Screen
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-api-3-screens-addToDefault-fieldId
      path: /rest/api/3/screens/addToDefault/{fieldId}
      operations:
      - name: atlassianaddfieldtodefaultscreen
        method: POST
        description: Atlassian Add Field To Default Screen
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: fieldId
          in: path
          type: string
          description: The ID of the field.
          required: true
    - name: rest-api-3-screens-screenId
      path: /rest/api/3/screens/{screenId}
      operations:
      - name: atlassiandeletescreen
        method: DELETE
        description: Atlassian Delete Screen
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: screenId
          in: path
          type: integer
          description: The ID of the screen.
          required: true
      - name: atlassianupdatescreen
        method: PUT
        description: Atlassian Update Screen
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: screenId
          in: path
          type: integer
          description: The ID of the screen.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-api-3-screens-screenId-availableFields
      path: /rest/api/3/screens/{screenId}/availableFields
      operations:
      - name: atlassiangetavailablescreenfields
        method: GET
        description: Atlassian Get Available Screen Fields
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: screenId
          in: path
          type: integer
          description: The ID of the screen.
          required: true
    authentication:
      type: bearer
      token: '{{env.ATLASSIAN_API_KEY}}'
  exposes:
  - type: rest
    namespace: jira-screens-rest
    port: 8080
    description: REST adapter for Atlassian The Jira Cloud platform REST API — Screens. One Spectral-compliant resource per
      consumed operation, prefixed with /v1.
    resources:
    - path: /v1/api/3/field/{fieldid}/screens
      name: rest-api-3-field-fieldid-screens
      description: REST surface for rest-api-3-field-fieldId-screens.
      operations:
      - method: GET
        name: atlassiangetscreensforfield
        description: Atlassian Get Screens For A Field
        call: jira-screens.atlassiangetscreensforfield
        with:
          fieldId: rest.fieldId
          startAt: rest.startAt
          maxResults: rest.maxResults
          expand: rest.expand
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/screens
      name: rest-api-3-screens
      description: REST surface for rest-api-3-screens.
      operations:
      - method: GET
        name: atlassiangetscreens
        description: Atlassian Get Screens
        call: jira-screens.atlassiangetscreens
        with:
          startAt: rest.startAt
          maxResults: rest.maxResults
          id: rest.id
          queryString: rest.queryString
          scope: rest.scope
          orderBy: rest.orderBy
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: atlassiancreatescreen
        description: Atlassian Create Screen
        call: jira-screens.atlassiancreatescreen
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/screens/addtodefault/{fieldid}
      name: rest-api-3-screens-addtodefault-fieldid
      description: REST surface for rest-api-3-screens-addToDefault-fieldId.
      operations:
      - method: POST
        name: atlassianaddfieldtodefaultscreen
        description: Atlassian Add Field To Default Screen
        call: jira-screens.atlassianaddfieldtodefaultscreen
        with:
          fieldId: rest.fieldId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/screens/{screenid}
      name: rest-api-3-screens-screenid
      description: REST surface for rest-api-3-screens-screenId.
      operations:
      - method: DELETE
        name: atlassiandeletescreen
        description: Atlassian Delete Screen
        call: jira-screens.atlassiandeletescreen
        with:
          screenId: rest.screenId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: atlassianupdatescreen
        description: Atlassian Update Screen
        call: jira-screens.atlassianupdatescreen
        with:
          screenId: rest.screenId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/screens/{screenid}/availablefields
      name: rest-api-3-screens-screenid-availablefields
      description: REST surface for rest-api-3-screens-screenId-availableFields.
      operations:
      - method: GET
        name: atlassiangetavailablescreenfields
        description: Atlassian Get Available Screen Fields
        call: jira-screens.atlassiangetavailablescreenfields
        with:
          screenId: rest.screenId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: jira-screens-mcp
    port: 9090
    transport: http
    description: MCP adapter for Atlassian The Jira Cloud platform REST API — Screens. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: atlassian-get-screens-field
      description: Atlassian Get Screens For A Field
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: jira-screens.atlassiangetscreensforfield
      with:
        fieldId: tools.fieldId
        startAt: tools.startAt
        maxResults: tools.maxResults
        expand: tools.expand
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-get-screens
      description: Atlassian Get Screens
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: jira-screens.atlassiangetscreens
      with:
        startAt: tools.startAt
        maxResults: tools.maxResults
        id: tools.id
        queryString: tools.queryString
        scope: tools.scope
        orderBy: tools.orderBy
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-create-screen
      description: Atlassian Create Screen
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: jira-screens.atlassiancreatescreen
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-add-field-default-screen
      description: Atlassian Add Field To Default Screen
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: jira-screens.atlassianaddfieldtodefaultscreen
      with:
        fieldId: tools.fieldId
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-delete-screen
      description: Atlassian Delete Screen
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: jira-screens.atlassiandeletescreen
      with:
        screenId: tools.screenId
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-update-screen
      description: Atlassian Update Screen
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: jira-screens.atlassianupdatescreen
      with:
        screenId: tools.screenId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-get-available-screen-fields
      description: Atlassian Get Available Screen Fields
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: jira-screens.atlassiangetavailablescreenfields
      with:
        screenId: tools.screenId
      outputParameters:
      - type: object
        mapping: $.