Get issue extended configuration¶

GET /api/v5/orgs/{org}/issue/extend/settings

This endpoint returns the extended configuration of issues in the specified organization, including each issue type (such as requirement or consultation) and its status configuration.

Access token support¶

AtomGit user access tokens

Anonymous access¶

This endpoint does not allow anonymous access.

Request parameters¶

Parameter	Location	Type	Required	Description
`org`	path	string	Yes	Address path of the namespace that owns the repository (enterprise or organization path)
`access_token`	query	string	Yes	User authorization code

Response parameters¶

The response body is an array of objects. Each element represents one issue type and its status configuration.

Field	Type	Always returned	Nullable	Description
`type_name`	string	Yes	—	Type name, such as `Requirement` or `Consultation`
`type_id`	integer	Yes	—	Type ID
`type_desc`	string	Yes	—	Type description
`status`	object[]	Yes	—	List of status configurations for this type

status object

Field	Type	Always returned	Nullable	Description
`status.status_name`	string	Yes	—	Status name
`status.status_id`	integer	Yes	—	Status ID
`status.status_desc`	string	Yes	—	Status description
`status.gitcode_issue_status`	integer	Yes	—	GitCode issue status value

Error responses¶

This endpoint returns 401 when the request is unauthenticated or the access credentials are invalid.

401 Unauthenticated

{
  "error": "unauthorized",
  "message": "Missing or invalid access token"
}

Note: The actual error response field names are those returned by the backend.

HTTP response status codes¶

Status code	Description
`200`	Success (OK)
`401`	Requires authentication
`404`	The request path does not exist (Not found)
`500`	Internal system error (Internal server error)

Request example¶

Parameter description¶

Replace <org> with the organization path name (the address path of the enterprise or organization); replace <token> with your AtomGit user access token.

cURL¶

curl -X GET 'https://api.atomgit.com/api/v5/orgs/<org>/issue/extend/settings?access_token=<token>' \
  -H 'Accept: application/json'

JavaScript¶

// Native fetch (Node.js 18+ / browser)
const org = "<org>";
const token = "<token>";

const response = await fetch(
  `https://api.atomgit.com/api/v5/orgs/${org}/issue/extend/settings?access_token=${token}`,
  {
    headers: {
      "Accept": "application/json"
    }
  }
);

if (!response.ok) {
  throw new Error(`Request failed: ${response.status}`);
}

const data = await response.json();
console.log(data);

Python¶

import requests

org = "<org>"
token = "<token>"

resp = requests.get(
    f"https://api.atomgit.com/api/v5/orgs/{org}/issue/extend/settings",
    params={"access_token": token},
    headers={"Accept": "application/json"},
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

Response example¶

Status code: 200

[
  {
    "type_name": "Requirement",
    "type_id": 4,
    "type_desc": "Defines and describes the new features or improvements that need to be implemented in a product or project",
    "status": [
      {
        "status_name": "Not submitted",
        "status_id": 11,
        "status_desc": "The requirement has not been formally submitted; it is still in the concept or discussion stage and has not entered the system management workflow",
        "gitcode_issue_status": 0
      },
      {
        "status_name": "Fixing",
        "status_id": 20,
        "status_desc": "Problems were found while implementing the solution for the requirement, and fixing work is in progress",
        "gitcode_issue_status": 0
      }
    ]
  },
  {
    "type_name": "Consultation",
    "type_id": 36138,
    "type_desc": "",
    "status": [
      {
        "status_name": "Not submitted",
        "status_id": 11,
        "status_desc": "The requirement has not been formally submitted; it is still in the concept or discussion stage and has not entered the system management workflow",
        "gitcode_issue_status": 0
      },
      {
        "status_name": "Completed",
        "status_id": 14,
        "status_desc": "All work related to the requirement has finished, the results have been delivered, and it has entered the archived state",
        "gitcode_issue_status": 1
      }
    ]
  }
]

Error codes¶

Error code	Description
`401`	Unauthenticated or invalid credentials (missing/invalid access credentials)
`404`	The request path does not exist
`500`	Internal system error

Markdown source: View on AtomGit·Content from the open-source project gitcode-dev/atomgit-api-doc