Arc API documentation
Read programme context, work with branches and submit supported changes through Arc’s authenticated REST API. This reference uses the OpenAPI document from the Arc application.
API 1.0.0 · OpenAPI 3.1.0 · Source reviewed
Overview and supported capabilities
The document lists 15 operations for organisations, programmes, branches, model definitions, records, relationships, changes and pull requests. Each operation below preserves its parameters, request schema, response statuses and authentication requirements.
Choose the interface for the job. Use REST for a custom HTTP integration. Use MCP when a compatible assistant needs governed tools. Review AI processing before sharing sensitive records with an external assistant.
| Method | Path | Operation |
|---|---|---|
GET | /api/v1/public/organizations | Organizations |
GET | /api/v1/public/programs | Programs |
GET | /api/v1/public/programs/{program_id}/branches | Branches |
POST | /api/v1/public/programs/{program_id}/branches | Public Branch Create |
GET | /api/v1/public/programs/{program_id}/branches/{branch_id}/model | Model |
GET | /api/v1/public/programs/{program_id}/branches/{branch_id}/items | Items |
GET | /api/v1/public/programs/{program_id}/branches/{branch_id}/items/{item_id} | Item |
GET | /api/v1/public/programs/{program_id}/branches/{branch_id}/relationships | Relationships |
POST | /api/v1/public/programs/{program_id}/branches/{branch_id}/changes | Public Change Create |
POST | /api/v1/public/programs/{program_id}/branches/{branch_id}/changes/preview | Public Change Preview |
POST | /api/v1/public/programs/{program_id}/pull-requests | Public Pull Request Create |
GET | /api/v1/public/programs/{program_id}/pull-requests | Public Pull Requests |
GET | /api/v1/public/programs/{program_id}/pull-requests/{request_id} | Public Pull Request Detail |
POST | /api/v1/public/programs/{program_id}/pull-requests/{request_id}/merge | Public Pull Request Merge |
POST | /api/v1/public/programs/{program_id}/pull-requests/{request_id}/close | Public Pull Request Close |
Quick start and authentication
Use a Cognito access token or a programme token with BearerAuth. The source requires {ARC_API_RESOURCE}/read for GET requests and {ARC_API_RESOURCE}/write for POST requests. Programme tokens created in Program Settings have read or write access. Both credential types require current Arc membership and programme permissions.
The resource identifier in these scope names is a source placeholder. Confirm your deployment’s token setup and minimum access before implementing a client. Keep credentials in an approved secret store, outside URLs, logs and examples.
Most programme operations declare the optional X-Arc-Organization-Id UUID header. Required programme and branch identifiers belong in the documented path parameters. Change requests also require expected_head_revision.
{
"BearerAuth": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT or opaque Arc token"
}
}Programmes, branches and model definitions
List accessible organisations and programmes, then select an explicit programme and branch. Branch creation uses BranchCreate: name and source_branch_id are required. source_revision is optional and may be null.
The model endpoint returns PublicModelDefinitions, including the branch revision, item types, field definitions and relationship types. Use the actual IDs supplied by that model.
Field-definition changes support custom fields for existing item types. The reference provides no operation for creating item or relationship types. Model flexibility does not establish arbitrary type creation.
Records, relationships and pagination
Item and relationship reads can select a nonnegative revision. List operations declare limit from 1 to 100, default 50, and an optional cursor with a maximum length of 2048. Use the returned pagination fields shown in the page schemas.
Item filters include type_key, identifier and q. Relationship filters include type_key and item_id. The operation tables preserve each filter’s type and bounds.
Change preview, application and revisions
Preview and change creation both accept PublicChangeRequest. Its required fields are title and a nonnegative expected_head_revision. Supported change arrays include field_definitions, items and relationships.
In this source, documents, agents, test_cycles and test_runs each have maxItems: 0. Nonempty writes to these arrays are excluded. Their component schemas remain in the reference for source fidelity.
ItemChange includes nullable document_associations. The document does not provide an upload endpoint. A schema association does not establish a file-upload workflow.
The preview response includes current_revision, projected_revision, diff, impacts, graph and effects. Inspect that context before preparing a change. If the branch revision changes, retrieve current context and review the proposal again.
Pull requests and review
Create a pull request using PullRequestCreate. It requires source and target branch IDs, a title and a description. Reviewer IDs are optional. The document also includes list, detail, merge and close operations.
Merge requests require PullRequestRevision with both source_revision and target_revision. Inspect current revisions and the programme’s review requirements before a permitted merge. Engineering acceptance stays with the responsible reviewers.
Errors, conflicts and recovery
| Status | Source description |
|---|---|
401 | Authentication is required or the credential is invalid. |
403 | The principal lacks required access. |
404 | The scoped resource was not found. |
409 | The request conflicts with current state. |
422 | The request is invalid. |
429 | Rate limit exceeded. |
500 | Unexpected server error. |
503 | Authentication service unavailable. |
Error responses use PublicApiError. code and message are required. Revision and conflict fields are optional and nullable. The source describes response shapes but supplies no executed error examples or retry guarantees.
Check the returned error before retrying. Re-read and re-preview stale revisions. After an uncertain write outcome, inspect the current record and history before sending the same change again.
Worked examples
The sequence below is an illustrative integration workflow, not an executed connector or a ready-to-run payload. The source contains no example requests or responses.
- Read the selected programme, branch and model definitions.
- Resolve the actual item, field and relationship IDs.
- Prepare a supported change against the expected branch revision and inspect its preview.
- Apply only authorised changes and prepare a pull request for engineering review.
OpenAPI specification, version and release notes
This snapshot is Arc Public API, version 1.0.0, using OpenAPI 3.1.0. It was read from the application documentation on 21 October 2026. Download the same OpenAPI document.
The source lists http://api.archelps.com as its server. Confirm the supported HTTPS endpoint with Arc before sending credentials. This page provides reference definitions without executing API requests.
The backend source revision and matching-deployment example validation have not been established for this snapshot. The document supplies no release history.
SHA-256 of the JSON download: aec7ffbdbb9ba58403e14a9d7572af3cd5bbf3e6858bd117ca035a41b7cccca7
Operation reference
Complete definitions from the captured OpenAPI document. Expand an operation’s source definition to inspect all fields, headers and schema references.
Organizations
GET/api/v1/public/organizations
| Parameter | Location | Required | Type | Constraints |
|---|---|---|---|---|
limit | query | Optional | integer | minimum: 1maximum: 100default: 50 |
cursor | query | Optional | anyOf (string | null) | No additional constraint specified |
No request body declared.
| Status | Description | Response schema |
|---|---|---|
200 | Successful Response | application/json: OrganizationPage |
401 | Authentication is required or the credential is invalid. | application/json: PublicApiError |
403 | The principal lacks required access. | application/json: PublicApiError |
404 | The scoped resource was not found. | application/json: PublicApiError |
409 | The request conflicts with current state. | application/json: PublicApiError |
422 | The request is invalid. | application/json: PublicApiError |
429 | Rate limit exceeded. | application/json: PublicApiError |
500 | Unexpected server error. | application/json: PublicApiError |
503 | Authentication service unavailable. | application/json: PublicApiError |
Complete operation definition
{
"tags": [
"public API"
],
"summary": "Organizations",
"operationId": "organizations_public_organizations_get",
"parameters": [
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"default": 50,
"title": "Limit"
}
},
{
"name": "cursor",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
],
"title": "Cursor"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrganizationPage"
}
}
}
},
"401": {
"description": "Authentication is required or the credential is invalid.",
"headers": {
"WWW-Authenticate": {
"description": "Bearer authentication challenge.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"403": {
"description": "The principal lacks required access.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"404": {
"description": "The scoped resource was not found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"409": {
"description": "The request conflicts with current state.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"422": {
"description": "The request is invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"Retry-After": {
"description": "Seconds to wait before another request.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"500": {
"description": "Unexpected server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"503": {
"description": "Authentication service unavailable.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
],
"x-required-scope": "read"
}Programs
GET/api/v1/public/programs
| Parameter | Location | Required | Type | Constraints |
|---|---|---|---|---|
limit | query | Optional | integer | minimum: 1maximum: 100default: 50 |
cursor | query | Optional | anyOf (string | null) | No additional constraint specified |
X-Arc-Organization-Id | header | Optional | string | format: uuid |
No request body declared.
| Status | Description | Response schema |
|---|---|---|
200 | Successful Response | application/json: ProgramPage |
401 | Authentication is required or the credential is invalid. | application/json: PublicApiError |
403 | The principal lacks required access. | application/json: PublicApiError |
404 | The scoped resource was not found. | application/json: PublicApiError |
409 | The request conflicts with current state. | application/json: PublicApiError |
422 | The request is invalid. | application/json: PublicApiError |
429 | Rate limit exceeded. | application/json: PublicApiError |
500 | Unexpected server error. | application/json: PublicApiError |
503 | Authentication service unavailable. | application/json: PublicApiError |
Complete operation definition
{
"tags": [
"public API"
],
"summary": "Programs",
"operationId": "programs_public_programs_get",
"parameters": [
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"default": 50,
"title": "Limit"
}
},
{
"name": "cursor",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
{
"name": "X-Arc-Organization-Id",
"in": "header",
"required": false,
"description": "For Cognito credentials, required when the account has multiple Organizations and omitted when it has exactly one. Program tokens select their bound Organization automatically.",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProgramPage"
}
}
}
},
"401": {
"description": "Authentication is required or the credential is invalid.",
"headers": {
"WWW-Authenticate": {
"description": "Bearer authentication challenge.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"403": {
"description": "The principal lacks required access.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"404": {
"description": "The scoped resource was not found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"409": {
"description": "The request conflicts with current state.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"422": {
"description": "The request is invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"Retry-After": {
"description": "Seconds to wait before another request.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"500": {
"description": "Unexpected server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"503": {
"description": "Authentication service unavailable.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
],
"x-required-scope": "read"
}Branches
GET/api/v1/public/programs/{program_id}/branches
| Parameter | Location | Required | Type | Constraints |
|---|---|---|---|---|
program_id | path | Required | string | format: uuid |
limit | query | Optional | integer | minimum: 1maximum: 100default: 50 |
cursor | query | Optional | anyOf (string | null) | No additional constraint specified |
X-Arc-Organization-Id | header | Optional | string | format: uuid |
No request body declared.
| Status | Description | Response schema |
|---|---|---|
200 | Successful Response | application/json: BranchPage |
401 | Authentication is required or the credential is invalid. | application/json: PublicApiError |
403 | The principal lacks required access. | application/json: PublicApiError |
404 | The scoped resource was not found. | application/json: PublicApiError |
409 | The request conflicts with current state. | application/json: PublicApiError |
422 | The request is invalid. | application/json: PublicApiError |
429 | Rate limit exceeded. | application/json: PublicApiError |
500 | Unexpected server error. | application/json: PublicApiError |
503 | Authentication service unavailable. | application/json: PublicApiError |
Complete operation definition
{
"tags": [
"public API"
],
"summary": "Branches",
"operationId": "branches_public_programs__program_id__branches_get",
"parameters": [
{
"name": "program_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Program Id"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"default": 50,
"title": "Limit"
}
},
{
"name": "cursor",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
{
"name": "X-Arc-Organization-Id",
"in": "header",
"required": false,
"description": "For Cognito credentials, required when the account has multiple Organizations and omitted when it has exactly one. Program tokens select their bound Organization automatically.",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BranchPage"
}
}
}
},
"401": {
"description": "Authentication is required or the credential is invalid.",
"headers": {
"WWW-Authenticate": {
"description": "Bearer authentication challenge.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"403": {
"description": "The principal lacks required access.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"404": {
"description": "The scoped resource was not found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"409": {
"description": "The request conflicts with current state.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"422": {
"description": "The request is invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"Retry-After": {
"description": "Seconds to wait before another request.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"500": {
"description": "Unexpected server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"503": {
"description": "Authentication service unavailable.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
],
"x-required-scope": "read"
}Public Branch Create
POST/api/v1/public/programs/{program_id}/branches
| Parameter | Location | Required | Type | Constraints |
|---|---|---|---|---|
program_id | path | Required | string | format: uuid |
X-Arc-Organization-Id | header | Optional | string | format: uuid |
Request body: required application/json using BranchCreate.
| Status | Description | Response schema |
|---|---|---|
201 | Successful Response | application/json: BranchRecord |
401 | Authentication is required or the credential is invalid. | application/json: PublicApiError |
403 | The principal lacks required access. | application/json: PublicApiError |
404 | The scoped resource was not found. | application/json: PublicApiError |
409 | The request conflicts with current state. | application/json: PublicApiError |
422 | The request is invalid. | application/json: PublicApiError |
429 | Rate limit exceeded. | application/json: PublicApiError |
500 | Unexpected server error. | application/json: PublicApiError |
503 | Authentication service unavailable. | application/json: PublicApiError |
Complete operation definition
{
"tags": [
"public API"
],
"summary": "Public Branch Create",
"operationId": "public_branch_create_public_programs__program_id__branches_post",
"parameters": [
{
"name": "program_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Program Id"
}
},
{
"name": "X-Arc-Organization-Id",
"in": "header",
"required": false,
"description": "For Cognito credentials, required when the account has multiple Organizations and omitted when it has exactly one. Program tokens select their bound Organization automatically.",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BranchCreate"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BranchRecord"
}
}
}
},
"401": {
"description": "Authentication is required or the credential is invalid.",
"headers": {
"WWW-Authenticate": {
"description": "Bearer authentication challenge.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"403": {
"description": "The principal lacks required access.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"404": {
"description": "The scoped resource was not found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"409": {
"description": "The request conflicts with current state.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"422": {
"description": "The request is invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"Retry-After": {
"description": "Seconds to wait before another request.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"500": {
"description": "Unexpected server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"503": {
"description": "Authentication service unavailable.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
],
"x-required-scope": "write"
}Model
GET/api/v1/public/programs/{program_id}/branches/{branch_id}/model
| Parameter | Location | Required | Type | Constraints |
|---|---|---|---|---|
program_id | path | Required | string | format: uuid |
branch_id | path | Required | string | format: uuid |
revision | query | Optional | anyOf (integer | null) | No additional constraint specified |
X-Arc-Organization-Id | header | Optional | string | format: uuid |
No request body declared.
| Status | Description | Response schema |
|---|---|---|
200 | Successful Response | application/json: PublicModelDefinitions |
401 | Authentication is required or the credential is invalid. | application/json: PublicApiError |
403 | The principal lacks required access. | application/json: PublicApiError |
404 | The scoped resource was not found. | application/json: PublicApiError |
409 | The request conflicts with current state. | application/json: PublicApiError |
422 | The request is invalid. | application/json: PublicApiError |
429 | Rate limit exceeded. | application/json: PublicApiError |
500 | Unexpected server error. | application/json: PublicApiError |
503 | Authentication service unavailable. | application/json: PublicApiError |
Complete operation definition
{
"tags": [
"public API"
],
"summary": "Model",
"operationId": "model_public_programs__program_id__branches__branch_id__model_get",
"parameters": [
{
"name": "program_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Program Id"
}
},
{
"name": "branch_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Branch Id"
}
},
{
"name": "revision",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer",
"minimum": 0
},
{
"type": "null"
}
],
"title": "Revision"
}
},
{
"name": "X-Arc-Organization-Id",
"in": "header",
"required": false,
"description": "For Cognito credentials, required when the account has multiple Organizations and omitted when it has exactly one. Program tokens select their bound Organization automatically.",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicModelDefinitions"
}
}
}
},
"401": {
"description": "Authentication is required or the credential is invalid.",
"headers": {
"WWW-Authenticate": {
"description": "Bearer authentication challenge.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"403": {
"description": "The principal lacks required access.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"404": {
"description": "The scoped resource was not found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"409": {
"description": "The request conflicts with current state.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"422": {
"description": "The request is invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"Retry-After": {
"description": "Seconds to wait before another request.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"500": {
"description": "Unexpected server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"503": {
"description": "Authentication service unavailable.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
],
"x-required-scope": "read"
}Items
GET/api/v1/public/programs/{program_id}/branches/{branch_id}/items
| Parameter | Location | Required | Type | Constraints |
|---|---|---|---|---|
program_id | path | Required | string | format: uuid |
branch_id | path | Required | string | format: uuid |
limit | query | Optional | integer | minimum: 1maximum: 100default: 50 |
cursor | query | Optional | anyOf (string | null) | No additional constraint specified |
revision | query | Optional | anyOf (integer | null) | No additional constraint specified |
type_key | query | Optional | anyOf (string | null) | No additional constraint specified |
identifier | query | Optional | anyOf (string | null) | No additional constraint specified |
q | query | Optional | anyOf (string | null) | No additional constraint specified |
X-Arc-Organization-Id | header | Optional | string | format: uuid |
No request body declared.
| Status | Description | Response schema |
|---|---|---|
200 | Successful Response | application/json: PublicItemPage |
401 | Authentication is required or the credential is invalid. | application/json: PublicApiError |
403 | The principal lacks required access. | application/json: PublicApiError |
404 | The scoped resource was not found. | application/json: PublicApiError |
409 | The request conflicts with current state. | application/json: PublicApiError |
422 | The request is invalid. | application/json: PublicApiError |
429 | Rate limit exceeded. | application/json: PublicApiError |
500 | Unexpected server error. | application/json: PublicApiError |
503 | Authentication service unavailable. | application/json: PublicApiError |
Complete operation definition
{
"tags": [
"public API"
],
"summary": "Items",
"operationId": "items_public_programs__program_id__branches__branch_id__items_get",
"parameters": [
{
"name": "program_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Program Id"
}
},
{
"name": "branch_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Branch Id"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"default": 50,
"title": "Limit"
}
},
{
"name": "cursor",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
{
"name": "revision",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer",
"minimum": 0
},
{
"type": "null"
}
],
"title": "Revision"
}
},
{
"name": "type_key",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"type": "null"
}
],
"title": "Type Key"
}
},
{
"name": "identifier",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "null"
}
],
"title": "Identifier"
}
},
{
"name": "q",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"maxLength": 120
},
{
"type": "null"
}
],
"title": "Q"
}
},
{
"name": "X-Arc-Organization-Id",
"in": "header",
"required": false,
"description": "For Cognito credentials, required when the account has multiple Organizations and omitted when it has exactly one. Program tokens select their bound Organization automatically.",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicItemPage"
}
}
}
},
"401": {
"description": "Authentication is required or the credential is invalid.",
"headers": {
"WWW-Authenticate": {
"description": "Bearer authentication challenge.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"403": {
"description": "The principal lacks required access.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"404": {
"description": "The scoped resource was not found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"409": {
"description": "The request conflicts with current state.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"422": {
"description": "The request is invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"Retry-After": {
"description": "Seconds to wait before another request.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"500": {
"description": "Unexpected server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"503": {
"description": "Authentication service unavailable.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
],
"x-required-scope": "read"
}Item
GET/api/v1/public/programs/{program_id}/branches/{branch_id}/items/{item_id}
| Parameter | Location | Required | Type | Constraints |
|---|---|---|---|---|
program_id | path | Required | string | format: uuid |
branch_id | path | Required | string | format: uuid |
item_id | path | Required | string | format: uuid |
revision | query | Optional | anyOf (integer | null) | No additional constraint specified |
X-Arc-Organization-Id | header | Optional | string | format: uuid |
No request body declared.
| Status | Description | Response schema |
|---|---|---|
200 | Successful Response | application/json: PublicItemDetail |
401 | Authentication is required or the credential is invalid. | application/json: PublicApiError |
403 | The principal lacks required access. | application/json: PublicApiError |
404 | The scoped resource was not found. | application/json: PublicApiError |
409 | The request conflicts with current state. | application/json: PublicApiError |
422 | The request is invalid. | application/json: PublicApiError |
429 | Rate limit exceeded. | application/json: PublicApiError |
500 | Unexpected server error. | application/json: PublicApiError |
503 | Authentication service unavailable. | application/json: PublicApiError |
Complete operation definition
{
"tags": [
"public API"
],
"summary": "Item",
"operationId": "item_public_programs__program_id__branches__branch_id__items__item_id__get",
"parameters": [
{
"name": "program_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Program Id"
}
},
{
"name": "branch_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Branch Id"
}
},
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Item Id"
}
},
{
"name": "revision",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer",
"minimum": 0
},
{
"type": "null"
}
],
"title": "Revision"
}
},
{
"name": "X-Arc-Organization-Id",
"in": "header",
"required": false,
"description": "For Cognito credentials, required when the account has multiple Organizations and omitted when it has exactly one. Program tokens select their bound Organization automatically.",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicItemDetail"
}
}
}
},
"401": {
"description": "Authentication is required or the credential is invalid.",
"headers": {
"WWW-Authenticate": {
"description": "Bearer authentication challenge.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"403": {
"description": "The principal lacks required access.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"404": {
"description": "The scoped resource was not found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"409": {
"description": "The request conflicts with current state.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"422": {
"description": "The request is invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"Retry-After": {
"description": "Seconds to wait before another request.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"500": {
"description": "Unexpected server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"503": {
"description": "Authentication service unavailable.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
],
"x-required-scope": "read"
}Relationships
GET/api/v1/public/programs/{program_id}/branches/{branch_id}/relationships
| Parameter | Location | Required | Type | Constraints |
|---|---|---|---|---|
program_id | path | Required | string | format: uuid |
branch_id | path | Required | string | format: uuid |
limit | query | Optional | integer | minimum: 1maximum: 100default: 50 |
cursor | query | Optional | anyOf (string | null) | No additional constraint specified |
revision | query | Optional | anyOf (integer | null) | No additional constraint specified |
type_key | query | Optional | anyOf (string | null) | No additional constraint specified |
item_id | query | Optional | anyOf (string | null) | No additional constraint specified |
X-Arc-Organization-Id | header | Optional | string | format: uuid |
No request body declared.
| Status | Description | Response schema |
|---|---|---|
200 | Successful Response | application/json: PublicRelationshipPage |
401 | Authentication is required or the credential is invalid. | application/json: PublicApiError |
403 | The principal lacks required access. | application/json: PublicApiError |
404 | The scoped resource was not found. | application/json: PublicApiError |
409 | The request conflicts with current state. | application/json: PublicApiError |
422 | The request is invalid. | application/json: PublicApiError |
429 | Rate limit exceeded. | application/json: PublicApiError |
500 | Unexpected server error. | application/json: PublicApiError |
503 | Authentication service unavailable. | application/json: PublicApiError |
Complete operation definition
{
"tags": [
"public API"
],
"summary": "Relationships",
"operationId": "relationships_public_programs__program_id__branches__branch_id__relationships_get",
"parameters": [
{
"name": "program_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Program Id"
}
},
{
"name": "branch_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Branch Id"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"default": 50,
"title": "Limit"
}
},
{
"name": "cursor",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
{
"name": "revision",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer",
"minimum": 0
},
{
"type": "null"
}
],
"title": "Revision"
}
},
{
"name": "type_key",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"type": "null"
}
],
"title": "Type Key"
}
},
{
"name": "item_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Item Id"
}
},
{
"name": "X-Arc-Organization-Id",
"in": "header",
"required": false,
"description": "For Cognito credentials, required when the account has multiple Organizations and omitted when it has exactly one. Program tokens select their bound Organization automatically.",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicRelationshipPage"
}
}
}
},
"401": {
"description": "Authentication is required or the credential is invalid.",
"headers": {
"WWW-Authenticate": {
"description": "Bearer authentication challenge.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"403": {
"description": "The principal lacks required access.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"404": {
"description": "The scoped resource was not found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"409": {
"description": "The request conflicts with current state.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"422": {
"description": "The request is invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"Retry-After": {
"description": "Seconds to wait before another request.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"500": {
"description": "Unexpected server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"503": {
"description": "Authentication service unavailable.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
],
"x-required-scope": "read"
}Public Change Create
POST/api/v1/public/programs/{program_id}/branches/{branch_id}/changes
| Parameter | Location | Required | Type | Constraints |
|---|---|---|---|---|
program_id | path | Required | string | format: uuid |
branch_id | path | Required | string | format: uuid |
X-Arc-Organization-Id | header | Optional | string | format: uuid |
Request body: required application/json using PublicChangeRequest.
| Status | Description | Response schema |
|---|---|---|
201 | Successful Response | application/json: PublicChange |
401 | Authentication is required or the credential is invalid. | application/json: PublicApiError |
403 | The principal lacks required access. | application/json: PublicApiError |
404 | The scoped resource was not found. | application/json: PublicApiError |
409 | The request conflicts with current state. | application/json: PublicApiError |
422 | The request is invalid. | application/json: PublicApiError |
429 | Rate limit exceeded. | application/json: PublicApiError |
500 | Unexpected server error. | application/json: PublicApiError |
503 | Authentication service unavailable. | application/json: PublicApiError |
Complete operation definition
{
"tags": [
"public API"
],
"summary": "Public Change Create",
"operationId": "public_change_create_public_programs__program_id__branches__branch_id__changes_post",
"parameters": [
{
"name": "program_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Program Id"
}
},
{
"name": "branch_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Branch Id"
}
},
{
"name": "X-Arc-Organization-Id",
"in": "header",
"required": false,
"description": "For Cognito credentials, required when the account has multiple Organizations and omitted when it has exactly one. Program tokens select their bound Organization automatically.",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicChangeRequest"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicChange"
}
}
}
},
"401": {
"description": "Authentication is required or the credential is invalid.",
"headers": {
"WWW-Authenticate": {
"description": "Bearer authentication challenge.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"403": {
"description": "The principal lacks required access.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"404": {
"description": "The scoped resource was not found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"409": {
"description": "The request conflicts with current state.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"422": {
"description": "The request is invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"Retry-After": {
"description": "Seconds to wait before another request.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"500": {
"description": "Unexpected server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"503": {
"description": "Authentication service unavailable.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
],
"x-required-scope": "write"
}Public Change Preview
POST/api/v1/public/programs/{program_id}/branches/{branch_id}/changes/preview
| Parameter | Location | Required | Type | Constraints |
|---|---|---|---|---|
program_id | path | Required | string | format: uuid |
branch_id | path | Required | string | format: uuid |
X-Arc-Organization-Id | header | Optional | string | format: uuid |
Request body: required application/json using PublicChangeRequest.
| Status | Description | Response schema |
|---|---|---|
200 | Successful Response | application/json: PublicChangePreview |
401 | Authentication is required or the credential is invalid. | application/json: PublicApiError |
403 | The principal lacks required access. | application/json: PublicApiError |
404 | The scoped resource was not found. | application/json: PublicApiError |
409 | The request conflicts with current state. | application/json: PublicApiError |
422 | The request is invalid. | application/json: PublicApiError |
429 | Rate limit exceeded. | application/json: PublicApiError |
500 | Unexpected server error. | application/json: PublicApiError |
503 | Authentication service unavailable. | application/json: PublicApiError |
Complete operation definition
{
"tags": [
"public API"
],
"summary": "Public Change Preview",
"operationId": "public_change_preview_public_programs__program_id__branches__branch_id__changes_preview_post",
"parameters": [
{
"name": "program_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Program Id"
}
},
{
"name": "branch_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Branch Id"
}
},
{
"name": "X-Arc-Organization-Id",
"in": "header",
"required": false,
"description": "For Cognito credentials, required when the account has multiple Organizations and omitted when it has exactly one. Program tokens select their bound Organization automatically.",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicChangeRequest"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicChangePreview"
}
}
}
},
"401": {
"description": "Authentication is required or the credential is invalid.",
"headers": {
"WWW-Authenticate": {
"description": "Bearer authentication challenge.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"403": {
"description": "The principal lacks required access.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"404": {
"description": "The scoped resource was not found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"409": {
"description": "The request conflicts with current state.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"422": {
"description": "The request is invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"Retry-After": {
"description": "Seconds to wait before another request.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"500": {
"description": "Unexpected server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"503": {
"description": "Authentication service unavailable.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
],
"x-required-scope": "write"
}Public Pull Request Create
POST/api/v1/public/programs/{program_id}/pull-requests
| Parameter | Location | Required | Type | Constraints |
|---|---|---|---|---|
program_id | path | Required | string | format: uuid |
X-Arc-Organization-Id | header | Optional | string | format: uuid |
Request body: required application/json using PullRequestCreate.
| Status | Description | Response schema |
|---|---|---|
201 | Successful Response | application/json: PublicPullRequest |
401 | Authentication is required or the credential is invalid. | application/json: PublicApiError |
403 | The principal lacks required access. | application/json: PublicApiError |
404 | The scoped resource was not found. | application/json: PublicApiError |
409 | The request conflicts with current state. | application/json: PublicApiError |
422 | The request is invalid. | application/json: PublicApiError |
429 | Rate limit exceeded. | application/json: PublicApiError |
500 | Unexpected server error. | application/json: PublicApiError |
503 | Authentication service unavailable. | application/json: PublicApiError |
Complete operation definition
{
"tags": [
"public API"
],
"summary": "Public Pull Request Create",
"operationId": "public_pull_request_create_public_programs__program_id__pull_requests_post",
"parameters": [
{
"name": "program_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Program Id"
}
},
{
"name": "X-Arc-Organization-Id",
"in": "header",
"required": false,
"description": "For Cognito credentials, required when the account has multiple Organizations and omitted when it has exactly one. Program tokens select their bound Organization automatically.",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PullRequestCreate"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicPullRequest"
}
}
}
},
"401": {
"description": "Authentication is required or the credential is invalid.",
"headers": {
"WWW-Authenticate": {
"description": "Bearer authentication challenge.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"403": {
"description": "The principal lacks required access.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"404": {
"description": "The scoped resource was not found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"409": {
"description": "The request conflicts with current state.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"422": {
"description": "The request is invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"Retry-After": {
"description": "Seconds to wait before another request.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"500": {
"description": "Unexpected server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"503": {
"description": "Authentication service unavailable.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
],
"x-required-scope": "write"
}Public Pull Requests
GET/api/v1/public/programs/{program_id}/pull-requests
| Parameter | Location | Required | Type | Constraints |
|---|---|---|---|---|
program_id | path | Required | string | format: uuid |
limit | query | Optional | integer | minimum: 1maximum: 100default: 50 |
cursor | query | Optional | anyOf (string | null) | No additional constraint specified |
X-Arc-Organization-Id | header | Optional | string | format: uuid |
No request body declared.
| Status | Description | Response schema |
|---|---|---|
200 | Successful Response | application/json: PublicPullRequestPage |
401 | Authentication is required or the credential is invalid. | application/json: PublicApiError |
403 | The principal lacks required access. | application/json: PublicApiError |
404 | The scoped resource was not found. | application/json: PublicApiError |
409 | The request conflicts with current state. | application/json: PublicApiError |
422 | The request is invalid. | application/json: PublicApiError |
429 | Rate limit exceeded. | application/json: PublicApiError |
500 | Unexpected server error. | application/json: PublicApiError |
503 | Authentication service unavailable. | application/json: PublicApiError |
Complete operation definition
{
"tags": [
"public API"
],
"summary": "Public Pull Requests",
"operationId": "public_pull_requests_public_programs__program_id__pull_requests_get",
"parameters": [
{
"name": "program_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Program Id"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"default": 50,
"title": "Limit"
}
},
{
"name": "cursor",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
{
"name": "X-Arc-Organization-Id",
"in": "header",
"required": false,
"description": "For Cognito credentials, required when the account has multiple Organizations and omitted when it has exactly one. Program tokens select their bound Organization automatically.",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicPullRequestPage"
}
}
}
},
"401": {
"description": "Authentication is required or the credential is invalid.",
"headers": {
"WWW-Authenticate": {
"description": "Bearer authentication challenge.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"403": {
"description": "The principal lacks required access.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"404": {
"description": "The scoped resource was not found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"409": {
"description": "The request conflicts with current state.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"422": {
"description": "The request is invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"Retry-After": {
"description": "Seconds to wait before another request.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"500": {
"description": "Unexpected server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"503": {
"description": "Authentication service unavailable.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
],
"x-required-scope": "read"
}Public Pull Request Detail
GET/api/v1/public/programs/{program_id}/pull-requests/{request_id}
| Parameter | Location | Required | Type | Constraints |
|---|---|---|---|---|
program_id | path | Required | string | format: uuid |
request_id | path | Required | string | format: uuid |
X-Arc-Organization-Id | header | Optional | string | format: uuid |
No request body declared.
| Status | Description | Response schema |
|---|---|---|
200 | Successful Response | application/json: PublicPullRequestDetail |
401 | Authentication is required or the credential is invalid. | application/json: PublicApiError |
403 | The principal lacks required access. | application/json: PublicApiError |
404 | The scoped resource was not found. | application/json: PublicApiError |
409 | The request conflicts with current state. | application/json: PublicApiError |
422 | The request is invalid. | application/json: PublicApiError |
429 | Rate limit exceeded. | application/json: PublicApiError |
500 | Unexpected server error. | application/json: PublicApiError |
503 | Authentication service unavailable. | application/json: PublicApiError |
Complete operation definition
{
"tags": [
"public API"
],
"summary": "Public Pull Request Detail",
"operationId": "public_pull_request_detail_public_programs__program_id__pull_requests__request_id__get",
"parameters": [
{
"name": "program_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Program Id"
}
},
{
"name": "request_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Request Id"
}
},
{
"name": "X-Arc-Organization-Id",
"in": "header",
"required": false,
"description": "For Cognito credentials, required when the account has multiple Organizations and omitted when it has exactly one. Program tokens select their bound Organization automatically.",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicPullRequestDetail"
}
}
}
},
"401": {
"description": "Authentication is required or the credential is invalid.",
"headers": {
"WWW-Authenticate": {
"description": "Bearer authentication challenge.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"403": {
"description": "The principal lacks required access.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"404": {
"description": "The scoped resource was not found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"409": {
"description": "The request conflicts with current state.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"422": {
"description": "The request is invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"Retry-After": {
"description": "Seconds to wait before another request.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"500": {
"description": "Unexpected server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"503": {
"description": "Authentication service unavailable.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
],
"x-required-scope": "read"
}Public Pull Request Merge
POST/api/v1/public/programs/{program_id}/pull-requests/{request_id}/merge
| Parameter | Location | Required | Type | Constraints |
|---|---|---|---|---|
program_id | path | Required | string | format: uuid |
request_id | path | Required | string | format: uuid |
X-Arc-Organization-Id | header | Optional | string | format: uuid |
Request body: required application/json using PullRequestRevision.
| Status | Description | Response schema |
|---|---|---|
200 | Successful Response | application/json: PublicChange |
401 | Authentication is required or the credential is invalid. | application/json: PublicApiError |
403 | The principal lacks required access. | application/json: PublicApiError |
404 | The scoped resource was not found. | application/json: PublicApiError |
409 | The request conflicts with current state. | application/json: PublicApiError |
422 | The request is invalid. | application/json: PublicApiError |
429 | Rate limit exceeded. | application/json: PublicApiError |
500 | Unexpected server error. | application/json: PublicApiError |
503 | Authentication service unavailable. | application/json: PublicApiError |
Complete operation definition
{
"tags": [
"public API"
],
"summary": "Public Pull Request Merge",
"operationId": "public_pull_request_merge_public_programs__program_id__pull_requests__request_id__merge_post",
"parameters": [
{
"name": "program_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Program Id"
}
},
{
"name": "request_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Request Id"
}
},
{
"name": "X-Arc-Organization-Id",
"in": "header",
"required": false,
"description": "For Cognito credentials, required when the account has multiple Organizations and omitted when it has exactly one. Program tokens select their bound Organization automatically.",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PullRequestRevision"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicChange"
}
}
}
},
"401": {
"description": "Authentication is required or the credential is invalid.",
"headers": {
"WWW-Authenticate": {
"description": "Bearer authentication challenge.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"403": {
"description": "The principal lacks required access.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"404": {
"description": "The scoped resource was not found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"409": {
"description": "The request conflicts with current state.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"422": {
"description": "The request is invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"Retry-After": {
"description": "Seconds to wait before another request.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"500": {
"description": "Unexpected server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"503": {
"description": "Authentication service unavailable.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
],
"x-required-scope": "write"
}Public Pull Request Close
POST/api/v1/public/programs/{program_id}/pull-requests/{request_id}/close
| Parameter | Location | Required | Type | Constraints |
|---|---|---|---|---|
program_id | path | Required | string | format: uuid |
request_id | path | Required | string | format: uuid |
X-Arc-Organization-Id | header | Optional | string | format: uuid |
No request body declared.
| Status | Description | Response schema |
|---|---|---|
200 | Successful Response | application/json: PublicPullRequest |
401 | Authentication is required or the credential is invalid. | application/json: PublicApiError |
403 | The principal lacks required access. | application/json: PublicApiError |
404 | The scoped resource was not found. | application/json: PublicApiError |
409 | The request conflicts with current state. | application/json: PublicApiError |
422 | The request is invalid. | application/json: PublicApiError |
429 | Rate limit exceeded. | application/json: PublicApiError |
500 | Unexpected server error. | application/json: PublicApiError |
503 | Authentication service unavailable. | application/json: PublicApiError |
Complete operation definition
{
"tags": [
"public API"
],
"summary": "Public Pull Request Close",
"operationId": "public_pull_request_close_public_programs__program_id__pull_requests__request_id__close_post",
"parameters": [
{
"name": "program_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Program Id"
}
},
{
"name": "request_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Request Id"
}
},
{
"name": "X-Arc-Organization-Id",
"in": "header",
"required": false,
"description": "For Cognito credentials, required when the account has multiple Organizations and omitted when it has exactly one. Program tokens select their bound Organization automatically.",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicPullRequest"
}
}
}
},
"401": {
"description": "Authentication is required or the credential is invalid.",
"headers": {
"WWW-Authenticate": {
"description": "Bearer authentication challenge.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"403": {
"description": "The principal lacks required access.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"404": {
"description": "The scoped resource was not found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"409": {
"description": "The request conflicts with current state.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"422": {
"description": "The request is invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"Retry-After": {
"description": "Seconds to wait before another request.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"500": {
"description": "Unexpected server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
},
"503": {
"description": "Authentication service unavailable.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiError"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
],
"x-required-scope": "write"
}Schema reference
All 37 component schemas are included. Expand a schema to read its properties and complete JSON definition. Required fields, nullable alternatives and source constraints are preserved.
ActionAvailabilityobject
Object constraints: additionalProperties: true.
| Property | Required | Type | Constraints |
|---|---|---|---|
allowed | Required | boolean | No additional constraint specified |
reasons | Required | array of string | No additional constraint specified |
{
"properties": {
"allowed": {
"type": "boolean",
"title": "Allowed"
},
"reasons": {
"items": {
"type": "string"
},
"type": "array",
"title": "Reasons"
}
},
"additionalProperties": true,
"type": "object",
"required": [
"allowed",
"reasons"
],
"title": "ActionAvailability"
}AgentDefinitionChangeobject
Object constraints: additionalProperties: false.
| Property | Required | Type | Constraints |
|---|---|---|---|
id | Optional | anyOf (string | null) | No additional constraint specified |
name | Optional | anyOf (string | null) | No additional constraint specified |
instruction | Optional | anyOf (string | null) | No additional constraint specified |
trigger_item_type_ids | Optional | anyOf (array of string | null) | No additional constraint specified |
builtin_key | Optional | anyOf (string | null) | No additional constraint specified |
standards | Optional | array of string | No additional constraint specified |
enabled | Optional | boolean | default: true |
deleted | Optional | boolean | default: false |
{
"properties": {
"id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string",
"maxLength": 160,
"minLength": 1
},
{
"type": "null"
}
],
"title": "Name"
},
"instruction": {
"anyOf": [
{
"type": "string",
"maxLength": 20000
},
{
"type": "null"
}
],
"title": "Instruction"
},
"trigger_item_type_ids": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array",
"minItems": 1
},
{
"type": "null"
}
],
"title": "Trigger Item Type Ids"
},
"builtin_key": {
"anyOf": [
{
"type": "string",
"enum": [
"compliance",
"requirement_quality",
"impact"
]
},
{
"type": "null"
}
],
"title": "Builtin Key"
},
"standards": {
"items": {
"type": "string",
"enum": [
"ECSS",
"NASA",
"FAA"
]
},
"type": "array",
"title": "Standards"
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"default": true
},
"deleted": {
"type": "boolean",
"title": "Deleted",
"default": false
}
},
"additionalProperties": false,
"type": "object",
"title": "AgentDefinitionChange"
}BranchCreateobject
Object constraints: additionalProperties: false.
| Property | Required | Type | Constraints |
|---|---|---|---|
name | Required | string | minLength: 1maxLength: 120 |
description | Optional | string | default: |
source_branch_id | Required | string | format: uuid |
source_revision | Optional | anyOf (integer | null) | No additional constraint specified |
{
"properties": {
"name": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"title": "Name"
},
"description": {
"type": "string",
"title": "Description",
"default": ""
},
"source_branch_id": {
"type": "string",
"format": "uuid",
"title": "Source Branch Id"
},
"source_revision": {
"anyOf": [
{
"type": "integer",
"minimum": 0
},
{
"type": "null"
}
],
"title": "Source Revision"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"name",
"source_branch_id"
],
"title": "BranchCreate"
}BranchPageobject
Object constraints: additionalProperties: true.
| Property | Required | Type | Constraints |
|---|---|---|---|
data | Required | array of BranchSummary | No additional constraint specified |
next_cursor | Required | anyOf (string | null) | No additional constraint specified |
{
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/BranchSummary"
},
"type": "array",
"title": "Data"
},
"next_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Next Cursor"
}
},
"additionalProperties": true,
"type": "object",
"required": [
"data",
"next_cursor"
],
"title": "BranchPage"
}BranchRecordobject
Object constraints: additionalProperties: true.
| Property | Required | Type | Constraints |
|---|---|---|---|
id | Required | string | format: uuid |
organization_id | Required | string | format: uuid |
program_id | Required | string | format: uuid |
name | Required | string | No additional constraint specified |
color | Required | string | No additional constraint specified |
description | Required | string | No additional constraint specified |
pull_request_title | Required | anyOf (string | null) | No additional constraint specified |
summary_input_hash | Required | anyOf (string | null) | No additional constraint specified |
summary_user_edited | Required | boolean | No additional constraint specified |
status | Required | string | No additional constraint specified |
base_branch_id | Required | anyOf (string | null) | No additional constraint specified |
base_revision | Required | integer | No additional constraint specified |
head_revision | Required | integer | No additional constraint specified |
created_by | Required | string | No additional constraint specified |
owners | Required | array of object | No additional constraint specified |
created_at | Required | string | format: date-time |
updated_at | Required | string | format: date-time |
integrated_revision | Required | integer | No additional constraint specified |
actions | Required | object | additionalProperties: {"$ref":"#/components/schemas/ActionAvailability"} |
{
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"organization_id": {
"type": "string",
"format": "uuid",
"title": "Organization Id"
},
"program_id": {
"type": "string",
"format": "uuid",
"title": "Program Id"
},
"name": {
"type": "string",
"title": "Name"
},
"color": {
"type": "string",
"title": "Color"
},
"description": {
"type": "string",
"title": "Description"
},
"pull_request_title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pull Request Title"
},
"summary_input_hash": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary Input Hash"
},
"summary_user_edited": {
"type": "boolean",
"title": "Summary User Edited"
},
"status": {
"type": "string",
"title": "Status"
},
"base_branch_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Base Branch Id"
},
"base_revision": {
"type": "integer",
"title": "Base Revision"
},
"head_revision": {
"type": "integer",
"title": "Head Revision"
},
"created_by": {
"type": "string",
"title": "Created By"
},
"owners": {
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array",
"title": "Owners"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"updated_at": {
"type": "string",
"format": "date-time",
"title": "Updated At"
},
"integrated_revision": {
"type": "integer",
"title": "Integrated Revision"
},
"actions": {
"additionalProperties": {
"$ref": "#/components/schemas/ActionAvailability"
},
"type": "object",
"title": "Actions"
}
},
"additionalProperties": true,
"type": "object",
"required": [
"id",
"organization_id",
"program_id",
"name",
"color",
"description",
"pull_request_title",
"summary_input_hash",
"summary_user_edited",
"status",
"base_branch_id",
"base_revision",
"head_revision",
"created_by",
"owners",
"created_at",
"updated_at",
"integrated_revision",
"actions"
],
"title": "BranchRecord"
}BranchSummaryobject
Object constraints: additionalProperties: true.
| Property | Required | Type | Constraints |
|---|---|---|---|
id | Required | string | format: uuid |
organization_id | Required | string | format: uuid |
program_id | Required | string | format: uuid |
name | Required | string | No additional constraint specified |
color | Required | string | No additional constraint specified |
description | Required | string | No additional constraint specified |
pull_request_title | Required | anyOf (string | null) | No additional constraint specified |
summary_input_hash | Required | anyOf (string | null) | No additional constraint specified |
summary_user_edited | Required | boolean | No additional constraint specified |
status | Required | string | No additional constraint specified |
base_branch_id | Required | anyOf (string | null) | No additional constraint specified |
base_revision | Required | integer | No additional constraint specified |
head_revision | Required | integer | No additional constraint specified |
created_by | Required | string | No additional constraint specified |
owners | Required | array of object | No additional constraint specified |
created_at | Required | string | format: date-time |
updated_at | Required | string | format: date-time |
{
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"organization_id": {
"type": "string",
"format": "uuid",
"title": "Organization Id"
},
"program_id": {
"type": "string",
"format": "uuid",
"title": "Program Id"
},
"name": {
"type": "string",
"title": "Name"
},
"color": {
"type": "string",
"title": "Color"
},
"description": {
"type": "string",
"title": "Description"
},
"pull_request_title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pull Request Title"
},
"summary_input_hash": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary Input Hash"
},
"summary_user_edited": {
"type": "boolean",
"title": "Summary User Edited"
},
"status": {
"type": "string",
"title": "Status"
},
"base_branch_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Base Branch Id"
},
"base_revision": {
"type": "integer",
"title": "Base Revision"
},
"head_revision": {
"type": "integer",
"title": "Head Revision"
},
"created_by": {
"type": "string",
"title": "Created By"
},
"owners": {
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array",
"title": "Owners"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"updated_at": {
"type": "string",
"format": "date-time",
"title": "Updated At"
}
},
"additionalProperties": true,
"type": "object",
"required": [
"id",
"organization_id",
"program_id",
"name",
"color",
"description",
"pull_request_title",
"summary_input_hash",
"summary_user_edited",
"status",
"base_branch_id",
"base_revision",
"head_revision",
"created_by",
"owners",
"created_at",
"updated_at"
],
"title": "BranchSummary"
}DocumentChangeobject
Object constraints: additionalProperties: false.
| Property | Required | Type | Constraints |
|---|---|---|---|
id | Optional | anyOf (string | null) | No additional constraint specified |
title | Required | string | minLength: 1maxLength: 500 |
document_version_id | Required | string | format: uuid |
deleted | Optional | boolean | default: false |
{
"properties": {
"id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Id"
},
"title": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"title": "Title"
},
"document_version_id": {
"type": "string",
"format": "uuid",
"title": "Document Version Id"
},
"deleted": {
"type": "boolean",
"title": "Deleted",
"default": false
}
},
"additionalProperties": false,
"type": "object",
"required": [
"title",
"document_version_id"
],
"title": "DocumentChange"
}FieldDefinitionChangeobject
Object constraints: additionalProperties: false.
| Property | Required | Type | Constraints |
|---|---|---|---|
id | Optional | anyOf (string | null) | No additional constraint specified |
client_ref | Optional | anyOf (string | null) | No additional constraint specified |
item_type_id | Required | string | format: uuid |
name | Required | string | minLength: 1maxLength: 120 |
import_identifier | Optional | anyOf (string | null) | No additional constraint specified |
kind | Required | string | enum: ["short_text","long_text","number","boolean","date","enum","person"] |
config | Optional | object | additionalProperties: true |
archived | Optional | boolean | default: false |
deleted | Optional | boolean | default: false |
{
"properties": {
"id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Id"
},
"client_ref": {
"anyOf": [
{
"type": "string",
"maxLength": 120,
"minLength": 1
},
{
"type": "null"
}
],
"title": "Client Ref"
},
"item_type_id": {
"type": "string",
"format": "uuid",
"title": "Item Type Id"
},
"name": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"title": "Name"
},
"import_identifier": {
"anyOf": [
{
"type": "string",
"maxLength": 500,
"minLength": 1
},
{
"type": "null"
}
],
"title": "Import Identifier"
},
"kind": {
"type": "string",
"enum": [
"short_text",
"long_text",
"number",
"boolean",
"date",
"enum",
"person"
],
"title": "Kind"
},
"config": {
"additionalProperties": true,
"type": "object",
"title": "Config"
},
"archived": {
"type": "boolean",
"title": "Archived",
"default": false
},
"deleted": {
"type": "boolean",
"title": "Deleted",
"default": false
}
},
"additionalProperties": false,
"type": "object",
"required": [
"item_type_id",
"name",
"kind"
],
"title": "FieldDefinitionChange"
}ItemChangeobject
Object constraints: additionalProperties: false.
| Property | Required | Type | Constraints |
|---|---|---|---|
id | Optional | anyOf (string | null) | No additional constraint specified |
client_ref | Optional | anyOf (string | null) | No additional constraint specified |
item_type_id | Required | string | format: uuid |
name | Optional | anyOf (string | null) | No additional constraint specified |
import_identifier | Optional | anyOf (string | null) | No additional constraint specified |
status | Required | string | No additional constraint specified |
owner_ids | Optional | array of string | No additional constraint specified |
values | Optional | object | additionalProperties: true |
metadata | Optional | object | additionalProperties: true |
document_associations | Optional | anyOf (array of ItemDocumentAssociationChange | null) | No additional constraint specified |
deleted | Optional | boolean | default: false |
{
"properties": {
"id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Id"
},
"client_ref": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Client Ref"
},
"item_type_id": {
"type": "string",
"format": "uuid",
"title": "Item Type Id"
},
"name": {
"anyOf": [
{
"type": "string",
"maxLength": 500,
"minLength": 1
},
{
"type": "null"
}
],
"title": "Name"
},
"import_identifier": {
"anyOf": [
{
"type": "string",
"maxLength": 500,
"minLength": 1
},
{
"type": "null"
}
],
"title": "Import Identifier"
},
"status": {
"type": "string",
"title": "Status"
},
"owner_ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Owner Ids"
},
"values": {
"additionalProperties": true,
"type": "object",
"title": "Values"
},
"metadata": {
"additionalProperties": true,
"type": "object",
"title": "Metadata"
},
"document_associations": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ItemDocumentAssociationChange"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document Associations"
},
"deleted": {
"type": "boolean",
"title": "Deleted",
"default": false
}
},
"additionalProperties": false,
"type": "object",
"required": [
"item_type_id",
"status"
],
"title": "ItemChange"
}ItemDocumentAssociationChangeobject
Object constraints: additionalProperties: false.
| Property | Required | Type | Constraints |
|---|---|---|---|
id | Optional | anyOf (string | null) | No additional constraint specified |
document_id | Required | string | format: uuid |
document_version_id | Required | string | format: uuid |
role | Optional | string | default: referenceenum: ["source","rationale","reference"] |
locator | Optional | anyOf (string | null) | No additional constraint specified |
rationale | Optional | anyOf (string | null) | No additional constraint specified |
{
"properties": {
"id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Id"
},
"document_id": {
"type": "string",
"format": "uuid",
"title": "Document Id"
},
"document_version_id": {
"type": "string",
"format": "uuid",
"title": "Document Version Id"
},
"role": {
"type": "string",
"enum": [
"source",
"rationale",
"reference"
],
"title": "Role",
"default": "reference"
},
"locator": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "null"
}
],
"title": "Locator"
},
"rationale": {
"anyOf": [
{
"type": "string",
"maxLength": 4000
},
{
"type": "null"
}
],
"title": "Rationale"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"document_id",
"document_version_id"
],
"title": "ItemDocumentAssociationChange"
}OrganizationPageobject
Object constraints: additionalProperties: true.
| Property | Required | Type | Constraints |
|---|---|---|---|
data | Required | array of OrganizationSummary | No additional constraint specified |
next_cursor | Required | anyOf (string | null) | No additional constraint specified |
{
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/OrganizationSummary"
},
"type": "array",
"title": "Data"
},
"next_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Next Cursor"
}
},
"additionalProperties": true,
"type": "object",
"required": [
"data",
"next_cursor"
],
"title": "OrganizationPage"
}OrganizationSummaryobject
Object constraints: additionalProperties: true.
| Property | Required | Type | Constraints |
|---|---|---|---|
id | Required | string | format: uuid |
name | Required | string | No additional constraint specified |
role | Required | string | No additional constraint specified |
mfa_required | Required | boolean | No additional constraint specified |
{
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"role": {
"type": "string",
"title": "Role"
},
"mfa_required": {
"type": "boolean",
"title": "Mfa Required"
}
},
"additionalProperties": true,
"type": "object",
"required": [
"id",
"name",
"role",
"mfa_required"
],
"title": "OrganizationSummary"
}ProgramPageobject
Object constraints: additionalProperties: true.
| Property | Required | Type | Constraints |
|---|---|---|---|
data | Required | array of ProgramSummary | No additional constraint specified |
next_cursor | Required | anyOf (string | null) | No additional constraint specified |
{
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ProgramSummary"
},
"type": "array",
"title": "Data"
},
"next_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Next Cursor"
}
},
"additionalProperties": true,
"type": "object",
"required": [
"data",
"next_cursor"
],
"title": "ProgramPage"
}ProgramSummaryobject
Object constraints: additionalProperties: true.
| Property | Required | Type | Constraints |
|---|---|---|---|
id | Required | string | format: uuid |
organization_id | Required | string | format: uuid |
name | Required | string | No additional constraint specified |
next_revision | Required | integer | No additional constraint specified |
next_pull_request_number | Required | integer | No additional constraint specified |
next_baseline_number | Required | integer | No additional constraint specified |
setup_completed_at | Required | anyOf (string | null) | No additional constraint specified |
archived_at | Required | anyOf (string | null) | No additional constraint specified |
impact_settings | Required | object | additionalProperties: true |
required_pull_request_approvals | Required | integer | No additional constraint specified |
wait_for_agent_runs | Required | boolean | No additional constraint specified |
agent_service_tier | Required | string | enum: ["default","ultrafast"] |
created_at | Required | string | format: date-time |
updated_at | Required | string | format: date-time |
{
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"organization_id": {
"type": "string",
"format": "uuid",
"title": "Organization Id"
},
"name": {
"type": "string",
"title": "Name"
},
"next_revision": {
"type": "integer",
"title": "Next Revision"
},
"next_pull_request_number": {
"type": "integer",
"title": "Next Pull Request Number"
},
"next_baseline_number": {
"type": "integer",
"title": "Next Baseline Number"
},
"setup_completed_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Setup Completed At"
},
"archived_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Archived At"
},
"impact_settings": {
"additionalProperties": true,
"type": "object",
"title": "Impact Settings"
},
"required_pull_request_approvals": {
"type": "integer",
"title": "Required Pull Request Approvals"
},
"wait_for_agent_runs": {
"type": "boolean",
"title": "Wait For Agent Runs"
},
"agent_service_tier": {
"type": "string",
"enum": [
"default",
"ultrafast"
],
"title": "Agent Service Tier"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"updated_at": {
"type": "string",
"format": "date-time",
"title": "Updated At"
}
},
"additionalProperties": true,
"type": "object",
"required": [
"id",
"organization_id",
"name",
"next_revision",
"next_pull_request_number",
"next_baseline_number",
"setup_completed_at",
"archived_at",
"impact_settings",
"required_pull_request_approvals",
"wait_for_agent_runs",
"agent_service_tier",
"created_at",
"updated_at"
],
"title": "ProgramSummary"
}PublicApiErrorobject
Object constraints: additionalProperties: true.
| Property | Required | Type | Constraints |
|---|---|---|---|
code | Required | string | No additional constraint specified |
message | Required | string | No additional constraint specified |
expected_revision | Optional | anyOf (integer | null) | No additional constraint specified |
current_revision | Optional | anyOf (integer | null) | No additional constraint specified |
pull_request_id | Optional | anyOf (string | null) | No additional constraint specified |
pull_request_number | Optional | anyOf (integer | null) | No additional constraint specified |
field_definition_ids | Optional | anyOf (array of string | null) | No additional constraint specified |
item_ids | Optional | anyOf (array of string | null) | No additional constraint specified |
relationship_ids | Optional | anyOf (array of string | null) | No additional constraint specified |
document_ids | Optional | anyOf (array of string | null) | No additional constraint specified |
agent_ids | Optional | anyOf (array of string | null) | No additional constraint specified |
test_cycle_ids | Optional | anyOf (array of string | null) | No additional constraint specified |
test_run_ids | Optional | anyOf (array of string | null) | No additional constraint specified |
conflict_fields | Optional | anyOf (object | null) | No additional constraint specified |
{
"properties": {
"code": {
"type": "string",
"title": "Code"
},
"message": {
"type": "string",
"title": "Message"
},
"expected_revision": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Expected Revision"
},
"current_revision": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Current Revision"
},
"pull_request_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Pull Request Id"
},
"pull_request_number": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Pull Request Number"
},
"field_definition_ids": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Field Definition Ids"
},
"item_ids": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Item Ids"
},
"relationship_ids": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relationship Ids"
},
"document_ids": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document Ids"
},
"agent_ids": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Agent Ids"
},
"test_cycle_ids": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Test Cycle Ids"
},
"test_run_ids": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Test Run Ids"
},
"conflict_fields": {
"anyOf": [
{
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Conflict Fields"
}
},
"additionalProperties": true,
"type": "object",
"required": [
"code",
"message"
],
"title": "PublicApiError"
}PublicChangeobject
Object constraints: additionalProperties: true.
| Property | Required | Type | Constraints |
|---|---|---|---|
id | Required | string | format: uuid |
organization_id | Required | string | format: uuid |
program_id | Required | string | format: uuid |
branch_id | Required | string | format: uuid |
revision | Required | integer | No additional constraint specified |
title | Required | string | No additional constraint specified |
message | Required | string | No additional constraint specified |
actor_id | Required | string | No additional constraint specified |
actor_name | Required | string | No additional constraint specified |
source | Required | string | No additional constraint specified |
result | Required | object | additionalProperties: true |
created_at | Required | string | format: date-time |
{
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"organization_id": {
"type": "string",
"format": "uuid",
"title": "Organization Id"
},
"program_id": {
"type": "string",
"format": "uuid",
"title": "Program Id"
},
"branch_id": {
"type": "string",
"format": "uuid",
"title": "Branch Id"
},
"revision": {
"type": "integer",
"title": "Revision"
},
"title": {
"type": "string",
"title": "Title"
},
"message": {
"type": "string",
"title": "Message"
},
"actor_id": {
"type": "string",
"title": "Actor Id"
},
"actor_name": {
"type": "string",
"title": "Actor Name"
},
"source": {
"type": "string",
"title": "Source"
},
"result": {
"additionalProperties": true,
"type": "object",
"title": "Result"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
}
},
"additionalProperties": true,
"type": "object",
"required": [
"id",
"organization_id",
"program_id",
"branch_id",
"revision",
"title",
"message",
"actor_id",
"actor_name",
"source",
"result",
"created_at"
],
"title": "PublicChange"
}PublicChangePreviewobject
Object constraints: additionalProperties: true.
| Property | Required | Type | Constraints |
|---|---|---|---|
current_revision | Required | integer | No additional constraint specified |
projected_revision | Required | anyOf (integer | null) | No additional constraint specified |
diff | Required | object | additionalProperties: true |
impacts | Required | array of any JSON value | No additional constraint specified |
graph | Required | object | additionalProperties: true |
effects | Required | object | additionalProperties: true |
{
"properties": {
"current_revision": {
"type": "integer",
"title": "Current Revision"
},
"projected_revision": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Projected Revision"
},
"diff": {
"additionalProperties": true,
"type": "object",
"title": "Diff"
},
"impacts": {
"items": {},
"type": "array",
"title": "Impacts"
},
"graph": {
"additionalProperties": true,
"type": "object",
"title": "Graph"
},
"effects": {
"additionalProperties": true,
"type": "object",
"title": "Effects"
}
},
"additionalProperties": true,
"type": "object",
"required": [
"current_revision",
"projected_revision",
"diff",
"impacts",
"graph",
"effects"
],
"title": "PublicChangePreview"
}PublicChangeRequestobject
Object constraints: additionalProperties: false.
| Property | Required | Type | Constraints |
|---|---|---|---|
title | Required | string | minLength: 1maxLength: 500 |
message | Optional | string | maxLength: 5000default: |
source | Optional | string | default: userenum: ["user","import","agent"] |
expected_head_revision | Required | integer | minimum: 0 |
field_definitions | Optional | array of FieldDefinitionChange | No additional constraint specified |
items | Optional | array of ItemChange | No additional constraint specified |
relationships | Optional | array of RelationshipChange | No additional constraint specified |
documents | Optional | array of DocumentChange | maxItems: 0 |
agents | Optional | array of AgentDefinitionChange | maxItems: 0 |
test_cycles | Optional | array of TestCycleChange | maxItems: 0 |
test_runs | Optional | array of TestRunChange | maxItems: 0 |
{
"properties": {
"title": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"title": "Title",
"description": "Concise title shown in Change history."
},
"message": {
"type": "string",
"maxLength": 5000,
"title": "Message",
"description": "Optional message describing the Change.",
"default": ""
},
"source": {
"type": "string",
"enum": [
"user",
"import",
"agent"
],
"title": "Source",
"default": "user"
},
"expected_head_revision": {
"type": "integer",
"minimum": 0,
"title": "Expected Head Revision"
},
"field_definitions": {
"items": {
"$ref": "#/components/schemas/FieldDefinitionChange"
},
"type": "array",
"title": "Field Definitions"
},
"items": {
"items": {
"$ref": "#/components/schemas/ItemChange"
},
"type": "array",
"title": "Items"
},
"relationships": {
"items": {
"$ref": "#/components/schemas/RelationshipChange"
},
"type": "array",
"title": "Relationships"
},
"documents": {
"items": {
"$ref": "#/components/schemas/DocumentChange"
},
"type": "array",
"maxItems": 0,
"title": "Documents"
},
"agents": {
"items": {
"$ref": "#/components/schemas/AgentDefinitionChange"
},
"type": "array",
"maxItems": 0,
"title": "Agents"
},
"test_cycles": {
"items": {
"$ref": "#/components/schemas/TestCycleChange"
},
"type": "array",
"maxItems": 0,
"title": "Test Cycles"
},
"test_runs": {
"items": {
"$ref": "#/components/schemas/TestRunChange"
},
"type": "array",
"maxItems": 0,
"title": "Test Runs"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"title",
"expected_head_revision"
],
"title": "PublicChangeRequest"
}PublicFieldDefinitionobject
Object constraints: additionalProperties: true.
| Property | Required | Type | Constraints |
|---|---|---|---|
id | Required | string | format: uuid |
revision_id | Required | string | format: uuid |
branch_id | Required | string | format: uuid |
change_id | Required | anyOf (string | null) | No additional constraint specified |
revision | Required | integer | No additional constraint specified |
item_type_id | Required | string | format: uuid |
key | Required | string | No additional constraint specified |
name | Required | string | No additional constraint specified |
import_identifier | Required | anyOf (string | null) | No additional constraint specified |
kind | Required | string | No additional constraint specified |
required | Required | boolean | No additional constraint specified |
default_value | Required | any JSON value | No additional constraint specified |
config | Required | object | additionalProperties: true |
position | Required | integer | No additional constraint specified |
system | Required | boolean | No additional constraint specified |
archived | Required | boolean | No additional constraint specified |
{
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"revision_id": {
"type": "string",
"format": "uuid",
"title": "Revision Id"
},
"branch_id": {
"type": "string",
"format": "uuid",
"title": "Branch Id"
},
"change_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Change Id"
},
"revision": {
"type": "integer",
"title": "Revision"
},
"item_type_id": {
"type": "string",
"format": "uuid",
"title": "Item Type Id"
},
"key": {
"type": "string",
"title": "Key"
},
"name": {
"type": "string",
"title": "Name"
},
"import_identifier": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Import Identifier"
},
"kind": {
"type": "string",
"title": "Kind"
},
"required": {
"type": "boolean",
"title": "Required"
},
"default_value": {
"title": "Default Value"
},
"config": {
"additionalProperties": true,
"type": "object",
"title": "Config"
},
"position": {
"type": "integer",
"title": "Position"
},
"system": {
"type": "boolean",
"title": "System"
},
"archived": {
"type": "boolean",
"title": "Archived"
}
},
"additionalProperties": true,
"type": "object",
"required": [
"id",
"revision_id",
"branch_id",
"change_id",
"revision",
"item_type_id",
"key",
"name",
"import_identifier",
"kind",
"required",
"default_value",
"config",
"position",
"system",
"archived"
],
"title": "PublicFieldDefinition"
}PublicItemobject
Object constraints: additionalProperties: true.
| Property | Required | Type | Constraints |
|---|---|---|---|
id | Required | string | format: uuid |
item_type_id | Required | string | format: uuid |
type_key | Required | string | No additional constraint specified |
type_name | Required | string | No additional constraint specified |
type_color | Required | string | No additional constraint specified |
identifier | Required | string | No additional constraint specified |
name | Required | string | No additional constraint specified |
import_identifier | Required | anyOf (string | null) | No additional constraint specified |
status | Required | string | No additional constraint specified |
owners | Required | array of object | No additional constraint specified |
values | Required | object | additionalProperties: true |
metadata | Required | object | additionalProperties: true |
document_associations | Required | array of object | No additional constraint specified |
github_links | Required | array of object | No additional constraint specified |
gitlab_links | Required | array of object | No additional constraint specified |
revision | Required | integer | No additional constraint specified |
resolved_value | Required | any JSON value | No additional constraint specified |
rendered_statement | Required | anyOf (string | null) | No additional constraint specified |
actions | Required | object | additionalProperties: {"$ref":"#/components/schemas/ActionAvailability"} |
{
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"item_type_id": {
"type": "string",
"format": "uuid",
"title": "Item Type Id"
},
"type_key": {
"type": "string",
"title": "Type Key"
},
"type_name": {
"type": "string",
"title": "Type Name"
},
"type_color": {
"type": "string",
"title": "Type Color"
},
"identifier": {
"type": "string",
"title": "Identifier"
},
"name": {
"type": "string",
"title": "Name"
},
"import_identifier": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Import Identifier"
},
"status": {
"type": "string",
"title": "Status"
},
"owners": {
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array",
"title": "Owners"
},
"values": {
"additionalProperties": true,
"type": "object",
"title": "Values"
},
"metadata": {
"additionalProperties": true,
"type": "object",
"title": "Metadata"
},
"document_associations": {
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array",
"title": "Document Associations"
},
"github_links": {
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array",
"title": "Github Links"
},
"gitlab_links": {
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array",
"title": "Gitlab Links"
},
"revision": {
"type": "integer",
"title": "Revision"
},
"resolved_value": {
"title": "Resolved Value"
},
"rendered_statement": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Rendered Statement"
},
"actions": {
"additionalProperties": {
"$ref": "#/components/schemas/ActionAvailability"
},
"type": "object",
"title": "Actions"
}
},
"additionalProperties": true,
"type": "object",
"required": [
"id",
"item_type_id",
"type_key",
"type_name",
"type_color",
"identifier",
"name",
"import_identifier",
"status",
"owners",
"values",
"metadata",
"document_associations",
"github_links",
"gitlab_links",
"revision",
"resolved_value",
"rendered_statement",
"actions"
],
"title": "PublicItem"
}PublicItemDetailobject
Object constraints: additionalProperties: true.
| Property | Required | Type | Constraints |
|---|---|---|---|
data | Required | PublicItem | No additional constraint specified |
revision | Required | integer | No additional constraint specified |
{
"properties": {
"data": {
"$ref": "#/components/schemas/PublicItem"
},
"revision": {
"type": "integer",
"title": "Revision"
}
},
"additionalProperties": true,
"type": "object",
"required": [
"data",
"revision"
],
"title": "PublicItemDetail"
}PublicItemPageobject
Object constraints: additionalProperties: true.
| Property | Required | Type | Constraints |
|---|---|---|---|
data | Required | array of PublicItem | No additional constraint specified |
next_cursor | Required | anyOf (string | null) | No additional constraint specified |
revision | Required | integer | No additional constraint specified |
{
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/PublicItem"
},
"type": "array",
"title": "Data"
},
"next_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Next Cursor"
},
"revision": {
"type": "integer",
"title": "Revision"
}
},
"additionalProperties": true,
"type": "object",
"required": [
"data",
"next_cursor",
"revision"
],
"title": "PublicItemPage"
}PublicItemTypeobject
Object constraints: additionalProperties: true.
| Property | Required | Type | Constraints |
|---|---|---|---|
id | Required | string | format: uuid |
organization_id | Required | string | format: uuid |
program_id | Required | string | format: uuid |
key | Required | string | No additional constraint specified |
name | Required | string | No additional constraint specified |
icon | Required | string | No additional constraint specified |
color | Required | string | No additional constraint specified |
description | Required | string | No additional constraint specified |
statuses | Required | array of string | No additional constraint specified |
system | Required | boolean | No additional constraint specified |
created_at | Required | string | format: date-time |
updated_at | Required | string | format: date-time |
{
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"organization_id": {
"type": "string",
"format": "uuid",
"title": "Organization Id"
},
"program_id": {
"type": "string",
"format": "uuid",
"title": "Program Id"
},
"key": {
"type": "string",
"title": "Key"
},
"name": {
"type": "string",
"title": "Name"
},
"icon": {
"type": "string",
"title": "Icon"
},
"color": {
"type": "string",
"title": "Color"
},
"description": {
"type": "string",
"title": "Description"
},
"statuses": {
"items": {
"type": "string"
},
"type": "array",
"title": "Statuses"
},
"system": {
"type": "boolean",
"title": "System"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"updated_at": {
"type": "string",
"format": "date-time",
"title": "Updated At"
}
},
"additionalProperties": true,
"type": "object",
"required": [
"id",
"organization_id",
"program_id",
"key",
"name",
"icon",
"color",
"description",
"statuses",
"system",
"created_at",
"updated_at"
],
"title": "PublicItemType"
}PublicModelDefinitionsobject
Object constraints: additionalProperties: true.
| Property | Required | Type | Constraints |
|---|---|---|---|
branch_id | Required | string | format: uuid |
revision | Required | integer | No additional constraint specified |
item_types | Required | array of PublicItemType | No additional constraint specified |
field_definitions | Required | array of PublicFieldDefinition | No additional constraint specified |
relationship_types | Required | array of PublicRelationshipType | No additional constraint specified |
{
"properties": {
"branch_id": {
"type": "string",
"format": "uuid",
"title": "Branch Id"
},
"revision": {
"type": "integer",
"title": "Revision"
},
"item_types": {
"items": {
"$ref": "#/components/schemas/PublicItemType"
},
"type": "array",
"title": "Item Types"
},
"field_definitions": {
"items": {
"$ref": "#/components/schemas/PublicFieldDefinition"
},
"type": "array",
"title": "Field Definitions"
},
"relationship_types": {
"items": {
"$ref": "#/components/schemas/PublicRelationshipType"
},
"type": "array",
"title": "Relationship Types"
}
},
"additionalProperties": true,
"type": "object",
"required": [
"branch_id",
"revision",
"item_types",
"field_definitions",
"relationship_types"
],
"title": "PublicModelDefinitions"
}PublicPullRequestobject
Object constraints: additionalProperties: true.
| Property | Required | Type | Constraints |
|---|---|---|---|
id | Required | string | format: uuid |
organization_id | Required | string | format: uuid |
program_id | Required | string | format: uuid |
source_branch_id | Required | string | format: uuid |
target_branch_id | Required | string | format: uuid |
number | Required | integer | No additional constraint specified |
source_revision | Required | integer | No additional constraint specified |
target_revision | Required | integer | No additional constraint specified |
title | Required | string | No additional constraint specified |
description | Required | string | No additional constraint specified |
status | Required | string | No additional constraint specified |
reviewers | Required | array of object | No additional constraint specified |
decisions | Required | array of object | No additional constraint specified |
created_by | Required | string | No additional constraint specified |
created_at | Required | string | format: date-time |
updated_at | Required | string | format: date-time |
actions | Required | object | additionalProperties: {"$ref":"#/components/schemas/ActionAvailability"} |
{
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"organization_id": {
"type": "string",
"format": "uuid",
"title": "Organization Id"
},
"program_id": {
"type": "string",
"format": "uuid",
"title": "Program Id"
},
"source_branch_id": {
"type": "string",
"format": "uuid",
"title": "Source Branch Id"
},
"target_branch_id": {
"type": "string",
"format": "uuid",
"title": "Target Branch Id"
},
"number": {
"type": "integer",
"title": "Number"
},
"source_revision": {
"type": "integer",
"title": "Source Revision"
},
"target_revision": {
"type": "integer",
"title": "Target Revision"
},
"title": {
"type": "string",
"title": "Title"
},
"description": {
"type": "string",
"title": "Description"
},
"status": {
"type": "string",
"title": "Status"
},
"reviewers": {
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array",
"title": "Reviewers"
},
"decisions": {
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array",
"title": "Decisions"
},
"created_by": {
"type": "string",
"title": "Created By"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"updated_at": {
"type": "string",
"format": "date-time",
"title": "Updated At"
},
"actions": {
"additionalProperties": {
"$ref": "#/components/schemas/ActionAvailability"
},
"type": "object",
"title": "Actions"
}
},
"additionalProperties": true,
"type": "object",
"required": [
"id",
"organization_id",
"program_id",
"source_branch_id",
"target_branch_id",
"number",
"source_revision",
"target_revision",
"title",
"description",
"status",
"reviewers",
"decisions",
"created_by",
"created_at",
"updated_at",
"actions"
],
"title": "PublicPullRequest"
}PublicPullRequestDetailobject
Object constraints: additionalProperties: true.
| Property | Required | Type | Constraints |
|---|---|---|---|
data | Required | PublicPullRequest | No additional constraint specified |
{
"properties": {
"data": {
"$ref": "#/components/schemas/PublicPullRequest"
}
},
"additionalProperties": true,
"type": "object",
"required": [
"data"
],
"title": "PublicPullRequestDetail"
}PublicPullRequestPageobject
Object constraints: additionalProperties: true.
| Property | Required | Type | Constraints |
|---|---|---|---|
data | Required | array of PublicPullRequest | No additional constraint specified |
next_cursor | Required | anyOf (string | null) | No additional constraint specified |
{
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/PublicPullRequest"
},
"type": "array",
"title": "Data"
},
"next_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Next Cursor"
}
},
"additionalProperties": true,
"type": "object",
"required": [
"data",
"next_cursor"
],
"title": "PublicPullRequestPage"
}PublicRelationshipobject
Object constraints: additionalProperties: true.
| Property | Required | Type | Constraints |
|---|---|---|---|
id | Required | string | format: uuid |
relationship_type_id | Required | string | format: uuid |
type_key | Required | string | No additional constraint specified |
type_name | Required | string | No additional constraint specified |
identifier | Required | anyOf (string | null) | No additional constraint specified |
name | Required | anyOf (string | null) | No additional constraint specified |
import_identifier | Required | anyOf (string | null) | No additional constraint specified |
source_item_id | Required | string | format: uuid |
target_item_id | Required | string | format: uuid |
values | Required | object | additionalProperties: true |
revision | Required | integer | No additional constraint specified |
evaluation | Required | anyOf (object | null) | No additional constraint specified |
{
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"relationship_type_id": {
"type": "string",
"format": "uuid",
"title": "Relationship Type Id"
},
"type_key": {
"type": "string",
"title": "Type Key"
},
"type_name": {
"type": "string",
"title": "Type Name"
},
"identifier": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Identifier"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name"
},
"import_identifier": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Import Identifier"
},
"source_item_id": {
"type": "string",
"format": "uuid",
"title": "Source Item Id"
},
"target_item_id": {
"type": "string",
"format": "uuid",
"title": "Target Item Id"
},
"values": {
"additionalProperties": true,
"type": "object",
"title": "Values"
},
"revision": {
"type": "integer",
"title": "Revision"
},
"evaluation": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Evaluation"
}
},
"additionalProperties": true,
"type": "object",
"required": [
"id",
"relationship_type_id",
"type_key",
"type_name",
"identifier",
"name",
"import_identifier",
"source_item_id",
"target_item_id",
"values",
"revision",
"evaluation"
],
"title": "PublicRelationship"
}PublicRelationshipPageobject
Object constraints: additionalProperties: true.
| Property | Required | Type | Constraints |
|---|---|---|---|
data | Required | array of PublicRelationship | No additional constraint specified |
next_cursor | Required | anyOf (string | null) | No additional constraint specified |
revision | Required | integer | No additional constraint specified |
{
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/PublicRelationship"
},
"type": "array",
"title": "Data"
},
"next_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Next Cursor"
},
"revision": {
"type": "integer",
"title": "Revision"
}
},
"additionalProperties": true,
"type": "object",
"required": [
"data",
"next_cursor",
"revision"
],
"title": "PublicRelationshipPage"
}PublicRelationshipTypeobject
Object constraints: additionalProperties: true.
| Property | Required | Type | Constraints |
|---|---|---|---|
id | Required | string | format: uuid |
organization_id | Required | string | format: uuid |
program_id | Required | string | format: uuid |
key | Required | string | No additional constraint specified |
name | Required | string | No additional constraint specified |
source_label | Required | string | No additional constraint specified |
target_label | Required | string | No additional constraint specified |
source_type_ids | Required | array of string | No additional constraint specified |
target_type_ids | Required | array of string | No additional constraint specified |
fields | Required | array of object | No additional constraint specified |
hierarchy | Required | boolean | No additional constraint specified |
impact_enabled | Required | boolean | No additional constraint specified |
impact_direction | Required | string | No additional constraint specified |
bidirectional | Required | boolean | No additional constraint specified |
allow_multiple | Required | boolean | No additional constraint specified |
system | Required | boolean | No additional constraint specified |
created_at | Required | string | format: date-time |
updated_at | Required | string | format: date-time |
{
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"organization_id": {
"type": "string",
"format": "uuid",
"title": "Organization Id"
},
"program_id": {
"type": "string",
"format": "uuid",
"title": "Program Id"
},
"key": {
"type": "string",
"title": "Key"
},
"name": {
"type": "string",
"title": "Name"
},
"source_label": {
"type": "string",
"title": "Source Label"
},
"target_label": {
"type": "string",
"title": "Target Label"
},
"source_type_ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Source Type Ids"
},
"target_type_ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Target Type Ids"
},
"fields": {
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array",
"title": "Fields"
},
"hierarchy": {
"type": "boolean",
"title": "Hierarchy"
},
"impact_enabled": {
"type": "boolean",
"title": "Impact Enabled"
},
"impact_direction": {
"type": "string",
"title": "Impact Direction"
},
"bidirectional": {
"type": "boolean",
"title": "Bidirectional"
},
"allow_multiple": {
"type": "boolean",
"title": "Allow Multiple"
},
"system": {
"type": "boolean",
"title": "System"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"updated_at": {
"type": "string",
"format": "date-time",
"title": "Updated At"
}
},
"additionalProperties": true,
"type": "object",
"required": [
"id",
"organization_id",
"program_id",
"key",
"name",
"source_label",
"target_label",
"source_type_ids",
"target_type_ids",
"fields",
"hierarchy",
"impact_enabled",
"impact_direction",
"bidirectional",
"allow_multiple",
"system",
"created_at",
"updated_at"
],
"title": "PublicRelationshipType"
}PullRequestCreateobject
Object constraints: additionalProperties: false.
| Property | Required | Type | Constraints |
|---|---|---|---|
source_branch_id | Required | string | format: uuid |
target_branch_id | Required | string | format: uuid |
title | Required | string | minLength: 1maxLength: 300 |
description | Required | string | minLength: 1maxLength: 4000 |
reviewer_ids | Optional | array of string | No additional constraint specified |
{
"properties": {
"source_branch_id": {
"type": "string",
"format": "uuid",
"title": "Source Branch Id"
},
"target_branch_id": {
"type": "string",
"format": "uuid",
"title": "Target Branch Id"
},
"title": {
"type": "string",
"maxLength": 300,
"minLength": 1,
"title": "Title"
},
"description": {
"type": "string",
"maxLength": 4000,
"minLength": 1,
"title": "Description"
},
"reviewer_ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Reviewer Ids"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"source_branch_id",
"target_branch_id",
"title",
"description"
],
"title": "PullRequestCreate"
}PullRequestRevisionobject
Object constraints: additionalProperties: false.
| Property | Required | Type | Constraints |
|---|---|---|---|
source_revision | Required | integer | minimum: 0 |
target_revision | Required | integer | minimum: 0 |
{
"properties": {
"source_revision": {
"type": "integer",
"minimum": 0,
"title": "Source Revision"
},
"target_revision": {
"type": "integer",
"minimum": 0,
"title": "Target Revision"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"source_revision",
"target_revision"
],
"title": "PullRequestRevision"
}RelationshipChangeobject
Object constraints: additionalProperties: false.
| Property | Required | Type | Constraints |
|---|---|---|---|
id | Optional | anyOf (string | null) | No additional constraint specified |
relationship_type_id | Required | string | format: uuid |
name | Optional | anyOf (string | null) | No additional constraint specified |
import_identifier | Optional | anyOf (string | null) | No additional constraint specified |
source_item_id | Optional | anyOf (string | null) | No additional constraint specified |
target_item_id | Optional | anyOf (string | null) | No additional constraint specified |
source_ref | Optional | anyOf (string | null) | No additional constraint specified |
target_ref | Optional | anyOf (string | null) | No additional constraint specified |
values | Optional | object | additionalProperties: true |
deleted | Optional | boolean | default: false |
{
"properties": {
"id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Id"
},
"relationship_type_id": {
"type": "string",
"format": "uuid",
"title": "Relationship Type Id"
},
"name": {
"anyOf": [
{
"type": "string",
"maxLength": 500,
"minLength": 1
},
{
"type": "null"
}
],
"title": "Name"
},
"import_identifier": {
"anyOf": [
{
"type": "string",
"maxLength": 500,
"minLength": 1
},
{
"type": "null"
}
],
"title": "Import Identifier"
},
"source_item_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Source Item Id"
},
"target_item_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Target Item Id"
},
"source_ref": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Source Ref"
},
"target_ref": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Target Ref"
},
"values": {
"additionalProperties": true,
"type": "object",
"title": "Values"
},
"deleted": {
"type": "boolean",
"title": "Deleted",
"default": false
}
},
"additionalProperties": false,
"type": "object",
"required": [
"relationship_type_id"
],
"title": "RelationshipChange"
}TestCycleChangeobject
Object constraints: additionalProperties: false.
| Property | Required | Type | Constraints |
|---|---|---|---|
id | Optional | anyOf (string | null) | No additional constraint specified |
model_branch_id | Required | string | format: uuid |
model_revision | Required | integer | minimum: 0 |
plan_item_id | Required | string | format: uuid |
plan_revision_id | Required | string | format: uuid |
name | Required | string | minLength: 1maxLength: 255 |
test_article | Optional | string | maxLength: 500default: |
configuration | Optional | string | maxLength: 50000default: |
planned_start | Optional | anyOf (string | null) | No additional constraint specified |
planned_end | Optional | anyOf (string | null) | No additional constraint specified |
notes | Optional | string | maxLength: 50000default: |
state | Optional | string | default: openenum: ["open","closed","cancelled"] |
deleted | Optional | boolean | default: false |
{
"properties": {
"id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Id"
},
"model_branch_id": {
"type": "string",
"format": "uuid",
"title": "Model Branch Id"
},
"model_revision": {
"type": "integer",
"minimum": 0,
"title": "Model Revision"
},
"plan_item_id": {
"type": "string",
"format": "uuid",
"title": "Plan Item Id"
},
"plan_revision_id": {
"type": "string",
"format": "uuid",
"title": "Plan Revision Id"
},
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"title": "Name"
},
"test_article": {
"type": "string",
"maxLength": 500,
"title": "Test Article",
"default": ""
},
"configuration": {
"type": "string",
"maxLength": 50000,
"title": "Configuration",
"default": ""
},
"planned_start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Planned Start"
},
"planned_end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Planned End"
},
"notes": {
"type": "string",
"maxLength": 50000,
"title": "Notes",
"default": ""
},
"state": {
"type": "string",
"enum": [
"open",
"closed",
"cancelled"
],
"title": "State",
"default": "open"
},
"deleted": {
"type": "boolean",
"title": "Deleted",
"default": false
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_branch_id",
"model_revision",
"plan_item_id",
"plan_revision_id",
"name"
],
"title": "TestCycleChange"
}TestEvidenceSnapshotChangeobject
Object constraints: additionalProperties: false.
| Property | Required | Type | Constraints |
|---|---|---|---|
id | Required | string | format: uuid |
run_step_id | Optional | anyOf (string | null) | No additional constraint specified |
document_version_id | Required | string | format: uuid |
title | Required | string | minLength: 1maxLength: 500 |
notes | Optional | string | maxLength: 50000default: |
withdrawn | Optional | boolean | default: false |
withdrawal_reason | Optional | anyOf (string | null) | No additional constraint specified |
{
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"run_step_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Run Step Id"
},
"document_version_id": {
"type": "string",
"format": "uuid",
"title": "Document Version Id"
},
"title": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"title": "Title"
},
"notes": {
"type": "string",
"maxLength": 50000,
"title": "Notes",
"default": ""
},
"withdrawn": {
"type": "boolean",
"title": "Withdrawn",
"default": false
},
"withdrawal_reason": {
"anyOf": [
{
"type": "string",
"maxLength": 50000
},
{
"type": "null"
}
],
"title": "Withdrawal Reason"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"id",
"document_version_id",
"title"
],
"title": "TestEvidenceSnapshotChange"
}TestRunChangeobject
Object constraints: additionalProperties: false.
| Property | Required | Type | Constraints |
|---|---|---|---|
id | Optional | anyOf (string | null) | No additional constraint specified |
cycle_id | Required | string | format: uuid |
cycle_revision_id | Optional | anyOf (string | null) | No additional constraint specified |
plan_slot_id | Required | string | format: uuid |
plan_slot_revision_id | Required | string | format: uuid |
test_item_id | Required | string | format: uuid |
test_revision_id | Required | string | format: uuid |
position | Required | integer | exclusiveMinimum: 0 |
slot_label | Optional | string | maxLength: 255default: |
attempt | Required | integer | exclusiveMinimum: 0 |
status | Required | string | enum: ["not_started","in_progress","completed","cancelled"] |
outcome | Optional | anyOf (string | null) | No additional constraint specified |
notes | Optional | string | maxLength: 50000default: |
steps | Optional | array of TestRunStepSnapshotChange | No additional constraint specified |
evidence | Optional | array of TestEvidenceSnapshotChange | No additional constraint specified |
correction_reason | Optional | anyOf (string | null) | No additional constraint specified |
deleted | Optional | boolean | default: false |
{
"properties": {
"id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Id"
},
"cycle_id": {
"type": "string",
"format": "uuid",
"title": "Cycle Id"
},
"cycle_revision_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Cycle Revision Id"
},
"plan_slot_id": {
"type": "string",
"format": "uuid",
"title": "Plan Slot Id"
},
"plan_slot_revision_id": {
"type": "string",
"format": "uuid",
"title": "Plan Slot Revision Id"
},
"test_item_id": {
"type": "string",
"format": "uuid",
"title": "Test Item Id"
},
"test_revision_id": {
"type": "string",
"format": "uuid",
"title": "Test Revision Id"
},
"position": {
"type": "integer",
"exclusiveMinimum": 0,
"title": "Position"
},
"slot_label": {
"type": "string",
"maxLength": 255,
"title": "Slot Label",
"default": ""
},
"attempt": {
"type": "integer",
"exclusiveMinimum": 0,
"title": "Attempt"
},
"status": {
"type": "string",
"enum": [
"not_started",
"in_progress",
"completed",
"cancelled"
],
"title": "Status"
},
"outcome": {
"anyOf": [
{
"type": "string",
"enum": [
"pass",
"fail",
"blocked",
"skipped"
]
},
{
"type": "null"
}
],
"title": "Outcome"
},
"notes": {
"type": "string",
"maxLength": 50000,
"title": "Notes",
"default": ""
},
"steps": {
"items": {
"$ref": "#/components/schemas/TestRunStepSnapshotChange"
},
"type": "array",
"title": "Steps"
},
"evidence": {
"items": {
"$ref": "#/components/schemas/TestEvidenceSnapshotChange"
},
"type": "array",
"title": "Evidence"
},
"correction_reason": {
"anyOf": [
{
"type": "string",
"maxLength": 50000
},
{
"type": "null"
}
],
"title": "Correction Reason"
},
"deleted": {
"type": "boolean",
"title": "Deleted",
"default": false
}
},
"additionalProperties": false,
"type": "object",
"required": [
"cycle_id",
"plan_slot_id",
"plan_slot_revision_id",
"test_item_id",
"test_revision_id",
"position",
"attempt",
"status"
],
"title": "TestRunChange"
}TestRunStepSnapshotChangeobject
Object constraints: additionalProperties: false.
| Property | Required | Type | Constraints |
|---|---|---|---|
id | Required | string | format: uuid |
source_step_id | Required | string | format: uuid |
position | Required | integer | exclusiveMinimum: 0 |
action | Required | string | No additional constraint specified |
expected_result | Required | string | No additional constraint specified |
outcome | Optional | string | default: pendingenum: ["pending","pass","fail","skipped"] |
actual_result | Optional | string | default: |
constraint_snapshot | Optional | anyOf (object | null) | No additional constraint specified |
observed_value | Optional | anyOf (string | null) | No additional constraint specified |
{
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"source_step_id": {
"type": "string",
"format": "uuid",
"title": "Source Step Id"
},
"position": {
"type": "integer",
"exclusiveMinimum": 0,
"title": "Position"
},
"action": {
"type": "string",
"title": "Action"
},
"expected_result": {
"type": "string",
"title": "Expected Result"
},
"outcome": {
"type": "string",
"enum": [
"pending",
"pass",
"fail",
"skipped"
],
"title": "Outcome",
"default": "pending"
},
"actual_result": {
"type": "string",
"title": "Actual Result",
"default": ""
},
"constraint_snapshot": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Constraint Snapshot"
},
"observed_value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Observed Value"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"id",
"source_step_id",
"position",
"action",
"expected_result"
],
"title": "TestRunStepSnapshotChange"
}Evaluate your integration with Arc
Bring one representative read or supported change. Agree scope and data handling before adding programme information.
Request a trial →