Gamma API

Update an issue schema

PATCH
/api/projects/{projectId}/issue-schemas/{schemaId}

A deleted schema is a 404.

Who may call it: Whoever manages the project: an owner, security admin or admin of its organization, or an admin of the project. API keys: no.

Authorization

session
cookiegamma.session_token<token>

The session cookie a sign-in sets. Over HTTPS its name carries the __Secure- prefix. Browsers send it on their own; other clients keep it from the sign-in response.

Path Parameters

projectId*string

The project's id.

schemaId*string

Request Body

application/json
  1. body
name?string
Length1 <= length <= 200
description?|null

Response Body

OK.

application/json
  1. response
schema*

The fields and category tree a project's issues are filed against.

Example Request
curl -X PATCH 'http://localhost:3000/api/projects/string/issue-schemas/string' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "schema": {    "id": "string",    "projectId": "string",    "name": "string",    "description": "string",    "fields": [      {        "id": "string",        "schemaId": "string",        "label": "string",        "type": "text",        "options": [          "string"        ],        "statuses": [          {            "name": "string",            "colorHex": "string",            "completion": "notStarted"          }        ],        "choices": null,        "multiple": true,        "scope": "members",        "role": "status",        "position": -9007199254740991      }    ],    "categories": [      {        "id": "string",        "schemaId": "string",        "parentId": "string",        "name": "string",        "requiredFieldIds": [          "string"        ]      }    ],    "issueCount": -9007199254740991,    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "deletedAt": "2019-08-24T14:15:22Z"  }}