Created
May 16, 2019 23:25
-
-
Save wy193777/e2da6ad64259cc1ad6a672aae55b1d23 to your computer and use it in GitHub Desktop.
Jama API Swagger.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "swagger": "2.0", | |
| "info": { | |
| "description": "This is the documentation for the Jama REST API.", | |
| "version": "latest", | |
| "title": "Jama REST API", | |
| "contact": { | |
| "name": "support@jamasoftware.com", | |
| "url": "https://dev.jamasoftware.com" | |
| } | |
| }, | |
| "host": "nvidia.jamacloud.com", | |
| "basePath": "/rest/latest", | |
| "tags": [{ | |
| "name": "abstractitems" | |
| }, { | |
| "name": "activities" | |
| }, { | |
| "name": "files" | |
| }, { | |
| "name": "attachments" | |
| }, { | |
| "name": "baselines" | |
| }, { | |
| "name": "comments" | |
| }, { | |
| "name": "filters" | |
| }, { | |
| "name": "itemtypes" | |
| }, { | |
| "name": "items" | |
| }, { | |
| "name": "picklists" | |
| }, { | |
| "name": "picklistoptions" | |
| }, { | |
| "name": "projects" | |
| }, { | |
| "name": "relationshiptypes" | |
| }, { | |
| "name": "relationships" | |
| }, { | |
| "name": "releases" | |
| }, { | |
| "name": "system" | |
| }, { | |
| "name": "tags" | |
| }, { | |
| "name": "testcycles" | |
| }, { | |
| "name": "testplans" | |
| }, { | |
| "name": "testruns" | |
| }, { | |
| "name": "usergroups" | |
| }, { | |
| "name": "users" | |
| }], | |
| "schemes": ["https"], | |
| "security": [{ | |
| "basic": [] | |
| }, { | |
| "oauth2": ["token_information"] | |
| }], | |
| "paths": { | |
| "/abstractitems/{id}": { | |
| "get": { | |
| "tags": ["abstractitems"], | |
| "summary": "Get any item, test plan, test cycle, test run, or attachment with the specified ID", | |
| "description": "", | |
| "operationId": "getItem", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractItemDataWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/abstractitems": { | |
| "get": { | |
| "tags": ["abstractitems"], | |
| "summary": "Search for items, test plans, test cycles, test runs, or attachments", | |
| "description": "", | |
| "operationId": "getAbstractItems", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "project", | |
| "in": "query", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "itemType", | |
| "in": "query", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "documentKey", | |
| "in": "query", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "release", | |
| "in": "query", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "createdDate", | |
| "in": "query", | |
| "description": "Filter datetime fields after a single date or within a range of values. Provide one or two values in ISO8601 format (milliseconds or seconds) - \"yyyy-MM-dd'T'HH:mm:ss.SSSZ\" or \"yyyy-MM-dd'T'HH:mm:ssZ\"", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "modifiedDate", | |
| "in": "query", | |
| "description": "Filter datetime fields after a single date or within a range of values. Provide one or two values in ISO8601 format (milliseconds or seconds) - \"yyyy-MM-dd'T'HH:mm:ss.SSSZ\" or \"yyyy-MM-dd'T'HH:mm:ssZ\"", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "lastActivityDate", | |
| "in": "query", | |
| "description": "Filter datetime fields after a single date or within a range of values. Provide one or two values in ISO8601 format (milliseconds or seconds) - \"yyyy-MM-dd'T'HH:mm:ss.SSSZ\" or \"yyyy-MM-dd'T'HH:mm:ssZ\"", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "contains", | |
| "in": "query", | |
| "description": "Filter on the text contents of the item. Strings taken literally. Multiple 'contains' values will be bitwise ORed.", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "sortBy", | |
| "in": "query", | |
| "description": "Sort orders can be added with the name of the field by which to sort, followed by .asc or .desc (e.g. 'name.asc' or 'modifiedDate.desc'). If not set, this defaults to sorting by sequence.asc and then documentKey.asc", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/ItemDataListWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/abstractitems/{id}/versions/{versionNum}/versioneditem": { | |
| "get": { | |
| "tags": ["abstractitems"], | |
| "summary": "Get the snapshot of the item at the specified version", | |
| "description": "", | |
| "operationId": "getVersionedItem", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "versionNum", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractVersionedItemDataWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/abstractitems/{id}/versions": { | |
| "get": { | |
| "tags": ["abstractitems"], | |
| "summary": "Get all versions for the item with the specified ID", | |
| "description": "", | |
| "operationId": "getVersionsOnItem", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/VersionDataListWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/abstractitems/{id}/versions/{versionNum}": { | |
| "get": { | |
| "tags": ["abstractitems"], | |
| "summary": "Get the numbered version for the item with the specified ID", | |
| "description": "", | |
| "operationId": "getVersionOnItem", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "versionNum", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/VersionDataWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/abstractitems/{id}/versionedrelationships": { | |
| "get": { | |
| "tags": ["abstractitems"], | |
| "summary": "Get all versioned relationships that were associated to the item at the specified time", | |
| "description": "", | |
| "operationId": "getVersionedRelationships", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "timestamp", | |
| "in": "query", | |
| "description": "Get relationships for the specified item at this date and time. Requires ISO8601 formatting (milliseconds or seconds) - \"yyyy-MM-dd'T'HH:mm:ss.SSSZ\" or \"yyyy-MM-dd'T'HH:mm:ssZ\"", | |
| "required": true, | |
| "type": "string" | |
| }, { | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/VersionedRelationshipDataListWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/activities": { | |
| "get": { | |
| "tags": ["activities"], | |
| "summary": "Get all activities in the project with the specified ID", | |
| "description": "", | |
| "operationId": "getActivities", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "project", | |
| "in": "query", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "eventType", | |
| "in": "query", | |
| "description": "Event type to filter on. More than one event type can be chosen", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": ["CREATE", "BATCH_CREATE", "UPDATE", "BATCH_UPDATE", "DELETE", "BATCH_DELETE", "PUBLIC", "BATCH_SUMMARY", "COPY", "BATCH_COPY", "MOVE"] | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "objectType", | |
| "in": "query", | |
| "description": "Object type to filter on. More than one object type can be chosen", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": ["PROJECT", "ITEM", "USER", "RELATIONSHIP", "COMMENT", "ITEM_TAG", "TAG", "ITEM_ATTACHMENT", "URL", "TEST_RESULT", "BASELINE", "CHANGE_REQUEST", "REVIEW", "REVISION", "REVISION_ITEM", "TEST_PLAN", "TEST_CYCLE", "TEST_RUN", "INTEGRATION", "MISCELLANEOUS"] | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "itemType", | |
| "in": "query", | |
| "description": "ID of item type to filter on. More than one item type can be chosen", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "date", | |
| "in": "query", | |
| "description": "Filter datetime fields after a single date or within a range of values. Provide one or two values in ISO8601 format (milliseconds or seconds) - \"yyyy-MM-dd'T'HH:mm:ss.SSSZ\" or \"yyyy-MM-dd'T'HH:mm:ssZ\"", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "deleteEvents", | |
| "in": "query", | |
| "description": "Get item delete events only", | |
| "required": false, | |
| "type": "boolean" | |
| }, { | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/ActivityDataListWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/activities/{activityId}/affecteditems": { | |
| "get": { | |
| "tags": ["activities"], | |
| "summary": "Get all items affected by the activity with the specified ID", | |
| "description": "", | |
| "operationId": "getAffectedItems", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "activityId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/ItemDataListWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/activities/{activityId}": { | |
| "get": { | |
| "tags": ["activities"], | |
| "summary": "Get the activity with the specified ID", | |
| "description": "", | |
| "operationId": "getActivityById", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "activityId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/ActivityDataWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/activities/{activityId}/restore": { | |
| "post": { | |
| "tags": ["activities"], | |
| "summary": "Restore item(s) associated with a delete activity.", | |
| "description": "", | |
| "operationId": "restoreItems", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "activityId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/files": { | |
| "get": { | |
| "tags": ["files"], | |
| "summary": "Download attachment file from the attachment with the specified Jama URL", | |
| "description": "", | |
| "operationId": "downloadFile", | |
| "consumes": ["application/json"], | |
| "produces": ["application/octet-stream"], | |
| "parameters": [{ | |
| "name": "url", | |
| "in": "query", | |
| "required": true, | |
| "type": "string" | |
| }], | |
| "responses": { | |
| "default": { | |
| "description": "successful operation" | |
| } | |
| } | |
| } | |
| }, | |
| "/attachments/{attachmentId}/comments": { | |
| "get": { | |
| "tags": ["attachments"], | |
| "summary": "Get all comments for the item with the specified ID", | |
| "description": "", | |
| "operationId": "getItemComments", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "rootCommentsOnly", | |
| "in": "query", | |
| "required": false, | |
| "type": "boolean", | |
| "default": false | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "attachmentId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/CommentDataListWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/attachments/{attachmentId}/versions/{versionNum}/versioneditem": { | |
| "get": { | |
| "tags": ["attachments"], | |
| "summary": "Get the snapshot of the attachment at the specified version", | |
| "description": "", | |
| "operationId": "getVersionedItem_1", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "versionNum", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "attachmentId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/VersionedAttachmentDataWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/attachments/{attachmentId}/versions": { | |
| "get": { | |
| "tags": ["attachments"], | |
| "summary": "Get all versions for the item with the specified ID", | |
| "description": "", | |
| "operationId": "getVersionsOnItem_1", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "attachmentId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/VersionDataListWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/attachments/{attachmentId}/versions/{versionNum}": { | |
| "get": { | |
| "tags": ["attachments"], | |
| "summary": "Get the numbered version for the item with the specified ID", | |
| "description": "", | |
| "operationId": "getVersionOnItem_1", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "versionNum", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "attachmentId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/VersionDataWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/attachments/{attachmentId}/file": { | |
| "get": { | |
| "tags": ["attachments"], | |
| "summary": "Download attachment file from the attachment with the specified ID", | |
| "description": "", | |
| "operationId": "downloadFile", | |
| "consumes": ["application/json"], | |
| "produces": ["application/octet-stream"], | |
| "parameters": [{ | |
| "name": "attachmentId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "default": { | |
| "description": "successful operation" | |
| } | |
| } | |
| }, | |
| "put": { | |
| "tags": ["attachments"], | |
| "summary": "Upload attachment file to the attachment with the specified ID", | |
| "description": "", | |
| "operationId": "uploadFile", | |
| "consumes": ["multipart/form-data"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": false, | |
| "schema": { | |
| "$ref": "#/definitions/FormDataMultiPart" | |
| } | |
| }, { | |
| "name": "attachmentId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/attachments/{attachmentId}/lock": { | |
| "get": { | |
| "tags": ["attachments"], | |
| "summary": "Get the locked state, last locked date, and last locked by user for the item with the specified ID", | |
| "description": "", | |
| "operationId": "getLock", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "attachmentId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/LockDataWrapper" | |
| } | |
| } | |
| } | |
| }, | |
| "put": { | |
| "tags": ["attachments"], | |
| "summary": "Update the locked state of the item with the specified ID", | |
| "description": "", | |
| "operationId": "updateLock", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RequestLock" | |
| } | |
| }, { | |
| "name": "attachmentId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/attachments/{attachmentId}": { | |
| "get": { | |
| "tags": ["attachments"], | |
| "summary": "Get the attachment with the specified ID", | |
| "description": "", | |
| "operationId": "getAttachmentItem", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "attachmentId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AttachmentDataWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/baselines/{baselineId}": { | |
| "get": { | |
| "tags": ["baselines"], | |
| "summary": "Get the baseline with the specified ID", | |
| "description": "", | |
| "operationId": "getBaseline", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "baselineId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/BaselineDataWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/baselines/{baselineId}/versioneditems": { | |
| "get": { | |
| "tags": ["baselines"], | |
| "summary": "Get all baseline items in a baseline with the specified ID", | |
| "description": "", | |
| "operationId": "getVersionedItems", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "baselineId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/BaselineItemDataListWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/baselines/{baselineId}/versioneditems/{itemId}": { | |
| "get": { | |
| "tags": ["baselines"], | |
| "summary": "Get the baseline item with the specified ID in a baseline with the specified ID", | |
| "description": "", | |
| "operationId": "getVersionedItem", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "itemId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "baselineId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/BaselineItemDataWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/baselines/{baselineId}/versioneditems/{itemId}/versionedrelationships": { | |
| "get": { | |
| "tags": ["baselines"], | |
| "summary": "Get all versioned relationships for the item in the baseline", | |
| "description": "", | |
| "operationId": "getRelationshipsForVersion", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "itemId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "baselineId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/VersionedRelationshipDataListWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/baselines": { | |
| "get": { | |
| "tags": ["baselines"], | |
| "summary": "Get all baselines in the project with the specified ID", | |
| "description": "", | |
| "operationId": "getBaselines", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "project", | |
| "in": "query", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/BaselineDataListWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/comments/{id}": { | |
| "get": { | |
| "tags": ["comments"], | |
| "summary": "Get the comment with the specified ID", | |
| "description": "", | |
| "operationId": "getComment", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/CommentDataWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/comments/{id}/replies": { | |
| "get": { | |
| "tags": ["comments"], | |
| "summary": "Get all reply comments for the comment with the specified ID", | |
| "description": "", | |
| "operationId": "getReplies", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/CommentDataListWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/comments": { | |
| "get": { | |
| "tags": ["comments"], | |
| "summary": "Get all comments viewable by the current user", | |
| "description": "", | |
| "operationId": "getComments", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "rootCommentsOnly", | |
| "in": "query", | |
| "description": "whether to show only root comments; true to get only root comments, without their comment replies", | |
| "required": false, | |
| "type": "boolean", | |
| "default": false | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/CommentDataListWrapper" | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": ["comments"], | |
| "summary": "Create a new comment", | |
| "description": "", | |
| "operationId": "addComment", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RequestComment" | |
| } | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/CreatedResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/filters/{filterId}": { | |
| "get": { | |
| "tags": ["filters"], | |
| "summary": "Get the filter with the specified ID", | |
| "description": "", | |
| "operationId": "getFilter", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "filterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/FilterDataWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/filters/{filterId}/results": { | |
| "get": { | |
| "tags": ["filters"], | |
| "summary": "Get all result items for the filter with the specified ID", | |
| "description": "", | |
| "operationId": "getResults", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "project", | |
| "in": "query", | |
| "description": "Use only for filters that run on any project, where \"projectScope\" is \"CURRENT\"", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "lastActivityDate", | |
| "in": "query", | |
| "description": "Filter datetime fields after a single date or within a range of values. Provide one or two values in ISO8601 format (milliseconds or seconds) - \"yyyy-MM-dd'T'HH:mm:ss.SSSZ\" or \"yyyy-MM-dd'T'HH:mm:ssZ\"", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "filterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/ItemDataListWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/filters": { | |
| "get": { | |
| "tags": ["filters"], | |
| "summary": "Get all filters viewable by the current user", | |
| "description": "", | |
| "operationId": "getFilters", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "project", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "author", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "filterScope", | |
| "in": "query", | |
| "description": "Filter scope. More than one scope can be selected", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": ["ALL_PROJECTS", "BOUND_PROJECT", "CURRENT_PROJECT"] | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/FilterDataListWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/itemtypes/{itemTypeId}": { | |
| "get": { | |
| "tags": ["itemtypes"], | |
| "summary": "Get the item type with the specified ID", | |
| "description": "", | |
| "operationId": "getItem", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "itemTypeId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/ItemTypeDataWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/itemtypes": { | |
| "get": { | |
| "tags": ["itemtypes"], | |
| "summary": "Get all item types", | |
| "description": "", | |
| "operationId": "getItemTypes", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/ItemTypeDataListWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/items/{id}": { | |
| "get": { | |
| "tags": ["items"], | |
| "summary": "Get the item with the specified ID", | |
| "description": "", | |
| "operationId": "getItem", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/ItemDataWrapper" | |
| } | |
| } | |
| } | |
| }, | |
| "put": { | |
| "tags": ["items"], | |
| "summary": "Update the item with the specified ID", | |
| "description": "", | |
| "operationId": "putItem", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RequestItem" | |
| } | |
| }, { | |
| "name": "setGlobalIdManually", | |
| "in": "query", | |
| "description": "This value must be set to true if you attempt to manually set the Global ID field of an item", | |
| "required": false, | |
| "type": "boolean" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": ["items"], | |
| "summary": "Delete the item with the specified ID (item becomes inactive and can be un-deleted if necessary)", | |
| "description": "", | |
| "operationId": "deleteItem", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": ["items"], | |
| "summary": "Update the item with the specified ID", | |
| "description": "", | |
| "operationId": "patchItem", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/RequestPatchOperation" | |
| } | |
| } | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/items/{id}/comments": { | |
| "get": { | |
| "tags": ["items"], | |
| "summary": "Get all comments for the item with the specified ID", | |
| "description": "", | |
| "operationId": "getItemComments", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "rootCommentsOnly", | |
| "in": "query", | |
| "required": false, | |
| "type": "boolean", | |
| "default": false | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/CommentDataListWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/items/{id}/tags/{tagId}": { | |
| "get": { | |
| "tags": ["items"], | |
| "summary": "Get the tag with the specified ID", | |
| "description": "", | |
| "operationId": "getTagOnItem", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "tagId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/TagDataWrapper" | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": ["items"], | |
| "summary": "Remove an existing tag from the item with the specified ID", | |
| "description": "", | |
| "operationId": "removeTagFromItem", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "tagId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/items/{id}/tags": { | |
| "get": { | |
| "tags": ["items"], | |
| "summary": "Get all tags for the item with the specified ID", | |
| "description": "", | |
| "operationId": "getTagsOnItem", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/TagDataListWrapper" | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": ["items"], | |
| "summary": "Add an existing tag to the item with the specified ID", | |
| "description": "", | |
| "operationId": "addTagToItem", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RequestItemTag" | |
| } | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/CreatedResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/items/{id}/attachments": { | |
| "get": { | |
| "tags": ["items"], | |
| "summary": "Get all attachments for the item with the specified ID", | |
| "description": "", | |
| "operationId": "getAttachments", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AttachmentDataListWrapper" | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": ["items"], | |
| "summary": "Add an existing attachment to the item with the specified ID", | |
| "description": "", | |
| "operationId": "addAttachmentToItem", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RequestItemAttachment" | |
| } | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/CreatedResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/items/{id}/attachments/{attachmentId}": { | |
| "delete": { | |
| "tags": ["items"], | |
| "summary": "Remove an existing attachment from the item", | |
| "description": "", | |
| "operationId": "removeAttachmentFromItem", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "attachmentId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/items/{id}/versions/{versionNum}/versioneditem": { | |
| "get": { | |
| "tags": ["items"], | |
| "summary": "Get the snapshot of the item at the specified version", | |
| "description": "", | |
| "operationId": "getVersionedItem_2", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "versionNum", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/VersionedItemDataWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/items/{id}/versions": { | |
| "get": { | |
| "tags": ["items"], | |
| "summary": "Get all versions for the item with the specified ID", | |
| "description": "", | |
| "operationId": "getVersionsOnItem_2", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/VersionDataListWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/items/{id}/versions/{versionNum}": { | |
| "get": { | |
| "tags": ["items"], | |
| "summary": "Get the numbered version for the item with the specified ID", | |
| "description": "", | |
| "operationId": "getVersionOnItem_2", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "versionNum", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/VersionDataWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/items/{id}/duplicate": { | |
| "post": { | |
| "tags": ["items"], | |
| "summary": "Create a duplicate of item", | |
| "description": "Copies the name and description fields. Only items without children can be have a duplicate created.", | |
| "operationId": "duplicateItem", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": false, | |
| "schema": { | |
| "$ref": "#/definitions/DuplicateConfig" | |
| } | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/CreatedResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/items/{id}/workflowtransitions": { | |
| "post": { | |
| "tags": ["items"], | |
| "summary": "Executes a workflow transition for the item with the specified ID. Valid transitions can be found at /items/{id}/workflowtransitionoptions", | |
| "description": "", | |
| "operationId": "executeTransition", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RequestTransition" | |
| } | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/CreatedResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/items/{id}/upstreamrelated": { | |
| "get": { | |
| "tags": ["items"], | |
| "summary": "Get all upstream related items for the item with the specified ID", | |
| "description": "", | |
| "operationId": "getUpstreamRelated", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/ItemDataListWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/items/{id}/downstreamrelated": { | |
| "get": { | |
| "tags": ["items"], | |
| "summary": "Get all downstream related items for the item with the specified ID", | |
| "description": "", | |
| "operationId": "getDownstreamRelated", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/ItemDataListWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/items/{id}/upstreamrelationships": { | |
| "get": { | |
| "tags": ["items"], | |
| "summary": "Get all upstream relationships for the item with the specified ID", | |
| "description": "", | |
| "operationId": "getUpstreamRelationships", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/RelationshipDataListWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/items/{id}/downstreamrelationships": { | |
| "get": { | |
| "tags": ["items"], | |
| "summary": "Get all downstream relationships for the item with the specified ID", | |
| "description": "", | |
| "operationId": "getDownstreamRelationships", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/RelationshipDataListWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/items/{id}/lock": { | |
| "get": { | |
| "tags": ["items"], | |
| "summary": "Get the locked state, last locked date, and last locked by user for the item with the specified ID", | |
| "description": "", | |
| "operationId": "getLock", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/LockDataWrapper" | |
| } | |
| } | |
| } | |
| }, | |
| "put": { | |
| "tags": ["items"], | |
| "summary": "Update the locked state of the item with the specified ID", | |
| "description": "", | |
| "operationId": "updateLock", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RequestLock" | |
| } | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/items/{id}/links": { | |
| "get": { | |
| "tags": ["items"], | |
| "summary": "Get all links for the item with the specified ID", | |
| "description": "", | |
| "operationId": "getItemLinks", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/LinkDataListWrapper" | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": ["items"], | |
| "summary": "Create a new link for the item with the specified ID", | |
| "description": "", | |
| "operationId": "addItemLink", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RequestLink" | |
| } | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/CreatedResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/items/{id}/links/{linkId}": { | |
| "get": { | |
| "tags": ["items"], | |
| "summary": "Get the link with the specified ID", | |
| "description": "", | |
| "operationId": "getLinkById", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "linkId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/LinkDataWrapper" | |
| } | |
| } | |
| } | |
| }, | |
| "put": { | |
| "tags": ["items"], | |
| "summary": "Update the link with the specified ID", | |
| "description": "", | |
| "operationId": "updateItemLink", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "linkId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RequestLink" | |
| } | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": ["items"], | |
| "summary": "Delete the link with the specified ID", | |
| "description": "", | |
| "operationId": "deleteItemLink", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "linkId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/items/{id}/activities": { | |
| "get": { | |
| "tags": ["items"], | |
| "summary": "Get all activities for the item with the specified ID", | |
| "description": "", | |
| "operationId": "getActivities", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/ActivityDataListWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/items/{id}/synceditems": { | |
| "get": { | |
| "tags": ["items"], | |
| "summary": "Get all synchronized items for the item with the specified ID", | |
| "description": "", | |
| "operationId": "getSyncItems", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/ItemDataListWrapper" | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": ["items"], | |
| "summary": "Add an existing item to the Global ID pool of the item with the specified ID", | |
| "description": "", | |
| "operationId": "connectItemToGlobalIDPool", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RequestItemSyncedItem" | |
| } | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/CreatedResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/items/{id}/synceditems/{syncedItemId}/syncstatus": { | |
| "get": { | |
| "tags": ["items"], | |
| "summary": "Get the sync status for the synced item with the specified ID", | |
| "description": "", | |
| "operationId": "getSyncStatus", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "syncedItemId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/SyncStatusDataWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/items/{id}/synceditems/{syncedItemId}": { | |
| "delete": { | |
| "tags": ["items"], | |
| "summary": "Remove an existing item from the Global ID pool of the item with the specified ID (break sync)", | |
| "description": "", | |
| "operationId": "breakSyncOnItem", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "syncedItemId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/items/{id}/parent": { | |
| "get": { | |
| "tags": ["items"], | |
| "summary": "Get the parent item for the item with the specified ID", | |
| "description": "", | |
| "operationId": "getParentItem", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/ItemDataWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/items/{id}/children": { | |
| "get": { | |
| "tags": ["items"], | |
| "summary": "Get all children items for the item with the specified ID", | |
| "description": "", | |
| "operationId": "getChildItems", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/ItemDataListWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/items/{id}/workflowtransitionoptions": { | |
| "get": { | |
| "tags": ["items"], | |
| "summary": "Get all valid workflow transitions that can be made on the item with the specified ID", | |
| "description": "", | |
| "operationId": "getWorkflowTransitionOptions", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/WorkflowTransitionDataListWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/items/{id}/location": { | |
| "get": { | |
| "tags": ["items"], | |
| "summary": "Get the location for the item with the specified ID", | |
| "description": "", | |
| "operationId": "getLocation", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/LocationDataWrapper" | |
| } | |
| } | |
| } | |
| }, | |
| "put": { | |
| "tags": ["items"], | |
| "summary": "Update the location for the item with the specified ID as an asynchronous request (a successful response signifies that the work was started and a work identifier is given. This identifier will be used in a future feature). Any child items are moved along with this item. Note that this currently only supports moving items between projects", | |
| "description": "", | |
| "operationId": "updateLocation", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RequestMoveLocation" | |
| } | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/items": { | |
| "get": { | |
| "tags": ["items"], | |
| "summary": "Get all items in the project with the specified ID", | |
| "description": "", | |
| "operationId": "getItems", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "project", | |
| "in": "query", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "rootOnly", | |
| "in": "query", | |
| "description": "Set this to true to only get root-level nodes from the item tree", | |
| "required": false, | |
| "type": "boolean" | |
| }, { | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/ItemDataListWrapper" | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": ["items"], | |
| "summary": "Create a new item", | |
| "description": "", | |
| "operationId": "addItem", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RequestItem" | |
| } | |
| }, { | |
| "name": "setGlobalIdManually", | |
| "in": "query", | |
| "description": "This value must be set to true if you attempt to manually set the Global ID field of an item", | |
| "required": false, | |
| "type": "boolean" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/CreatedResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/picklists": { | |
| "get": { | |
| "tags": ["picklists"], | |
| "summary": "Get all pick lists", | |
| "description": "", | |
| "operationId": "getPickLists", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/PickListDataListWrapper" | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": ["picklists"], | |
| "summary": "Create a new pick list", | |
| "description": "", | |
| "operationId": "createPickList", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RequestPickList" | |
| } | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/picklists/{picklistId}/options": { | |
| "get": { | |
| "tags": ["picklists"], | |
| "summary": "Get all pick list options for the pick list with the specified ID", | |
| "description": "", | |
| "operationId": "getPickListOptions", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "picklistId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/PickListOptionDataListWrapper" | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": ["picklists"], | |
| "summary": "Create a new pick list option for the pick list with the specified ID", | |
| "description": "", | |
| "operationId": "addPickListOptionToPickList", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RequestPickListOption" | |
| } | |
| }, { | |
| "name": "picklistId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/CreatedResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/picklists/{picklistId}": { | |
| "get": { | |
| "tags": ["picklists"], | |
| "summary": "Get the pick list with the specified ID", | |
| "description": "", | |
| "operationId": "getPickList", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "picklistId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/PickListDataWrapper" | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": ["picklists"], | |
| "summary": "Delete the pick list", | |
| "description": "", | |
| "operationId": "deletePickList", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "picklistId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/picklistoptions/{picklistOptionId}": { | |
| "get": { | |
| "tags": ["picklistoptions"], | |
| "summary": "Get the pick list option with the specified ID", | |
| "description": "", | |
| "operationId": "getPicklistOption", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "picklistOptionId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/PickListOptionDataWrapper" | |
| } | |
| } | |
| } | |
| }, | |
| "put": { | |
| "tags": ["picklistoptions"], | |
| "summary": "Update the pick list option with the specified ID", | |
| "description": "", | |
| "operationId": "updatePicklistOption", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RequestPickListOption" | |
| } | |
| }, { | |
| "name": "picklistOptionId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/projects/{projectId}/tags": { | |
| "get": { | |
| "tags": ["projects"], | |
| "summary": "Get all tags for the project with the specified ID", | |
| "description": "", | |
| "operationId": "getTagsInProject", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "projectId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/TagDataListWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/projects/{projectId}/attachments": { | |
| "post": { | |
| "tags": ["projects"], | |
| "summary": "Create a new attachment in the project with the specified ID", | |
| "description": "", | |
| "operationId": "postAttachment", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RequestAttachment" | |
| } | |
| }, { | |
| "name": "projectId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/CreatedResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/projects/{projectId}": { | |
| "get": { | |
| "tags": ["projects"], | |
| "summary": "Get the project with the specified ID", | |
| "description": "", | |
| "operationId": "getProject", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "projectId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/ProjectDataWrapper" | |
| } | |
| } | |
| } | |
| }, | |
| "put": { | |
| "tags": ["projects"], | |
| "summary": "Update the project with the specified ID", | |
| "description": "", | |
| "operationId": "putProject", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RequestProject" | |
| } | |
| }, { | |
| "name": "projectId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/projects/{projectId}/itemtypes": { | |
| "get": { | |
| "tags": ["projects"], | |
| "summary": "Get all item types for the project with the specified ID", | |
| "description": "", | |
| "operationId": "getItemTypesInProject", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "projectId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/ItemTypeDataListWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/projects": { | |
| "get": { | |
| "tags": ["projects"], | |
| "summary": "Get all projects", | |
| "description": "", | |
| "operationId": "getProjects", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/ProjectDataListWrapper" | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": ["projects"], | |
| "summary": "Create a new project", | |
| "description": "", | |
| "operationId": "addProject", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RequestProject" | |
| } | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/CreatedResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/relationshiptypes/{id}": { | |
| "get": { | |
| "tags": ["relationshiptypes"], | |
| "summary": "Get the relationship type with the specified ID", | |
| "description": "", | |
| "operationId": "getRelationshipType", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "timestamp", | |
| "in": "query", | |
| "description": "Get relationship type at this date and time. Requires ISO8601 formatting (milliseconds or seconds) - \"yyyy-MM-dd'T'HH:mm:ss.SSSZ\" or \"yyyy-MM-dd'T'HH:mm:ssZ\"", | |
| "required": false, | |
| "type": "string" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/RelationshipTypeDataWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/relationshiptypes": { | |
| "get": { | |
| "tags": ["relationshiptypes"], | |
| "summary": "Get all relationship types", | |
| "description": "", | |
| "operationId": "getRelationshipTypes", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/RelationshipTypeDataListWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/relationships/{relationshipId}": { | |
| "get": { | |
| "tags": ["relationships"], | |
| "summary": "Get the relationship with the specified ID", | |
| "description": "", | |
| "operationId": "getRelationship", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "relationshipId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/RelationshipDataWrapper" | |
| } | |
| } | |
| } | |
| }, | |
| "put": { | |
| "tags": ["relationships"], | |
| "summary": "Update the relationship with the specified ID", | |
| "description": "", | |
| "operationId": "updateRelationship", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RequestRelationship" | |
| } | |
| }, { | |
| "name": "relationshipId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": ["relationships"], | |
| "summary": "Delete the relationship with the specified ID", | |
| "description": "", | |
| "operationId": "deleteRelationship", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "relationshipId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/relationships/{relationshipId}/suspect": { | |
| "delete": { | |
| "tags": ["relationships"], | |
| "summary": "Remove an existing suspect link for the relationship with the specified ID", | |
| "description": "", | |
| "operationId": "clearSuspectLink", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "relationshipId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/relationships": { | |
| "get": { | |
| "tags": ["relationships"], | |
| "summary": "Get all relationships in the project with the specified ID", | |
| "description": "", | |
| "operationId": "getRelationships", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "project", | |
| "in": "query", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/RelationshipDataListWrapper" | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": ["relationships"], | |
| "summary": "Create a new relationship", | |
| "description": "", | |
| "operationId": "createRelationship", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RequestRelationship" | |
| } | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/CreatedResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/releases": { | |
| "get": { | |
| "tags": ["releases"], | |
| "summary": "Get all releases in the project with the specified ID", | |
| "description": "", | |
| "operationId": "getReleases", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "project", | |
| "in": "query", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/ReleaseDataListWrapper" | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": ["releases"], | |
| "summary": "Create a new release", | |
| "description": "", | |
| "operationId": "addRelease", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RequestRelease" | |
| } | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/CreatedResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/releases/{releaseId}": { | |
| "get": { | |
| "tags": ["releases"], | |
| "summary": "Get the release with the specified ID", | |
| "description": "", | |
| "operationId": "getRelease", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "releaseId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/ReleaseDataWrapper" | |
| } | |
| } | |
| } | |
| }, | |
| "put": { | |
| "tags": ["releases"], | |
| "summary": "Update the release with the specified ID", | |
| "description": "", | |
| "operationId": "putRelease", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RequestRelease" | |
| } | |
| }, { | |
| "name": "releaseId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/system/settings/corsdomains": { | |
| "get": { | |
| "tags": ["system"], | |
| "summary": "Get the current CORS domain whitelist", | |
| "description": "", | |
| "operationId": "getDomains", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/CrossOriginDomainWhiteList" | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": ["system"], | |
| "summary": "Update CORS domain whitelist", | |
| "description": "", | |
| "operationId": "setDomains", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/CrossOriginDomainWhiteList" | |
| } | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/tags/{id}": { | |
| "get": { | |
| "tags": ["tags"], | |
| "summary": "Get the tag with the specified ID", | |
| "description": "", | |
| "operationId": "getTag", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/TagDataWrapper" | |
| } | |
| } | |
| } | |
| }, | |
| "put": { | |
| "tags": ["tags"], | |
| "summary": "Update the tag with the specified ID", | |
| "description": "", | |
| "operationId": "putTag", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RequestTag" | |
| } | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": ["tags"], | |
| "summary": "Delete the tag with the specified ID", | |
| "description": "", | |
| "operationId": "deleteTag", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/tags/{id}/items": { | |
| "get": { | |
| "tags": ["tags"], | |
| "summary": "Get all items that have the tag with the specified ID", | |
| "description": "", | |
| "operationId": "getItemsUsingTag", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/ItemDataListWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/tags": { | |
| "get": { | |
| "tags": ["tags"], | |
| "summary": "Get all tags for the project with the specified ID", | |
| "description": "", | |
| "operationId": "getTagsInProject", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "project", | |
| "in": "query", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/TagDataListWrapper" | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": ["tags"], | |
| "summary": "Create a new tag in the project with the specified ID", | |
| "description": "", | |
| "operationId": "addTagToProject", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RequestTag" | |
| } | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/CreatedResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/testcycles/{testCycleId}/testruns": { | |
| "get": { | |
| "tags": ["testcycles"], | |
| "summary": "Get all test runs for the test cycle with the specified ID", | |
| "description": "", | |
| "operationId": "getTestRuns", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "testCycleId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/TestRunDataListWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/testcycles/{testCycleId}": { | |
| "get": { | |
| "tags": ["testcycles"], | |
| "summary": "Get the test cycle with the specified ID", | |
| "description": "", | |
| "operationId": "getTestCycle", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "testCycleId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/TestCycleDataWrapper" | |
| } | |
| } | |
| } | |
| }, | |
| "put": { | |
| "tags": ["testcycles"], | |
| "summary": "Update the test cycle with the specified ID, including regenerating the test runs in the test cycle", | |
| "description": "", | |
| "operationId": "updateTestCycle", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RequestTestCycle" | |
| } | |
| }, { | |
| "name": "testCycleId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": ["testcycles"], | |
| "summary": "Delete the test cycle with the specified ID, including the test runs in the test cycle", | |
| "description": "", | |
| "operationId": "deleteTestCycle", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "testCycleId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": ["testcycles"], | |
| "summary": "Update the test cycle with the specified ID, including regenerating the test runs in the test cycle", | |
| "description": "", | |
| "operationId": "patchTestCycle", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/RequestPatchOperation" | |
| } | |
| } | |
| }, { | |
| "name": "testCycleId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/testcycles/{testCycleId}/versions/{versionNum}/versioneditem": { | |
| "get": { | |
| "tags": ["testcycles"], | |
| "summary": "Get the snapshot of the test cycle at the specified version", | |
| "description": "", | |
| "operationId": "getVersionedItem_3", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "versionNum", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "testCycleId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/VersionedTestCycleDataWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/testcycles/{testCycleId}/versions": { | |
| "get": { | |
| "tags": ["testcycles"], | |
| "summary": "Get all versions for the item with the specified ID", | |
| "description": "", | |
| "operationId": "getVersionsOnItem_3", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "testCycleId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/VersionDataListWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/testcycles/{testCycleId}/versions/{versionNum}": { | |
| "get": { | |
| "tags": ["testcycles"], | |
| "summary": "Get the numbered version for the item with the specified ID", | |
| "description": "", | |
| "operationId": "getVersionOnItem_3", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "versionNum", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "testCycleId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/VersionDataWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/testcycles/{testCycleId}/testgroup/{testGroupId}": { | |
| "get": { | |
| "tags": ["testcycles"], | |
| "summary": "Get the test cycle test group for the test cycle with the specified ID", | |
| "description": "", | |
| "operationId": "getTestCycleTestGroup", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "testGroupId", | |
| "in": "path", | |
| "description": "Get the test group with the specified ID", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "testCycleId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/TestCycleTestGroupDataWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/testplans/{id}/comments": { | |
| "get": { | |
| "tags": ["testplans"], | |
| "summary": "Get all comments for the item with the specified ID", | |
| "description": "", | |
| "operationId": "getItemComments", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "rootCommentsOnly", | |
| "in": "query", | |
| "required": false, | |
| "type": "boolean", | |
| "default": false | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/CommentDataListWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/testplans/{id}/tags/{tagId}": { | |
| "get": { | |
| "tags": ["testplans"], | |
| "summary": "Get the tag with the specified ID", | |
| "description": "", | |
| "operationId": "getTagOnItem", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "tagId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/TagDataWrapper" | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": ["testplans"], | |
| "summary": "Remove an existing tag from the item with the specified ID", | |
| "description": "", | |
| "operationId": "removeTagFromItem", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "tagId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/testplans/{id}/tags": { | |
| "get": { | |
| "tags": ["testplans"], | |
| "summary": "Get all tags for the item with the specified ID", | |
| "description": "", | |
| "operationId": "getTagsOnItem", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/TagDataListWrapper" | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": ["testplans"], | |
| "summary": "Add an existing tag to the item with the specified ID", | |
| "description": "", | |
| "operationId": "addTagToItem", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RequestItemTag" | |
| } | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/CreatedResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/testplans/{id}/attachments": { | |
| "get": { | |
| "tags": ["testplans"], | |
| "summary": "Get all attachments for the item with the specified ID", | |
| "description": "", | |
| "operationId": "getAttachments", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AttachmentDataListWrapper" | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": ["testplans"], | |
| "summary": "Add an existing attachment to the item with the specified ID", | |
| "description": "", | |
| "operationId": "addAttachmentToItem", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RequestItemAttachment" | |
| } | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/CreatedResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/testplans/{id}/attachments/{attachmentId}": { | |
| "delete": { | |
| "tags": ["testplans"], | |
| "summary": "Remove an existing attachment from the item", | |
| "description": "", | |
| "operationId": "removeAttachmentFromItem", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "attachmentId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/testplans/{id}": { | |
| "get": { | |
| "tags": ["testplans"], | |
| "summary": "Get the test plan with the specified ID", | |
| "description": "", | |
| "operationId": "getTestPlan", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/TestPlanDataWrapper" | |
| } | |
| } | |
| } | |
| }, | |
| "put": { | |
| "tags": ["testplans"], | |
| "summary": "Update the test plan with the specified ID", | |
| "description": "", | |
| "operationId": "updateTestPlan", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RequestTestPlan" | |
| } | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": ["testplans"], | |
| "summary": "Delete the test plan with the specified ID", | |
| "description": "", | |
| "operationId": "deleteTestPlan", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": ["testplans"], | |
| "summary": "Update the test plan with the specified ID", | |
| "description": "", | |
| "operationId": "patchTestPlan", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/RequestPatchOperation" | |
| } | |
| } | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/testplans/{id}/testcycles": { | |
| "get": { | |
| "tags": ["testplans"], | |
| "summary": "Get all test cycles for the test plan with the specified ID", | |
| "description": "", | |
| "operationId": "getTestCycles", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/TestCycleDataListWrapper" | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": ["testplans"], | |
| "summary": "Create a new test cycle", | |
| "description": "", | |
| "operationId": "createTestCycle", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RequestTestCycle" | |
| } | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/CreatedResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/testplans/{id}/versions/{versionNum}/versioneditem": { | |
| "get": { | |
| "tags": ["testplans"], | |
| "summary": "Get the snapshot of the test plan at the specified version", | |
| "description": "", | |
| "operationId": "getVersionedItem_4", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "versionNum", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/VersionedTestPlanDataWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/testplans/{id}/versions": { | |
| "get": { | |
| "tags": ["testplans"], | |
| "summary": "Get all versions for the item with the specified ID", | |
| "description": "", | |
| "operationId": "getVersionsOnItem_4", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/VersionDataListWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/testplans/{id}/versions/{versionNum}": { | |
| "get": { | |
| "tags": ["testplans"], | |
| "summary": "Get the numbered version for the item with the specified ID", | |
| "description": "", | |
| "operationId": "getVersionOnItem_4", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "versionNum", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/VersionDataWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/testplans/{id}/upstreamrelated": { | |
| "get": { | |
| "tags": ["testplans"], | |
| "summary": "Get all upstream related items for the test plan with the specified ID", | |
| "description": "", | |
| "operationId": "getUpstreamRelated", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractItemDataListWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/testplans/{id}/downstreamrelated": { | |
| "get": { | |
| "tags": ["testplans"], | |
| "summary": "Get all downstream related items for the test plan with the specified ID", | |
| "description": "", | |
| "operationId": "getDownstreamRelated", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractItemDataListWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/testplans/{id}/upstreamrelationships": { | |
| "get": { | |
| "tags": ["testplans"], | |
| "summary": "Get all upstream relationships for the test plan with the specified ID", | |
| "description": "", | |
| "operationId": "getUpstreamRelationships", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/RelationshipDataListWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/testplans/{id}/downstreamrelationships": { | |
| "get": { | |
| "tags": ["testplans"], | |
| "summary": "Get all downstream relationships for the test plan with the specified ID", | |
| "description": "", | |
| "operationId": "getDownstreamRelationships", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/RelationshipDataListWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/testplans/{id}/lock": { | |
| "get": { | |
| "tags": ["testplans"], | |
| "summary": "Get the locked state, last locked date, and last locked by user for the item with the specified ID", | |
| "description": "", | |
| "operationId": "getLock", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/LockDataWrapper" | |
| } | |
| } | |
| } | |
| }, | |
| "put": { | |
| "tags": ["testplans"], | |
| "summary": "Update the locked state of the item with the specified ID", | |
| "description": "", | |
| "operationId": "updateLock", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RequestLock" | |
| } | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/testplans/{id}/links": { | |
| "get": { | |
| "tags": ["testplans"], | |
| "summary": "Get all links for the item with the specified ID", | |
| "description": "", | |
| "operationId": "getItemLinks", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/LinkDataListWrapper" | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": ["testplans"], | |
| "summary": "Create a new link for the item with the specified ID", | |
| "description": "", | |
| "operationId": "addItemLink", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RequestLink" | |
| } | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/CreatedResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/testplans/{id}/links/{linkId}": { | |
| "get": { | |
| "tags": ["testplans"], | |
| "summary": "Get the link with the specified ID", | |
| "description": "", | |
| "operationId": "getLinkById", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "linkId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/LinkDataWrapper" | |
| } | |
| } | |
| } | |
| }, | |
| "put": { | |
| "tags": ["testplans"], | |
| "summary": "Update the link with the specified ID", | |
| "description": "", | |
| "operationId": "updateItemLink", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "linkId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RequestLink" | |
| } | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": ["testplans"], | |
| "summary": "Delete the link with the specified ID", | |
| "description": "", | |
| "operationId": "deleteItemLink", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "linkId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/testplans/{id}/activities": { | |
| "get": { | |
| "tags": ["testplans"], | |
| "summary": "Get all activities for the test plan with the specified ID", | |
| "description": "", | |
| "operationId": "getActivities", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/ActivityDataListWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/testplans/{id}/archived": { | |
| "put": { | |
| "tags": ["testplans"], | |
| "summary": "Update the archived status of the test plan", | |
| "description": "", | |
| "operationId": "toggleArchivedStatus", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RequestArchivedStatus" | |
| } | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/testplans/{id}/testgroups/{testGroupId}/testcases": { | |
| "get": { | |
| "tags": ["testplans"], | |
| "summary": "Get all test cases associated with the test group with the specified ID", | |
| "description": "", | |
| "operationId": "getTestCases", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "testGroupId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/ItemDataListWrapper" | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": ["testplans"], | |
| "summary": "Add an existing test case to the test group with the specified ID", | |
| "description": "", | |
| "operationId": "postTestCase", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RequestTestGroupTestCase" | |
| } | |
| }, { | |
| "name": "testGroupId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/CreatedResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/testplans/{id}/testgroups/{testGroupId}/testcases/{testCaseId}": { | |
| "get": { | |
| "tags": ["testplans"], | |
| "summary": "Get the test case with the specified ID", | |
| "description": "", | |
| "operationId": "getTestCaseById", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "testCaseId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "testGroupId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/ItemDataWrapper" | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": ["testplans"], | |
| "summary": "Remove an existing test case from the test group", | |
| "description": "", | |
| "operationId": "deleteTestCase", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "testCaseId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "testGroupId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/testplans/{id}/testgroups": { | |
| "get": { | |
| "tags": ["testplans"], | |
| "summary": "Get all test groups for the test plan with the specified ID", | |
| "description": "", | |
| "operationId": "getTestGroups", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/TestGroupDataListWrapper" | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": ["testplans"], | |
| "summary": "Create a new test group to the test plan with the specified ID", | |
| "description": "", | |
| "operationId": "addTestGroup", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RequestTestGroup" | |
| } | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/CreatedResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/testplans/{id}/testgroups/{testGroupId}": { | |
| "get": { | |
| "tags": ["testplans"], | |
| "summary": "Get the test group with the specified ID", | |
| "description": "", | |
| "operationId": "getTestGroupById", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "testGroupId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/TestGroupDataWrapper" | |
| } | |
| } | |
| } | |
| }, | |
| "put": { | |
| "tags": ["testplans"], | |
| "summary": "Update the test group with the specified ID", | |
| "description": "", | |
| "operationId": "updateTestGroup", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "testGroupId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RequestTestGroup" | |
| } | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": ["testplans"], | |
| "summary": "Delete the test group with the specified ID", | |
| "description": "", | |
| "operationId": "deleteTestGroup", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "testGroupId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/testplans": { | |
| "get": { | |
| "tags": ["testplans"], | |
| "summary": "Get all test plans in the project with the specified ID", | |
| "description": "", | |
| "operationId": "getTestPlans", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "project", | |
| "in": "query", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/TestPlanDataListWrapper" | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": ["testplans"], | |
| "summary": "Create a new test plan", | |
| "description": "", | |
| "operationId": "createTestPlan", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RequestTestPlan" | |
| } | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/CreatedResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/testruns/{id}/comments": { | |
| "get": { | |
| "tags": ["testruns"], | |
| "summary": "Get all comments for the item with the specified ID", | |
| "description": "", | |
| "operationId": "getItemComments", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "rootCommentsOnly", | |
| "in": "query", | |
| "required": false, | |
| "type": "boolean", | |
| "default": false | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/CommentDataListWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/testruns/{id}/tags/{tagId}": { | |
| "get": { | |
| "tags": ["testruns"], | |
| "summary": "Get the tag with the specified ID", | |
| "description": "", | |
| "operationId": "getTagOnItem", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "tagId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/TagDataWrapper" | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": ["testruns"], | |
| "summary": "Remove an existing tag from the item with the specified ID", | |
| "description": "", | |
| "operationId": "removeTagFromItem", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "tagId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/testruns/{id}/tags": { | |
| "get": { | |
| "tags": ["testruns"], | |
| "summary": "Get all tags for the item with the specified ID", | |
| "description": "", | |
| "operationId": "getTagsOnItem", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/TagDataListWrapper" | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": ["testruns"], | |
| "summary": "Add an existing tag to the item with the specified ID", | |
| "description": "", | |
| "operationId": "addTagToItem", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RequestItemTag" | |
| } | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/CreatedResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/testruns/{id}/attachments": { | |
| "get": { | |
| "tags": ["testruns"], | |
| "summary": "Get all attachments for the item with the specified ID", | |
| "description": "", | |
| "operationId": "getAttachments", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AttachmentDataListWrapper" | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": ["testruns"], | |
| "summary": "Add an existing attachment to the item with the specified ID", | |
| "description": "", | |
| "operationId": "addAttachmentToItem", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RequestItemAttachment" | |
| } | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/CreatedResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/testruns/{id}/attachments/{attachmentId}": { | |
| "delete": { | |
| "tags": ["testruns"], | |
| "summary": "Remove an existing attachment from the item", | |
| "description": "", | |
| "operationId": "removeAttachmentFromItem", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "attachmentId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/testruns/{id}": { | |
| "get": { | |
| "tags": ["testruns"], | |
| "summary": "Get the test run with the specified ID", | |
| "description": "", | |
| "operationId": "getTestRun", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/TestRunDataWrapper" | |
| } | |
| } | |
| } | |
| }, | |
| "put": { | |
| "tags": ["testruns"], | |
| "summary": "Update the execution results for the test run with the specified ID", | |
| "description": "", | |
| "operationId": "updateTestRun", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RequestTestRun" | |
| } | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": ["testruns"], | |
| "summary": "Delete the test run with the specified ID", | |
| "description": "", | |
| "operationId": "deleteTestRun", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": ["testruns"], | |
| "summary": "Update the execution results for the test run with the specified ID", | |
| "description": "", | |
| "operationId": "patchTestRun", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/RequestPatchOperation" | |
| } | |
| } | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/testruns/{id}/updatedtestcase": { | |
| "post": { | |
| "tags": ["testruns"], | |
| "summary": "Delete the current test run and then create a new test run based on the latest test case version.", | |
| "description": "", | |
| "operationId": "makeTestRunCurrent", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/CreatedResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/testruns/{id}/versions/{versionNum}/versioneditem": { | |
| "get": { | |
| "tags": ["testruns"], | |
| "summary": "Get the snapshot of the test run at the specified version", | |
| "description": "", | |
| "operationId": "getVersionedItem_5", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "versionNum", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/VersionedTestRunDataWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/testruns/{id}/versions": { | |
| "get": { | |
| "tags": ["testruns"], | |
| "summary": "Get all versions for the item with the specified ID", | |
| "description": "", | |
| "operationId": "getVersionsOnItem_5", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/VersionDataListWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/testruns/{id}/versions/{versionNum}": { | |
| "get": { | |
| "tags": ["testruns"], | |
| "summary": "Get the numbered version for the item with the specified ID", | |
| "description": "", | |
| "operationId": "getVersionOnItem_5", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "versionNum", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/VersionDataWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/testruns/{id}/upstreamrelated": { | |
| "get": { | |
| "tags": ["testruns"], | |
| "summary": "Get all upstream related items for the test run with the specified ID", | |
| "description": "", | |
| "operationId": "getUpstreamRelated", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractItemDataListWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/testruns/{id}/downstreamrelated": { | |
| "get": { | |
| "tags": ["testruns"], | |
| "summary": "Get all downstream related items for the test run with the specified ID", | |
| "description": "", | |
| "operationId": "getDownstreamRelated", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractItemDataListWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/testruns/{id}/upstreamrelationships": { | |
| "get": { | |
| "tags": ["testruns"], | |
| "summary": "Get all upstream relationships for the test run with the specified ID", | |
| "description": "", | |
| "operationId": "getUpstreamRelationships", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/RelationshipDataListWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/testruns/{id}/downstreamrelationships": { | |
| "get": { | |
| "tags": ["testruns"], | |
| "summary": "Get all downstream relationships for the test run with the specified ID", | |
| "description": "", | |
| "operationId": "getDownstreamRelationships", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/RelationshipDataListWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/testruns/{id}/lock": { | |
| "get": { | |
| "tags": ["testruns"], | |
| "summary": "Get the locked state, last locked date, and last locked by user for the item with the specified ID", | |
| "description": "", | |
| "operationId": "getLock", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/LockDataWrapper" | |
| } | |
| } | |
| } | |
| }, | |
| "put": { | |
| "tags": ["testruns"], | |
| "summary": "Update the locked state of the item with the specified ID", | |
| "description": "", | |
| "operationId": "updateLock", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RequestLock" | |
| } | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/testruns/{id}/links": { | |
| "get": { | |
| "tags": ["testruns"], | |
| "summary": "Get all links for the item with the specified ID", | |
| "description": "", | |
| "operationId": "getItemLinks", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/LinkDataListWrapper" | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": ["testruns"], | |
| "summary": "Create a new link for the item with the specified ID", | |
| "description": "", | |
| "operationId": "addItemLink", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RequestLink" | |
| } | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/CreatedResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/testruns/{id}/links/{linkId}": { | |
| "get": { | |
| "tags": ["testruns"], | |
| "summary": "Get the link with the specified ID", | |
| "description": "", | |
| "operationId": "getLinkById", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "linkId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/LinkDataWrapper" | |
| } | |
| } | |
| } | |
| }, | |
| "put": { | |
| "tags": ["testruns"], | |
| "summary": "Update the link with the specified ID", | |
| "description": "", | |
| "operationId": "updateItemLink", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "linkId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RequestLink" | |
| } | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": ["testruns"], | |
| "summary": "Delete the link with the specified ID", | |
| "description": "", | |
| "operationId": "deleteItemLink", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "linkId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/testruns/{id}/activities": { | |
| "get": { | |
| "tags": ["testruns"], | |
| "summary": "Get all activities for the test run with the specified ID", | |
| "description": "", | |
| "operationId": "getActivities", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/ActivityDataListWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/testruns": { | |
| "get": { | |
| "tags": ["testruns"], | |
| "summary": "Search for test runs associated with test cases, test plans, an test cycles", | |
| "description": "Must include at least one query parameter from testCycle, testCase, or testPlan", | |
| "operationId": "getTestRuns", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "testCycle", | |
| "in": "query", | |
| "description": "Filter by test runs in test cycle id", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "testCase", | |
| "in": "query", | |
| "description": "Filter by test runs from test case id", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "testPlan", | |
| "in": "query", | |
| "description": "Filter by test runs in test plan id", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "sortBy", | |
| "in": "query", | |
| "description": "Sort orders can be added with the name of the field by which to sort, followed by .asc or .desc (e.g. 'name.asc' or 'testCycle.desc'). If not set, this defaults to documentKey.asc.", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/TestRunDataListWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/usergroups/{id}": { | |
| "get": { | |
| "tags": ["usergroups"], | |
| "summary": "Get the user group with the specified ID", | |
| "description": "", | |
| "operationId": "getGroup", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/UserGroupDataWrapper" | |
| } | |
| } | |
| } | |
| }, | |
| "put": { | |
| "tags": ["usergroups"], | |
| "summary": "Update the user group with the specified ID", | |
| "description": "", | |
| "operationId": "updateUserGroup", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RequestUserGroup" | |
| } | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": ["usergroups"], | |
| "summary": "Delete the user group with the specified ID", | |
| "description": "", | |
| "operationId": "deleteItem", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/usergroups/{id}/users": { | |
| "get": { | |
| "tags": ["usergroups"], | |
| "summary": "Get all users for the user group with the specified ID", | |
| "description": "", | |
| "operationId": "getGroupUsers", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/UserDataListWrapper" | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": ["usergroups"], | |
| "summary": "Add an existing user to the user group with the specified ID", | |
| "description": "", | |
| "operationId": "addUserToGroup", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RequestGroupUser" | |
| } | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/CreatedResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/usergroups/{id}/users/{userId}": { | |
| "delete": { | |
| "tags": ["usergroups"], | |
| "summary": "Remove an existing user from the user group with the specified ID", | |
| "description": "", | |
| "operationId": "removeUserFromGroup", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "userId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/usergroups": { | |
| "get": { | |
| "tags": ["usergroups"], | |
| "summary": "Get all user groups", | |
| "description": "", | |
| "operationId": "getUsers", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "project", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/UserGroupDataListWrapper" | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": ["usergroups"], | |
| "summary": "Create a new user group", | |
| "description": "", | |
| "operationId": "addUserGroup", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RequestUserGroup" | |
| } | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/CreatedResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/users/{userId}": { | |
| "get": { | |
| "tags": ["users"], | |
| "summary": "Get the user with the specified ID", | |
| "description": "", | |
| "operationId": "getUser", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, { | |
| "name": "userId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/UserDataWrapper" | |
| } | |
| } | |
| } | |
| }, | |
| "put": { | |
| "tags": ["users"], | |
| "summary": "Update the user with the specified ID", | |
| "description": "", | |
| "operationId": "putUser", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RequestUser" | |
| } | |
| }, { | |
| "name": "userId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/users/{userId}/active": { | |
| "put": { | |
| "tags": ["users"], | |
| "summary": "Update the active status for the user with the specified ID", | |
| "description": "", | |
| "operationId": "setActiveStatus", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RequestActiveStatus" | |
| } | |
| }, { | |
| "name": "userId", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AbstractRestResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/users/current": { | |
| "get": { | |
| "tags": ["users"], | |
| "summary": "Gets the current user", | |
| "description": "", | |
| "operationId": "getCurrentUser", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/UserDataWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/users": { | |
| "get": { | |
| "tags": ["users"], | |
| "summary": "Get all users", | |
| "description": "", | |
| "operationId": "getUsers", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "username", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| }, { | |
| "name": "email", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| }, { | |
| "name": "firstName", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| }, { | |
| "name": "lastName", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| }, { | |
| "name": "licenseType", | |
| "in": "query", | |
| "required": false, | |
| "type": "string", | |
| "enum": ["NAMED", "FLOATING", "STAKEHOLDER", "NAMED_REVIEWER", "RESERVED_COLLABORATOR", "TEST_RUNNER", "EXPIRING_TRIAL", "INACTIVE", "FLOATING_COLLABORATOR", "FLOATING_REVIEWER", "RESERVED_REVIEWER"] | |
| }, { | |
| "name": "includeInactive", | |
| "in": "query", | |
| "required": false, | |
| "type": "boolean" | |
| }, { | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/UserDataListWrapper" | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": ["users"], | |
| "summary": "Create a new user", | |
| "description": "", | |
| "operationId": "addUser", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "in": "body", | |
| "name": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RequestUser" | |
| } | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/CreatedResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/users/current/favoritefilters": { | |
| "get": { | |
| "tags": ["users"], | |
| "summary": "Gets the current user's favorite filters", | |
| "description": "", | |
| "operationId": "getFavoriteFiltersForCurrentUser", | |
| "consumes": ["application/json"], | |
| "produces": ["application/json"], | |
| "parameters": [{ | |
| "name": "startAt", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "If not set, this defaults to 20. This cannot be larger than 50", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| }, { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Links to include as full objects in the linked map", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/FilterDataListWrapper" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "securityDefinitions": { | |
| "basic": { | |
| "type": "basic" | |
| }, | |
| "oauth2": { | |
| "type": "oauth2", | |
| "flow": "password", | |
| "scopes": { | |
| "token_information": "main scope for using Jama REST API" | |
| } | |
| } | |
| }, | |
| "definitions": { | |
| "AbstractItem": { | |
| "type": "object", | |
| "required": ["createdBy", "createdDate", "documentKey", "fields", "globalId", "id", "itemType", "lastActivityDate", "modifiedBy", "modifiedDate", "project", "resources"], | |
| "properties": { | |
| "id": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 1 | |
| }, | |
| "documentKey": { | |
| "type": "string", | |
| "position": 3 | |
| }, | |
| "globalId": { | |
| "type": "string", | |
| "position": 5 | |
| }, | |
| "project": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 7, | |
| "description": "ID of a project" | |
| }, | |
| "itemType": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 9, | |
| "description": "ID of an item type" | |
| }, | |
| "createdDate": { | |
| "type": "string", | |
| "format": "date-time", | |
| "position": 11 | |
| }, | |
| "modifiedDate": { | |
| "type": "string", | |
| "format": "date-time", | |
| "position": 13 | |
| }, | |
| "lastActivityDate": { | |
| "type": "string", | |
| "format": "date-time", | |
| "position": 14 | |
| }, | |
| "createdBy": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 15, | |
| "description": "ID of a user" | |
| }, | |
| "modifiedBy": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 17, | |
| "description": "ID of a user" | |
| }, | |
| "resources": { | |
| "type": "object", | |
| "position": 95, | |
| "description": "A set of resources and allowed permissions", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/AllowedResource" | |
| } | |
| }, | |
| "fields": { | |
| "type": "object", | |
| "position": 99, | |
| "description": "A map of field names to field values e.g. {\"name\":\"Sample Item\", \"status\": 292, \"release\": 2, \"assigned\": 23}", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "AbstractItemDataWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/definitions/AbstractItem" | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaWrapper" | |
| } | |
| } | |
| }, | |
| "AllowedResource": { | |
| "type": "object", | |
| "properties": { | |
| "allowed": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "Link": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "href": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "MetaWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "status": { | |
| "type": "string", | |
| "enum": ["OK", "CREATED", "ACCEPTED", "NO_CONTENT", "RESET_CONTENT", "PARTIAL_CONTENT", "MOVED_PERMANENTLY", "FOUND", "SEE_OTHER", "NOT_MODIFIED", "USE_PROXY", "TEMPORARY_REDIRECT", "BAD_REQUEST", "UNAUTHORIZED", "PAYMENT_REQUIRED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "NOT_ACCEPTABLE", "PROXY_AUTHENTICATION_REQUIRED", "REQUEST_TIMEOUT", "CONFLICT", "GONE", "LENGTH_REQUIRED", "PRECONDITION_FAILED", "REQUEST_ENTITY_TOO_LARGE", "REQUEST_URI_TOO_LONG", "UNSUPPORTED_MEDIA_TYPE", "REQUESTED_RANGE_NOT_SATISFIABLE", "EXPECTATION_FAILED", "PRECONDITION_REQUIRED", "TOO_MANY_REQUESTS", "REQUEST_HEADER_FIELDS_TOO_LARGE", "INTERNAL_SERVER_ERROR", "NOT_IMPLEMENTED", "BAD_GATEWAY", "SERVICE_UNAVAILABLE", "GATEWAY_TIMEOUT", "HTTP_VERSION_NOT_SUPPORTED", "NETWORK_AUTHENTICATION_REQUIRED"] | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| } | |
| } | |
| }, | |
| "Item": { | |
| "type": "object", | |
| "required": ["childItemType", "createdBy", "createdDate", "documentKey", "fields", "globalId", "id", "itemType", "lastActivityDate", "location", "lock", "modifiedBy", "modifiedDate", "project", "resources"], | |
| "properties": { | |
| "id": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 1 | |
| }, | |
| "documentKey": { | |
| "type": "string", | |
| "position": 3 | |
| }, | |
| "globalId": { | |
| "type": "string", | |
| "position": 5 | |
| }, | |
| "project": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 7, | |
| "description": "ID of a project" | |
| }, | |
| "itemType": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 9, | |
| "description": "ID of an item type" | |
| }, | |
| "childItemType": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 10, | |
| "description": "ID of an item type" | |
| }, | |
| "createdDate": { | |
| "type": "string", | |
| "format": "date-time", | |
| "position": 11 | |
| }, | |
| "modifiedDate": { | |
| "type": "string", | |
| "format": "date-time", | |
| "position": 13 | |
| }, | |
| "lastActivityDate": { | |
| "type": "string", | |
| "format": "date-time", | |
| "position": 14 | |
| }, | |
| "createdBy": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 15, | |
| "description": "ID of a user" | |
| }, | |
| "modifiedBy": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 17, | |
| "description": "ID of a user" | |
| }, | |
| "lock": { | |
| "position": 25, | |
| "$ref": "#/definitions/Lock" | |
| }, | |
| "location": { | |
| "position": 35, | |
| "$ref": "#/definitions/Location" | |
| }, | |
| "resources": { | |
| "type": "object", | |
| "position": 95, | |
| "description": "A set of resources and allowed permissions", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/AllowedResource" | |
| } | |
| }, | |
| "fields": { | |
| "type": "object", | |
| "position": 99, | |
| "description": "A map of field names to field values e.g. {\"name\":\"Sample Item\", \"status\": 292, \"release\": 2, \"assigned\": 23}", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "ItemDataListWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Item" | |
| } | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaListWrapper" | |
| } | |
| } | |
| }, | |
| "Location": { | |
| "type": "object", | |
| "required": ["globalSortOrder", "parent", "sequence", "sortOrder"], | |
| "properties": { | |
| "sortOrder": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "globalSortOrder": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The relative position of an item within its project. Deprecated. Use sequence instead." | |
| }, | |
| "sequence": { | |
| "type": "string" | |
| }, | |
| "parent": { | |
| "$ref": "#/definitions/Parent" | |
| } | |
| } | |
| }, | |
| "Lock": { | |
| "type": "object", | |
| "required": ["lastLockedDate", "locked", "lockedBy"], | |
| "properties": { | |
| "locked": { | |
| "type": "boolean" | |
| }, | |
| "lastLockedDate": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "lockedBy": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "ID of a user" | |
| } | |
| } | |
| }, | |
| "MetaListWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "pageInfo": { | |
| "$ref": "#/definitions/PageInfo" | |
| }, | |
| "status": { | |
| "type": "string", | |
| "enum": ["OK", "CREATED", "ACCEPTED", "NO_CONTENT", "RESET_CONTENT", "PARTIAL_CONTENT", "MOVED_PERMANENTLY", "FOUND", "SEE_OTHER", "NOT_MODIFIED", "USE_PROXY", "TEMPORARY_REDIRECT", "BAD_REQUEST", "UNAUTHORIZED", "PAYMENT_REQUIRED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "NOT_ACCEPTABLE", "PROXY_AUTHENTICATION_REQUIRED", "REQUEST_TIMEOUT", "CONFLICT", "GONE", "LENGTH_REQUIRED", "PRECONDITION_FAILED", "REQUEST_ENTITY_TOO_LARGE", "REQUEST_URI_TOO_LONG", "UNSUPPORTED_MEDIA_TYPE", "REQUESTED_RANGE_NOT_SATISFIABLE", "EXPECTATION_FAILED", "PRECONDITION_REQUIRED", "TOO_MANY_REQUESTS", "REQUEST_HEADER_FIELDS_TOO_LARGE", "INTERNAL_SERVER_ERROR", "NOT_IMPLEMENTED", "BAD_GATEWAY", "SERVICE_UNAVAILABLE", "GATEWAY_TIMEOUT", "HTTP_VERSION_NOT_SUPPORTED", "NETWORK_AUTHENTICATION_REQUIRED"] | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| } | |
| } | |
| }, | |
| "PageInfo": { | |
| "type": "object", | |
| "properties": { | |
| "startIndex": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "resultCount": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "totalResults": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| } | |
| }, | |
| "Parent": { | |
| "type": "object", | |
| "required": ["item", "project"], | |
| "properties": { | |
| "project": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "ID of a project" | |
| }, | |
| "item": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "ID of an item" | |
| } | |
| } | |
| }, | |
| "AbstractVersionedItem": { | |
| "type": "object", | |
| "properties": { | |
| "version": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "id": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "currentVersion": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "Currently active version of the versioned item. If no version is active, currentVersion will not be returned." | |
| }, | |
| "type": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "AbstractVersionedItemDataWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/definitions/AbstractVersionedItem" | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaWrapper" | |
| } | |
| } | |
| }, | |
| "Version": { | |
| "type": "object", | |
| "required": ["changeDetails", "comment", "createdBy", "createdDate", "item", "versionNumber", "versionedItem"], | |
| "properties": { | |
| "versionedItem": { | |
| "type": "array", | |
| "description": "Item ID and version number for a versioned item", | |
| "items": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| "type": { | |
| "type": "string" | |
| }, | |
| "item": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 10, | |
| "description": "ID of an item" | |
| }, | |
| "versionNumber": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 20 | |
| }, | |
| "changeDetails": { | |
| "type": "string", | |
| "position": 30 | |
| }, | |
| "comment": { | |
| "type": "string", | |
| "position": 40 | |
| }, | |
| "createdDate": { | |
| "type": "string", | |
| "format": "date-time", | |
| "position": 50 | |
| }, | |
| "createdBy": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 60, | |
| "description": "ID of a user" | |
| } | |
| } | |
| }, | |
| "VersionDataListWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Version" | |
| } | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaListWrapper" | |
| } | |
| } | |
| }, | |
| "VersionDataWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/definitions/Version" | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaWrapper" | |
| } | |
| } | |
| }, | |
| "VersionedRelationship": { | |
| "type": "object", | |
| "required": ["fromItem", "id", "relationshipType", "suspect", "toItem"], | |
| "properties": { | |
| "id": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 1 | |
| }, | |
| "fromItem": { | |
| "type": "array", | |
| "position": 2, | |
| "description": "ID of a version", | |
| "items": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| "toItem": { | |
| "type": "array", | |
| "position": 3, | |
| "description": "ID of a version", | |
| "items": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| "suspect": { | |
| "type": "boolean", | |
| "position": 5 | |
| }, | |
| "relationshipType": { | |
| "type": "array", | |
| "position": 7, | |
| "description": "ID of a relationship type", | |
| "items": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "VersionedRelationshipDataListWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/VersionedRelationship" | |
| } | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaListWrapper" | |
| } | |
| } | |
| }, | |
| "Activity": { | |
| "type": "object", | |
| "required": ["action", "date", "details", "eventType", "id", "item", "objectType", "user", "userComment"], | |
| "properties": { | |
| "id": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 10 | |
| }, | |
| "date": { | |
| "type": "string", | |
| "format": "date-time", | |
| "position": 20 | |
| }, | |
| "details": { | |
| "type": "string", | |
| "position": 30 | |
| }, | |
| "action": { | |
| "type": "string", | |
| "position": 40 | |
| }, | |
| "user": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 50, | |
| "description": "ID of a user" | |
| }, | |
| "userComment": { | |
| "type": "string", | |
| "position": 55 | |
| }, | |
| "item": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 60, | |
| "description": "ID of an item" | |
| }, | |
| "itemType": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 65, | |
| "description": "ID of an item type" | |
| }, | |
| "eventType": { | |
| "type": "string", | |
| "position": 70, | |
| "enum": ["CREATE", "BATCH_CREATE", "UPDATE", "BATCH_UPDATE", "DELETE", "BATCH_DELETE", "PUBLIC", "BATCH_SUMMARY", "COPY", "BATCH_COPY", "MOVE"] | |
| }, | |
| "objectType": { | |
| "type": "string", | |
| "position": 80, | |
| "enum": ["PROJECT", "ITEM", "USER", "RELATIONSHIP", "COMMENT", "ITEM_TAG", "TAG", "ITEM_ATTACHMENT", "URL", "TEST_RESULT", "BASELINE", "CHANGE_REQUEST", "REVIEW", "REVISION", "REVISION_ITEM", "TEST_PLAN", "TEST_CYCLE", "TEST_RUN", "INTEGRATION", "MISCELLANEOUS"] | |
| } | |
| } | |
| }, | |
| "ActivityDataListWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Activity" | |
| } | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaListWrapper" | |
| } | |
| } | |
| }, | |
| "ActivityDataWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/definitions/Activity" | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaWrapper" | |
| } | |
| } | |
| }, | |
| "AbstractRestResponse": { | |
| "type": "object", | |
| "properties": { | |
| "status": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "statusReasonPhrase": { | |
| "type": "string" | |
| }, | |
| "pageInfo": { | |
| "$ref": "#/definitions/PageInfo" | |
| }, | |
| "headers": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "Comment": { | |
| "type": "object", | |
| "required": ["body", "commentType", "createdBy", "createdDate", "deleted", "id", "inReplyTo", "location", "modifiedBy", "status"], | |
| "properties": { | |
| "id": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "inReplyTo": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "ID of a comment" | |
| }, | |
| "createdDate": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "createdBy": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "ID of a user" | |
| }, | |
| "modifiedBy": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "ID of a user" | |
| }, | |
| "deleted": { | |
| "type": "boolean" | |
| }, | |
| "status": { | |
| "type": "string", | |
| "enum": ["OPEN", "CANCELLED", "COMPLETED"] | |
| }, | |
| "body": { | |
| "$ref": "#/definitions/CommentBody" | |
| }, | |
| "commentType": { | |
| "type": "string", | |
| "enum": ["GENERAL", "QUESTION", "PROPOSED_CHANGE", "ACCEPTED_COMMENT", "REJECTED_COMMENT", "ISSUE", "DECISION", "DECISION_REQUEST"] | |
| }, | |
| "location": { | |
| "$ref": "#/definitions/CommentLocation" | |
| } | |
| } | |
| }, | |
| "CommentBody": { | |
| "type": "object", | |
| "required": ["text"], | |
| "properties": { | |
| "text": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "CommentDataListWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Comment" | |
| } | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaListWrapper" | |
| } | |
| } | |
| }, | |
| "CommentLocation": { | |
| "type": "object", | |
| "required": ["item", "project"], | |
| "properties": { | |
| "item": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "ID of an item" | |
| }, | |
| "project": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "ID of a project" | |
| } | |
| } | |
| }, | |
| "VersionedAttachment": { | |
| "type": "object", | |
| "required": ["createdBy", "createdDate", "documentKey", "fields", "fileName", "fileSize", "globalId", "id", "itemType", "lastActivityDate", "lock", "mimeType", "modifiedBy", "modifiedDate", "project", "resources"], | |
| "properties": { | |
| "lock": { | |
| "$ref": "#/definitions/Lock" | |
| }, | |
| "fileName": { | |
| "type": "string" | |
| }, | |
| "mimeType": { | |
| "type": "string" | |
| }, | |
| "fileSize": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "version": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "currentVersion": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "Currently active version of the versioned item. If no version is active, currentVersion will not be returned." | |
| }, | |
| "id": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 1 | |
| }, | |
| "documentKey": { | |
| "type": "string", | |
| "position": 3 | |
| }, | |
| "globalId": { | |
| "type": "string", | |
| "position": 5 | |
| }, | |
| "project": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 7, | |
| "description": "ID of a project" | |
| }, | |
| "itemType": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 9, | |
| "description": "ID of an item type" | |
| }, | |
| "createdDate": { | |
| "type": "string", | |
| "format": "date-time", | |
| "position": 11 | |
| }, | |
| "modifiedDate": { | |
| "type": "string", | |
| "format": "date-time", | |
| "position": 13 | |
| }, | |
| "lastActivityDate": { | |
| "type": "string", | |
| "format": "date-time", | |
| "position": 14 | |
| }, | |
| "createdBy": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 15, | |
| "description": "ID of a user" | |
| }, | |
| "modifiedBy": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 17, | |
| "description": "ID of a user" | |
| }, | |
| "resources": { | |
| "type": "object", | |
| "position": 95, | |
| "description": "A set of resources and allowed permissions", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/AllowedResource" | |
| } | |
| }, | |
| "fields": { | |
| "type": "object", | |
| "position": 99, | |
| "description": "A map of field names to field values e.g. {\"name\":\"Sample Item\", \"status\": 292, \"release\": 2, \"assigned\": 23}", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "VersionedAttachmentDataWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/definitions/VersionedAttachment" | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaWrapper" | |
| } | |
| } | |
| }, | |
| "RequestLock": { | |
| "type": "object", | |
| "required": ["locked"], | |
| "properties": { | |
| "locked": { | |
| "type": "boolean", | |
| "position": 1 | |
| } | |
| } | |
| }, | |
| "LockDataWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/definitions/Lock" | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaWrapper" | |
| } | |
| } | |
| }, | |
| "Attachment": { | |
| "type": "object", | |
| "required": ["createdBy", "createdDate", "documentKey", "fields", "fileName", "fileSize", "globalId", "id", "itemType", "lastActivityDate", "lock", "mimeType", "modifiedBy", "modifiedDate", "project", "resources"], | |
| "properties": { | |
| "lock": { | |
| "$ref": "#/definitions/Lock" | |
| }, | |
| "fileName": { | |
| "type": "string" | |
| }, | |
| "mimeType": { | |
| "type": "string" | |
| }, | |
| "fileSize": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "id": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 1 | |
| }, | |
| "documentKey": { | |
| "type": "string", | |
| "position": 3 | |
| }, | |
| "globalId": { | |
| "type": "string", | |
| "position": 5 | |
| }, | |
| "project": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 7, | |
| "description": "ID of a project" | |
| }, | |
| "itemType": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 9, | |
| "description": "ID of an item type" | |
| }, | |
| "createdDate": { | |
| "type": "string", | |
| "format": "date-time", | |
| "position": 11 | |
| }, | |
| "modifiedDate": { | |
| "type": "string", | |
| "format": "date-time", | |
| "position": 13 | |
| }, | |
| "lastActivityDate": { | |
| "type": "string", | |
| "format": "date-time", | |
| "position": 14 | |
| }, | |
| "createdBy": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 15, | |
| "description": "ID of a user" | |
| }, | |
| "modifiedBy": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 17, | |
| "description": "ID of a user" | |
| }, | |
| "resources": { | |
| "type": "object", | |
| "position": 95, | |
| "description": "A set of resources and allowed permissions", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/AllowedResource" | |
| } | |
| }, | |
| "fields": { | |
| "type": "object", | |
| "position": 99, | |
| "description": "A map of field names to field values e.g. {\"name\":\"Sample Item\", \"status\": 292, \"release\": 2, \"assigned\": 23}", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "AttachmentDataWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/definitions/Attachment" | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaWrapper" | |
| } | |
| } | |
| }, | |
| "BodyPart": { | |
| "type": "object", | |
| "properties": { | |
| "contentDisposition": { | |
| "$ref": "#/definitions/ContentDisposition" | |
| }, | |
| "entity": { | |
| "type": "object" | |
| }, | |
| "headers": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "mediaType": { | |
| "$ref": "#/definitions/MediaType" | |
| }, | |
| "messageBodyWorkers": { | |
| "$ref": "#/definitions/MessageBodyWorkers" | |
| }, | |
| "parent": { | |
| "$ref": "#/definitions/MultiPart" | |
| }, | |
| "providers": { | |
| "$ref": "#/definitions/Providers" | |
| }, | |
| "parameterizedHeaders": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ParameterizedHeader" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "ContentDisposition": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "parameters": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "string" | |
| } | |
| }, | |
| "fileName": { | |
| "type": "string" | |
| }, | |
| "creationDate": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "modificationDate": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "readDate": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "size": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| } | |
| }, | |
| "FormDataBodyPart": { | |
| "type": "object", | |
| "properties": { | |
| "contentDisposition": { | |
| "$ref": "#/definitions/ContentDisposition" | |
| }, | |
| "entity": { | |
| "type": "object" | |
| }, | |
| "headers": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "mediaType": { | |
| "$ref": "#/definitions/MediaType" | |
| }, | |
| "messageBodyWorkers": { | |
| "$ref": "#/definitions/MessageBodyWorkers" | |
| }, | |
| "parent": { | |
| "$ref": "#/definitions/MultiPart" | |
| }, | |
| "providers": { | |
| "$ref": "#/definitions/Providers" | |
| }, | |
| "simple": { | |
| "type": "boolean" | |
| }, | |
| "formDataContentDisposition": { | |
| "$ref": "#/definitions/FormDataContentDisposition" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "value": { | |
| "type": "string" | |
| }, | |
| "parameterizedHeaders": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ParameterizedHeader" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "FormDataContentDisposition": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "parameters": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "string" | |
| } | |
| }, | |
| "fileName": { | |
| "type": "string" | |
| }, | |
| "creationDate": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "modificationDate": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "readDate": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "size": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "name": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "FormDataMultiPart": { | |
| "type": "object", | |
| "properties": { | |
| "contentDisposition": { | |
| "$ref": "#/definitions/ContentDisposition" | |
| }, | |
| "entity": { | |
| "type": "object" | |
| }, | |
| "headers": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "mediaType": { | |
| "$ref": "#/definitions/MediaType" | |
| }, | |
| "messageBodyWorkers": { | |
| "$ref": "#/definitions/MessageBodyWorkers" | |
| }, | |
| "parent": { | |
| "$ref": "#/definitions/MultiPart" | |
| }, | |
| "providers": { | |
| "$ref": "#/definitions/Providers" | |
| }, | |
| "bodyParts": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/BodyPart" | |
| } | |
| }, | |
| "fields": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/FormDataBodyPart" | |
| } | |
| } | |
| }, | |
| "parameterizedHeaders": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ParameterizedHeader" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "MediaType": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "subtype": { | |
| "type": "string" | |
| }, | |
| "parameters": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "string" | |
| } | |
| }, | |
| "wildcardType": { | |
| "type": "boolean" | |
| }, | |
| "wildcardSubtype": { | |
| "type": "boolean" | |
| } | |
| } | |
| }, | |
| "MessageBodyWorkers": { | |
| "type": "object" | |
| }, | |
| "MultiPart": { | |
| "type": "object", | |
| "properties": { | |
| "contentDisposition": { | |
| "$ref": "#/definitions/ContentDisposition" | |
| }, | |
| "entity": { | |
| "type": "object" | |
| }, | |
| "headers": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "mediaType": { | |
| "$ref": "#/definitions/MediaType" | |
| }, | |
| "messageBodyWorkers": { | |
| "$ref": "#/definitions/MessageBodyWorkers" | |
| }, | |
| "parent": { | |
| "$ref": "#/definitions/MultiPart" | |
| }, | |
| "providers": { | |
| "$ref": "#/definitions/Providers" | |
| }, | |
| "bodyParts": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/BodyPart" | |
| } | |
| }, | |
| "parameterizedHeaders": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ParameterizedHeader" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "ParameterizedHeader": { | |
| "type": "object", | |
| "properties": { | |
| "value": { | |
| "type": "string" | |
| }, | |
| "parameters": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "Providers": { | |
| "type": "object" | |
| }, | |
| "Baseline": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "createdDate": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "createdBy": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "ID of a user" | |
| }, | |
| "project": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "ID of a project" | |
| }, | |
| "origin": { | |
| "$ref": "#/definitions/BaselineOrigin" | |
| }, | |
| "type": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "BaselineDataWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/definitions/Baseline" | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaWrapper" | |
| } | |
| } | |
| }, | |
| "BaselineOrigin": { | |
| "type": "object", | |
| "properties": { | |
| "project": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "ID of a user" | |
| }, | |
| "item": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "ID of an item" | |
| }, | |
| "filter": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "ID of a filter" | |
| }, | |
| "release": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "ID of a release" | |
| } | |
| } | |
| }, | |
| "BaselineItem": { | |
| "type": "object", | |
| "required": ["childItemType", "createdBy", "createdDate", "documentKey", "fields", "globalId", "id", "itemType", "lastActivityDate", "modifiedBy", "modifiedDate", "project", "resources"], | |
| "properties": { | |
| "version": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "currentVersion": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "Currently active version of the versioned item. If no version is active, currentVersion will not be returned." | |
| }, | |
| "baseline": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "ID of a baseline" | |
| }, | |
| "baselineLocation": { | |
| "$ref": "#/definitions/BaselineLocation" | |
| }, | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 1 | |
| }, | |
| "documentKey": { | |
| "type": "string", | |
| "position": 3 | |
| }, | |
| "globalId": { | |
| "type": "string", | |
| "position": 5 | |
| }, | |
| "project": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 7, | |
| "description": "ID of a project" | |
| }, | |
| "itemType": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 9, | |
| "description": "ID of an item type" | |
| }, | |
| "childItemType": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 10, | |
| "description": "ID of an item type" | |
| }, | |
| "createdDate": { | |
| "type": "string", | |
| "format": "date-time", | |
| "position": 11 | |
| }, | |
| "modifiedDate": { | |
| "type": "string", | |
| "format": "date-time", | |
| "position": 13 | |
| }, | |
| "lastActivityDate": { | |
| "type": "string", | |
| "format": "date-time", | |
| "position": 14 | |
| }, | |
| "createdBy": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 15, | |
| "description": "ID of a user" | |
| }, | |
| "modifiedBy": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 17, | |
| "description": "ID of a user" | |
| }, | |
| "resources": { | |
| "type": "object", | |
| "position": 95, | |
| "description": "A set of resources and allowed permissions", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/AllowedResource" | |
| } | |
| }, | |
| "fields": { | |
| "type": "object", | |
| "position": 99, | |
| "description": "A map of field names to field values e.g. {\"name\":\"Sample Item\", \"status\": 292, \"release\": 2, \"assigned\": 23}", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "BaselineItemDataListWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/BaselineItem" | |
| } | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaListWrapper" | |
| } | |
| } | |
| }, | |
| "BaselineLocation": { | |
| "type": "object", | |
| "properties": { | |
| "sequence": { | |
| "type": "string" | |
| }, | |
| "parent": { | |
| "$ref": "#/definitions/BaselineParent" | |
| } | |
| } | |
| }, | |
| "BaselineParent": { | |
| "type": "object", | |
| "properties": { | |
| "item": { | |
| "type": "array", | |
| "description": "Item ID and version number for an item", | |
| "items": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| "project": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "ID of a project" | |
| } | |
| } | |
| }, | |
| "BaselineItemDataWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/definitions/BaselineItem" | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaWrapper" | |
| } | |
| } | |
| }, | |
| "BaselineDataListWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Baseline" | |
| } | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaListWrapper" | |
| } | |
| } | |
| }, | |
| "CommentDataWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/definitions/Comment" | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaWrapper" | |
| } | |
| } | |
| }, | |
| "CreatedResponse": { | |
| "type": "object", | |
| "properties": { | |
| "status": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "statusReasonPhrase": { | |
| "type": "string" | |
| }, | |
| "pageInfo": { | |
| "$ref": "#/definitions/PageInfo" | |
| }, | |
| "headers": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "location": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "id": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| } | |
| }, | |
| "RequestComment": { | |
| "type": "object", | |
| "required": ["body"], | |
| "properties": { | |
| "inReplyTo": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "ID of a comment" | |
| }, | |
| "body": { | |
| "$ref": "#/definitions/RequestCommentBody" | |
| }, | |
| "commentType": { | |
| "type": "string", | |
| "enum": ["GENERAL", "QUESTION", "PROPOSED_CHANGE", "ACCEPTED_COMMENT", "REJECTED_COMMENT", "ISSUE", "DECISION", "DECISION_REQUEST"] | |
| }, | |
| "location": { | |
| "$ref": "#/definitions/RequestCommentLocation" | |
| } | |
| } | |
| }, | |
| "RequestCommentBody": { | |
| "type": "object", | |
| "required": ["text"], | |
| "properties": { | |
| "text": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "RequestCommentLocation": { | |
| "type": "object", | |
| "properties": { | |
| "item": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "ID of an item" | |
| }, | |
| "project": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "ID of a project" | |
| } | |
| } | |
| }, | |
| "Filter": { | |
| "type": "object", | |
| "required": ["author", "filterQuery", "id", "name", "projectScope", "public", "specifiedProject"], | |
| "properties": { | |
| "id": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "author": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "ID of a user" | |
| }, | |
| "projectScope": { | |
| "type": "string", | |
| "enum": ["ALL", "CURRENT", "SPECIFIED"] | |
| }, | |
| "specifiedProject": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "ID of a project" | |
| }, | |
| "filterQuery": { | |
| "$ref": "#/definitions/FilterQuery" | |
| }, | |
| "public": { | |
| "type": "boolean" | |
| } | |
| } | |
| }, | |
| "FilterDataWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/definitions/Filter" | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaWrapper" | |
| } | |
| } | |
| }, | |
| "FilterField": { | |
| "type": "object", | |
| "required": ["display", "fieldDataType", "id", "name"], | |
| "properties": { | |
| "id": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "display": { | |
| "type": "string" | |
| }, | |
| "fieldDataType": { | |
| "type": "string", | |
| "enum": ["INTEGER", "TEXT_FIELD", "TEXT_BOX", "PICKLIST", "DATE", "USER", "RELEASE", "BOOLEAN", "GROUP", "MULTI_SELECT", "ITEM_OF_TYPE", "URL", "ITEM_TYPE", "PROJECT", "STEPS", "TIME", "TEST_RUN_STATUS", "ITEM_OF_CATEGORY", "TEST_CASE_STATUS", "ACTIONS", "TAG", "DOWNSTREAM_RELATIONSHIP", "NO_DOWNSTREAM_RELATIONSHIP", "UPSTREAM_RELATIONSHIP", "NO_UPSTREAM_RELATIONSHIP", "CHANGE_REQUEST", "LOCATION", "QUERY_PARSER", "ADHOC", "HAS_TEST_CENTER_ITEM", "GLOBAL_ID"] | |
| } | |
| } | |
| }, | |
| "FilterOrderRule": { | |
| "type": "object", | |
| "required": ["direction", "field"], | |
| "properties": { | |
| "direction": { | |
| "type": "string", | |
| "enum": ["ASC", "DESC"] | |
| }, | |
| "field": { | |
| "$ref": "#/definitions/FilterField" | |
| } | |
| } | |
| }, | |
| "FilterQuery": { | |
| "type": "object", | |
| "required": ["name", "orderRules", "rule"], | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "rule": { | |
| "$ref": "#/definitions/FilterRule" | |
| }, | |
| "orderRules": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/FilterOrderRule" | |
| } | |
| } | |
| } | |
| }, | |
| "FilterRule": { | |
| "type": "object", | |
| "required": ["field", "itemType", "operator", "rules", "subQuery", "values"], | |
| "properties": { | |
| "field": { | |
| "$ref": "#/definitions/FilterField" | |
| }, | |
| "operator": { | |
| "type": "string", | |
| "enum": ["GROUP_OR", "GROUP_AND", "OR", "AND", "EQUALS", "EQUALS_DATE", "EQUALS_MULTI", "NOT_EQUALS", "NOT_EQUALS_DATE", "NOT_EQUALS_MULTI", "GREATER_THAN", "GREATER_THAN_DATE", "LESS_THAN", "LESS_THAN_DATE", "IN", "IS_TRUE", "IS_FALSE", "CONTAINS", "CONTAINS_WORD", "NOT_CONTAINS", "NOT_CONTAINS_WORD", "IS_ASSOCIATED_ITEM", "IS_ASSOCIATED_SUSPECT_ITEM", "IS_ASSOCIATED_NOT_SUSPECT_ITEM", "IS_BETWEEN", "HAS_ALL", "HAS_NONE", "IS_DIRECTLY_UNDER", "IS_UNDER", "IS_CURRENT_USER", "IS_EMPTY", "IS_NOT_EMPTY", "IS_NOT_DIRECTLY_UNDER", "IS_UNDER_OR_EQUAL", "IS_NOT_UNDER", "LOCATION_IS", "TEST_CENTER_RELATE", "SHARED_WITH", "NOT_SHARED_WITH", "IS_WITHIN_LAST", "IS_DATE_TIME_BETWEEN"] | |
| }, | |
| "values": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "itemType": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "ID of an item type" | |
| }, | |
| "subQuery": { | |
| "$ref": "#/definitions/FilterQuery" | |
| }, | |
| "rules": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/FilterRule" | |
| } | |
| } | |
| } | |
| }, | |
| "FilterDataListWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Filter" | |
| } | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaListWrapper" | |
| } | |
| } | |
| }, | |
| "ItemType": { | |
| "type": "object", | |
| "required": ["category", "description", "display", "displayPlural", "fields", "id", "image", "system", "typeKey", "widgets"], | |
| "properties": { | |
| "id": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "typeKey": { | |
| "type": "string" | |
| }, | |
| "display": { | |
| "type": "string" | |
| }, | |
| "displayPlural": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "image": { | |
| "type": "string" | |
| }, | |
| "category": { | |
| "type": "string", | |
| "enum": ["CORE", "ATTACHMENT", "COMPONENT", "SET", "SECTION", "TEXT", "TEST_PLAN", "TEST_CYCLE", "TEST_RUN", "TEST_CASE", "DEFECT"] | |
| }, | |
| "widgets": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ItemTypeWidget" | |
| } | |
| }, | |
| "fields": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ItemTypeField" | |
| } | |
| }, | |
| "system": { | |
| "type": "boolean" | |
| } | |
| } | |
| }, | |
| "ItemTypeDataWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/definitions/ItemType" | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaWrapper" | |
| } | |
| } | |
| }, | |
| "ItemTypeField": { | |
| "type": "object", | |
| "required": ["fieldType", "id", "itemType", "label", "name", "pickList", "readOnly", "required", "synchronize", "textType", "triggerSuspect"], | |
| "properties": { | |
| "id": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "label": { | |
| "type": "string" | |
| }, | |
| "fieldType": { | |
| "type": "string", | |
| "enum": ["INTEGER", "STRING", "TEXT", "LOOKUP", "DATE", "USER", "RELEASE", "BOOLEAN", "GROUP", "MULTI_LOOKUP", "DOCUMENT_TYPE_ITEM_LOOKUP", "URL_STRING", "DOCUMENT_TYPE", "PROJECT", "STEPS", "TIME", "TEST_RUN_STATUS", "DOCUMENT_TYPE_CATEGORY_ITEM_LOOKUP", "TEST_CASE_STATUS", "ACTIONS", "ROLLUP", "RELATIVE_DATE_RANGE", "CALCULATED", "RELATIONSHIP_STATUS"] | |
| }, | |
| "readOnly": { | |
| "type": "boolean" | |
| }, | |
| "readOnlyAllowApiOverwrite": { | |
| "type": "boolean" | |
| }, | |
| "required": { | |
| "type": "boolean" | |
| }, | |
| "triggerSuspect": { | |
| "type": "boolean" | |
| }, | |
| "synchronize": { | |
| "type": "boolean" | |
| }, | |
| "pickList": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "ID of a pick list" | |
| }, | |
| "textType": { | |
| "type": "string", | |
| "enum": ["TEXTAREA", "RICHTEXT", "KEY", "ATTACHMENT"] | |
| }, | |
| "itemType": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "ID of an item type" | |
| } | |
| } | |
| }, | |
| "ItemTypeWidget": { | |
| "type": "object", | |
| "required": ["name", "synchronize"], | |
| "properties": { | |
| "name": { | |
| "type": "string", | |
| "enum": ["ACTIVITIES", "RELATIONSHIPS", "SYNCHRONIZED_ITEMS", "ATTACHMENTS", "URLS", "TAGS", "HISTORY", "TEST_HISTORY_OLD", "SELENIUM", "CHANGE_REQUESTS", "FOLDER_LIST", "INSIDE_CHANGE_REQUEST", "ITEMS_WITH_ATTACHMENT", "TEST_RUNS", "TEST_CASE"] | |
| }, | |
| "synchronize": { | |
| "type": "boolean" | |
| } | |
| } | |
| }, | |
| "ItemTypeDataListWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ItemType" | |
| } | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaListWrapper" | |
| } | |
| } | |
| }, | |
| "ItemDataWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/definitions/Item" | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaWrapper" | |
| } | |
| } | |
| }, | |
| "Tag": { | |
| "type": "object", | |
| "required": ["id", "name", "project"], | |
| "properties": { | |
| "id": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "project": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "ID of a project" | |
| } | |
| } | |
| }, | |
| "TagDataWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/definitions/Tag" | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaWrapper" | |
| } | |
| } | |
| }, | |
| "TagDataListWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Tag" | |
| } | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaListWrapper" | |
| } | |
| } | |
| }, | |
| "RequestItemTag": { | |
| "type": "object", | |
| "required": ["tag"], | |
| "properties": { | |
| "tag": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| } | |
| }, | |
| "AttachmentDataListWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Attachment" | |
| } | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaListWrapper" | |
| } | |
| } | |
| }, | |
| "RequestItemAttachment": { | |
| "type": "object", | |
| "required": ["attachment"], | |
| "properties": { | |
| "attachment": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| } | |
| }, | |
| "VersionedItem": { | |
| "type": "object", | |
| "required": ["childItemType", "createdBy", "createdDate", "documentKey", "fields", "globalId", "id", "itemType", "lastActivityDate", "modifiedBy", "modifiedDate", "project", "resources"], | |
| "properties": { | |
| "version": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "currentVersion": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "Currently active version of the versioned item. If no version is active, currentVersion will not be returned." | |
| }, | |
| "id": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 1 | |
| }, | |
| "documentKey": { | |
| "type": "string", | |
| "position": 3 | |
| }, | |
| "globalId": { | |
| "type": "string", | |
| "position": 5 | |
| }, | |
| "project": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 7, | |
| "description": "ID of a project" | |
| }, | |
| "itemType": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 9, | |
| "description": "ID of an item type" | |
| }, | |
| "childItemType": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 10, | |
| "description": "ID of an item type" | |
| }, | |
| "createdDate": { | |
| "type": "string", | |
| "format": "date-time", | |
| "position": 11 | |
| }, | |
| "modifiedDate": { | |
| "type": "string", | |
| "format": "date-time", | |
| "position": 13 | |
| }, | |
| "lastActivityDate": { | |
| "type": "string", | |
| "format": "date-time", | |
| "position": 14 | |
| }, | |
| "createdBy": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 15, | |
| "description": "ID of a user" | |
| }, | |
| "modifiedBy": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 17, | |
| "description": "ID of a user" | |
| }, | |
| "resources": { | |
| "type": "object", | |
| "position": 95, | |
| "description": "A set of resources and allowed permissions", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/AllowedResource" | |
| } | |
| }, | |
| "fields": { | |
| "type": "object", | |
| "position": 99, | |
| "description": "A map of field names to field values e.g. {\"name\":\"Sample Item\", \"status\": 292, \"release\": 2, \"assigned\": 23}", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "VersionedItemDataWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/definitions/VersionedItem" | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaWrapper" | |
| } | |
| } | |
| }, | |
| "DuplicateConfig": { | |
| "type": "object", | |
| "properties": { | |
| "includeTags": { | |
| "type": "boolean" | |
| }, | |
| "includeAttachments": { | |
| "type": "boolean" | |
| }, | |
| "includeLinks": { | |
| "type": "boolean" | |
| } | |
| } | |
| }, | |
| "RequestTransition": { | |
| "type": "object", | |
| "required": ["transitionId"], | |
| "properties": { | |
| "transitionId": { | |
| "type": "string" | |
| }, | |
| "comment": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "RequestPatchOperation": { | |
| "type": "object", | |
| "required": ["op", "path"], | |
| "properties": { | |
| "op": { | |
| "type": "string", | |
| "enum": ["remove", "replace", "add"] | |
| }, | |
| "path": { | |
| "type": "string" | |
| }, | |
| "value": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "Relationship": { | |
| "type": "object", | |
| "required": ["fromItem", "id", "relationshipType", "suspect", "toItem"], | |
| "properties": { | |
| "id": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 1 | |
| }, | |
| "fromItem": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 2, | |
| "description": "ID of an item" | |
| }, | |
| "toItem": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 3, | |
| "description": "ID of an item" | |
| }, | |
| "relationshipType": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 4, | |
| "description": "ID of a relationship type" | |
| }, | |
| "suspect": { | |
| "type": "boolean", | |
| "position": 5 | |
| } | |
| } | |
| }, | |
| "RelationshipDataListWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Relationship" | |
| } | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaListWrapper" | |
| } | |
| } | |
| }, | |
| "RequestLink": { | |
| "type": "object", | |
| "required": ["url"], | |
| "properties": { | |
| "url": { | |
| "type": "string", | |
| "position": 10 | |
| }, | |
| "description": { | |
| "type": "string", | |
| "position": 20 | |
| } | |
| } | |
| }, | |
| "LinkDataWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/definitions/Link" | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaWrapper" | |
| } | |
| } | |
| }, | |
| "LinkDataListWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaListWrapper" | |
| } | |
| } | |
| }, | |
| "RequestItemSyncedItem": { | |
| "type": "object", | |
| "required": ["item"], | |
| "properties": { | |
| "item": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "ID of a item" | |
| } | |
| } | |
| }, | |
| "CollectionSummary": { | |
| "type": "object", | |
| "required": ["totalChildren", "totalMissing", "totalOutOfSync"], | |
| "properties": { | |
| "totalChildren": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "totalMissing": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "totalOutOfSync": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| } | |
| }, | |
| "SyncStatus": { | |
| "type": "object", | |
| "required": ["collectionSummary", "inSync"], | |
| "properties": { | |
| "inSync": { | |
| "type": "boolean", | |
| "position": 10 | |
| }, | |
| "collectionSummary": { | |
| "position": 20, | |
| "$ref": "#/definitions/CollectionSummary" | |
| } | |
| } | |
| }, | |
| "SyncStatusDataWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/definitions/SyncStatus" | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaWrapper" | |
| } | |
| } | |
| }, | |
| "WorkflowTransition": { | |
| "type": "object", | |
| "required": ["action", "id", "newStatus"], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "action": { | |
| "type": "string" | |
| }, | |
| "newStatus": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "ID of a pick list option" | |
| } | |
| } | |
| }, | |
| "WorkflowTransitionDataListWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/WorkflowTransition" | |
| } | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaListWrapper" | |
| } | |
| } | |
| }, | |
| "RequestItem": { | |
| "type": "object", | |
| "required": ["childItemType", "fields", "itemType", "location", "project"], | |
| "properties": { | |
| "globalId": { | |
| "type": "string", | |
| "position": 1, | |
| "description": "Must use override if you want to set this value on POST." | |
| }, | |
| "project": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 2, | |
| "description": "Only required when creating a new item (POST)." | |
| }, | |
| "itemType": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 9, | |
| "description": "ID of an item type" | |
| }, | |
| "childItemType": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 10, | |
| "description": "ID of an item type" | |
| }, | |
| "location": { | |
| "position": 35, | |
| "$ref": "#/definitions/RequestLocation" | |
| }, | |
| "fields": { | |
| "type": "object", | |
| "position": 99, | |
| "description": "A map of field names to field values e.g. {\"name\":\"Sample Item\", \"status\": 292, \"release\": 2, \"assigned\": 23}", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "RequestLocation": { | |
| "type": "object", | |
| "required": ["parent"], | |
| "properties": { | |
| "parent": { | |
| "position": 2, | |
| "description": "This can point to either a project or a parent item at which this item is located, not both.", | |
| "$ref": "#/definitions/RequestParent" | |
| } | |
| } | |
| }, | |
| "RequestParent": { | |
| "type": "object", | |
| "properties": { | |
| "item": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 2, | |
| "description": "ID of an item. If this is included, the item of this payload will be located at this parent item. If this is not included, the item will be located at the root of the project." | |
| }, | |
| "project": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 3, | |
| "description": "ID of an project. If this is included, the item of this payload will be located at the root of the project, and a parent item cannot be specified. This value will be inferred by the \"project\" property at the root of the payload when a parent location is not specified." | |
| } | |
| } | |
| }, | |
| "RequestMoveLocation": { | |
| "type": "object", | |
| "required": ["parent"], | |
| "properties": { | |
| "parent": { | |
| "position": 2, | |
| "$ref": "#/definitions/RequestMoveParent" | |
| } | |
| } | |
| }, | |
| "RequestMoveParent": { | |
| "type": "object", | |
| "properties": { | |
| "project": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 3, | |
| "description": "ID of an project" | |
| } | |
| } | |
| }, | |
| "LocationDataWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/definitions/Location" | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaWrapper" | |
| } | |
| } | |
| }, | |
| "PickList": { | |
| "type": "object", | |
| "required": ["description", "id", "name"], | |
| "properties": { | |
| "id": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "PickListDataListWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/PickList" | |
| } | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaListWrapper" | |
| } | |
| } | |
| }, | |
| "PickListOption": { | |
| "type": "object", | |
| "required": ["active", "color", "default", "description", "id", "name", "sortOrder"], | |
| "properties": { | |
| "pickList": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "ID of a pick list" | |
| }, | |
| "id": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 1 | |
| }, | |
| "name": { | |
| "type": "string", | |
| "position": 2 | |
| }, | |
| "description": { | |
| "type": "string", | |
| "position": 3 | |
| }, | |
| "value": { | |
| "type": "string", | |
| "position": 4 | |
| }, | |
| "default": { | |
| "type": "boolean", | |
| "position": 5 | |
| }, | |
| "active": { | |
| "type": "boolean", | |
| "position": 6 | |
| }, | |
| "color": { | |
| "type": "string", | |
| "position": 6 | |
| }, | |
| "sortOrder": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 7 | |
| } | |
| } | |
| }, | |
| "PickListOptionDataListWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/PickListOption" | |
| } | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaListWrapper" | |
| } | |
| } | |
| }, | |
| "PickListDataWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/definitions/PickList" | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaWrapper" | |
| } | |
| } | |
| }, | |
| "RequestPickListOption": { | |
| "type": "object", | |
| "required": ["name"], | |
| "properties": { | |
| "description": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "value": { | |
| "type": "string" | |
| }, | |
| "color": { | |
| "type": "string", | |
| "enum": ["000000", "3C3C3C", "666666", "AAAAAA", "BBBBBB", "CCCCCC", "DDDDDD", "EEEEEE", "FFFFFF", "FF0000", "FF9933", "FFF800", "00CC66", "32ABD6", "0066CC", "003366", "663399", "FF3399", "E39191", "FFCC66", "FFFF66", "9CE78C", "9BDFFF", "66A3E0", "335C85", "9966FF", "FF66FF", "FFCCCC", "FFE9BC", "FFFFCC", "CCFFCC", "CCFFFF", "99C2EB", "99ADC2", "CAB4FF", "F7C0FF", "FBE4E3", "FFF4DB", "FFFFE1", "E6FFE1", "E9FFFF", "CCD6E0", "EAEAFF", "FDE3FF"] | |
| }, | |
| "sortOrder": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "default": { | |
| "type": "boolean" | |
| } | |
| } | |
| }, | |
| "RequestPickList": { | |
| "type": "object", | |
| "required": ["name"], | |
| "properties": { | |
| "name": { | |
| "type": "string", | |
| "minLength": 1, | |
| "maxLength": 255, | |
| "pattern": "^[^\n\r]*$" | |
| }, | |
| "description": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "PickListOptionDataWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/definitions/PickListOption" | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaWrapper" | |
| } | |
| } | |
| }, | |
| "RequestAttachment": { | |
| "type": "object", | |
| "required": ["fields"], | |
| "properties": { | |
| "fields": { | |
| "type": "object", | |
| "position": 99, | |
| "description": "A map of field names to field values e.g. {\"name\":\"Sample Item\", \"status\": 292, \"release\": 2, \"assigned\": 23}", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "Project": { | |
| "type": "object", | |
| "required": ["createdBy", "createdDate", "fields", "id", "isFolder", "modifiedBy", "modifiedDate", "parent", "projectKey"], | |
| "properties": { | |
| "id": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 1 | |
| }, | |
| "projectKey": { | |
| "type": "string", | |
| "position": 2 | |
| }, | |
| "parent": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 3, | |
| "description": "ID of a project" | |
| }, | |
| "isFolder": { | |
| "type": "boolean", | |
| "position": 4 | |
| }, | |
| "createdDate": { | |
| "type": "string", | |
| "format": "date-time", | |
| "position": 5 | |
| }, | |
| "modifiedDate": { | |
| "type": "string", | |
| "format": "date-time", | |
| "position": 6 | |
| }, | |
| "createdBy": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 7, | |
| "description": "ID of a user" | |
| }, | |
| "modifiedBy": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 8, | |
| "description": "ID of a user" | |
| }, | |
| "fields": { | |
| "type": "object", | |
| "position": 9, | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "ProjectDataWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/definitions/Project" | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaWrapper" | |
| } | |
| } | |
| }, | |
| "RequestProject": { | |
| "type": "object", | |
| "required": ["fields", "projectKey"], | |
| "properties": { | |
| "projectKey": { | |
| "type": "string", | |
| "description": "Not Required if isFolder is true" | |
| }, | |
| "isFolder": { | |
| "type": "boolean" | |
| }, | |
| "parent": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "parent project" | |
| }, | |
| "fields": { | |
| "type": "object", | |
| "position": 99, | |
| "description": "A map of field names to field values e.g. {\"name\":\"Sample Project\", \"status\": 292, \"release\": 2, \"projectManager\": 23}", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "ProjectDataListWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Project" | |
| } | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaListWrapper" | |
| } | |
| } | |
| }, | |
| "RelationshipType": { | |
| "type": "object", | |
| "required": ["id", "isDefault", "name"], | |
| "properties": { | |
| "id": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 1 | |
| }, | |
| "name": { | |
| "type": "string", | |
| "position": 2 | |
| }, | |
| "isDefault": { | |
| "type": "boolean", | |
| "position": 4 | |
| } | |
| } | |
| }, | |
| "RelationshipTypeDataWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/definitions/RelationshipType" | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaWrapper" | |
| } | |
| } | |
| }, | |
| "RelationshipTypeDataListWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/RelationshipType" | |
| } | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaListWrapper" | |
| } | |
| } | |
| }, | |
| "RelationshipDataWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/definitions/Relationship" | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaWrapper" | |
| } | |
| } | |
| }, | |
| "RequestRelationship": { | |
| "type": "object", | |
| "required": ["fromItem", "toItem"], | |
| "properties": { | |
| "fromItem": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 1 | |
| }, | |
| "toItem": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 2 | |
| }, | |
| "relationshipType": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 3, | |
| "description": "Relationships will be created with the default type when providing a null or invalid relationship type" | |
| } | |
| } | |
| }, | |
| "Release": { | |
| "type": "object", | |
| "required": ["active", "archived", "description", "id", "itemCount", "name", "project", "releaseDate"], | |
| "properties": { | |
| "id": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "project": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "ID of a project" | |
| }, | |
| "releaseDate": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "active": { | |
| "type": "boolean" | |
| }, | |
| "archived": { | |
| "type": "boolean" | |
| }, | |
| "itemCount": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| } | |
| }, | |
| "ReleaseDataListWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Release" | |
| } | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaListWrapper" | |
| } | |
| } | |
| }, | |
| "ReleaseDataWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/definitions/Release" | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaWrapper" | |
| } | |
| } | |
| }, | |
| "RequestRelease": { | |
| "type": "object", | |
| "required": ["name", "project", "releaseDate"], | |
| "properties": { | |
| "name": { | |
| "type": "string", | |
| "position": 1 | |
| }, | |
| "description": { | |
| "type": "string", | |
| "position": 2 | |
| }, | |
| "releaseDate": { | |
| "type": "string", | |
| "position": 3 | |
| }, | |
| "project": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 4 | |
| } | |
| } | |
| }, | |
| "CrossOriginDomainWhiteList": { | |
| "type": "object", | |
| "properties": { | |
| "domains": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "RequestTag": { | |
| "type": "object", | |
| "required": ["name", "project"], | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "project": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "Only required on tag creation (POST)" | |
| } | |
| } | |
| }, | |
| "TestRun": { | |
| "type": "object", | |
| "required": ["createdBy", "createdDate", "documentKey", "fields", "globalId", "id", "itemType", "lastActivityDate", "modifiedBy", "modifiedDate", "project", "resources", "sortOrderFromTestGroup", "testCaseVersionNumber", "testGroup"], | |
| "properties": { | |
| "id": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 1 | |
| }, | |
| "documentKey": { | |
| "type": "string", | |
| "position": 3 | |
| }, | |
| "globalId": { | |
| "type": "string", | |
| "position": 5 | |
| }, | |
| "project": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 7, | |
| "description": "ID of a project" | |
| }, | |
| "itemType": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 9, | |
| "description": "ID of an item type" | |
| }, | |
| "createdDate": { | |
| "type": "string", | |
| "format": "date-time", | |
| "position": 11 | |
| }, | |
| "modifiedDate": { | |
| "type": "string", | |
| "format": "date-time", | |
| "position": 13 | |
| }, | |
| "lastActivityDate": { | |
| "type": "string", | |
| "format": "date-time", | |
| "position": 14 | |
| }, | |
| "createdBy": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 15, | |
| "description": "ID of a user" | |
| }, | |
| "modifiedBy": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 17, | |
| "description": "ID of a user" | |
| }, | |
| "testCaseVersionNumber": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 45, | |
| "description": "The version of the test case at the time of test run creation" | |
| }, | |
| "testCaseCurrentVersionNumber": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 46, | |
| "description": "The current version of the test case that the test run is based on" | |
| }, | |
| "sortOrderFromTestGroup": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 46, | |
| "description": "The sort order within the test group at the time of test cycle creation" | |
| }, | |
| "testGroup": { | |
| "type": "array", | |
| "position": 47, | |
| "description": "ID of a test cycle and ID of a test group", | |
| "items": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| "resources": { | |
| "type": "object", | |
| "position": 95, | |
| "description": "A set of resources and allowed permissions", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/AllowedResource" | |
| } | |
| }, | |
| "fields": { | |
| "type": "object", | |
| "position": 99, | |
| "description": "A map of field names to field values e.g. {\"name\":\"Sample Item\", \"status\": 292, \"release\": 2, \"assigned\": 23}", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "TestRunDataListWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/TestRun" | |
| } | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaListWrapper" | |
| } | |
| } | |
| }, | |
| "TestCycle": { | |
| "type": "object", | |
| "required": ["createdBy", "createdDate", "documentKey", "fields", "globalId", "id", "itemType", "lastActivityDate", "modifiedBy", "modifiedDate", "project", "resources"], | |
| "properties": { | |
| "id": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 1 | |
| }, | |
| "documentKey": { | |
| "type": "string", | |
| "position": 3 | |
| }, | |
| "globalId": { | |
| "type": "string", | |
| "position": 5 | |
| }, | |
| "project": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 7, | |
| "description": "ID of a project" | |
| }, | |
| "itemType": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 9, | |
| "description": "ID of an item type" | |
| }, | |
| "createdDate": { | |
| "type": "string", | |
| "format": "date-time", | |
| "position": 11 | |
| }, | |
| "modifiedDate": { | |
| "type": "string", | |
| "format": "date-time", | |
| "position": 13 | |
| }, | |
| "lastActivityDate": { | |
| "type": "string", | |
| "format": "date-time", | |
| "position": 14 | |
| }, | |
| "createdBy": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 15, | |
| "description": "ID of a user" | |
| }, | |
| "modifiedBy": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 17, | |
| "description": "ID of a user" | |
| }, | |
| "resources": { | |
| "type": "object", | |
| "position": 95, | |
| "description": "A set of resources and allowed permissions", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/AllowedResource" | |
| } | |
| }, | |
| "fields": { | |
| "type": "object", | |
| "position": 99, | |
| "description": "A map of field names to field values e.g. {\"name\":\"Sample Item\", \"status\": 292, \"release\": 2, \"assigned\": 23}", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "TestCycleDataWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/definitions/TestCycle" | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaWrapper" | |
| } | |
| } | |
| }, | |
| "VersionedTestCycle": { | |
| "type": "object", | |
| "required": ["createdBy", "createdDate", "documentKey", "fields", "globalId", "id", "itemType", "lastActivityDate", "modifiedBy", "modifiedDate", "project", "resources"], | |
| "properties": { | |
| "version": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "currentVersion": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "Currently active version of the versioned item. If no version is active, currentVersion will not be returned." | |
| }, | |
| "id": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 1 | |
| }, | |
| "documentKey": { | |
| "type": "string", | |
| "position": 3 | |
| }, | |
| "globalId": { | |
| "type": "string", | |
| "position": 5 | |
| }, | |
| "project": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 7, | |
| "description": "ID of a project" | |
| }, | |
| "itemType": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 9, | |
| "description": "ID of an item type" | |
| }, | |
| "createdDate": { | |
| "type": "string", | |
| "format": "date-time", | |
| "position": 11 | |
| }, | |
| "modifiedDate": { | |
| "type": "string", | |
| "format": "date-time", | |
| "position": 13 | |
| }, | |
| "lastActivityDate": { | |
| "type": "string", | |
| "format": "date-time", | |
| "position": 14 | |
| }, | |
| "createdBy": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 15, | |
| "description": "ID of a user" | |
| }, | |
| "modifiedBy": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 17, | |
| "description": "ID of a user" | |
| }, | |
| "resources": { | |
| "type": "object", | |
| "position": 95, | |
| "description": "A set of resources and allowed permissions", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/AllowedResource" | |
| } | |
| }, | |
| "fields": { | |
| "type": "object", | |
| "position": 99, | |
| "description": "A map of field names to field values e.g. {\"name\":\"Sample Item\", \"status\": 292, \"release\": 2, \"assigned\": 23}", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "VersionedTestCycleDataWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/definitions/VersionedTestCycle" | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaWrapper" | |
| } | |
| } | |
| }, | |
| "TestCycleTestGroup": { | |
| "type": "object", | |
| "required": ["assignedTo", "name", "testCycle", "testGroup", "type"], | |
| "properties": { | |
| "testGroup": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 10 | |
| }, | |
| "name": { | |
| "type": "string", | |
| "position": 20 | |
| }, | |
| "assignedTo": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 30, | |
| "description": "ID of a user" | |
| }, | |
| "testCycle": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 40 | |
| }, | |
| "type": { | |
| "type": "string", | |
| "position": 50 | |
| } | |
| } | |
| }, | |
| "TestCycleTestGroupDataWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/definitions/TestCycleTestGroup" | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaWrapper" | |
| } | |
| } | |
| }, | |
| "RequestTestCycle": { | |
| "type": "object", | |
| "required": ["fields", "testRunGenerationConfig"], | |
| "properties": { | |
| "fields": { | |
| "type": "object", | |
| "position": 99, | |
| "description": "A map of field names to field values e.g. {\"name\":\"Sample Item\", \"startDate\": \"2015-01-01\", \"endDate\": \"2015-01-15\"} Note: RequestTestCycle requires name, startDate, and endDate. startDate and endDate are formatted with 'yyyy-mm-dd'", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| }, | |
| "testRunGenerationConfig": { | |
| "position": 100, | |
| "description": "Settings for how test runs will be generated in this test cycle", | |
| "$ref": "#/definitions/TestRunGenerationConfig" | |
| } | |
| } | |
| }, | |
| "TestRunGenerationConfig": { | |
| "type": "object", | |
| "properties": { | |
| "testGroupsToInclude": { | |
| "type": "array", | |
| "position": 1, | |
| "description": "The Test Group IDs of the Test Groups from which you would like to generate Test Runs. Do not specify anything to include all groups.", | |
| "items": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| "testRunStatusesToInclude": { | |
| "type": "array", | |
| "position": 2, | |
| "description": "Only valid after generating the first Test Cycle, you may choose to only generate Test Runs that were a specified status in the previous cycle. Do not specify anything to include all statuses", | |
| "items": { | |
| "type": "string", | |
| "enum": ["PASSED", "NOT_RUN", "INPROGRESS", "FAILED", "BLOCKED"] | |
| } | |
| } | |
| } | |
| }, | |
| "TestPlan": { | |
| "type": "object", | |
| "required": ["archived", "createdBy", "createdDate", "documentKey", "fields", "globalId", "id", "itemType", "lastActivityDate", "modifiedBy", "modifiedDate", "project", "resources"], | |
| "properties": { | |
| "id": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 1 | |
| }, | |
| "documentKey": { | |
| "type": "string", | |
| "position": 3 | |
| }, | |
| "globalId": { | |
| "type": "string", | |
| "position": 5 | |
| }, | |
| "project": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 7, | |
| "description": "ID of a project" | |
| }, | |
| "itemType": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 9, | |
| "description": "ID of an item type" | |
| }, | |
| "createdDate": { | |
| "type": "string", | |
| "format": "date-time", | |
| "position": 11 | |
| }, | |
| "modifiedDate": { | |
| "type": "string", | |
| "format": "date-time", | |
| "position": 13 | |
| }, | |
| "lastActivityDate": { | |
| "type": "string", | |
| "format": "date-time", | |
| "position": 14 | |
| }, | |
| "createdBy": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 15, | |
| "description": "ID of a user" | |
| }, | |
| "modifiedBy": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 17, | |
| "description": "ID of a user" | |
| }, | |
| "resources": { | |
| "type": "object", | |
| "position": 95, | |
| "description": "A set of resources and allowed permissions", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/AllowedResource" | |
| } | |
| }, | |
| "fields": { | |
| "type": "object", | |
| "position": 99, | |
| "description": "A map of field names to field values e.g. {\"name\":\"Sample Item\", \"status\": 292, \"release\": 2, \"assigned\": 23}", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| }, | |
| "archived": { | |
| "type": "boolean", | |
| "position": 150 | |
| } | |
| } | |
| }, | |
| "TestPlanDataWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/definitions/TestPlan" | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaWrapper" | |
| } | |
| } | |
| }, | |
| "TestCycleDataListWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/TestCycle" | |
| } | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaListWrapper" | |
| } | |
| } | |
| }, | |
| "VersionedTestPlan": { | |
| "type": "object", | |
| "required": ["archived", "createdBy", "createdDate", "documentKey", "fields", "globalId", "id", "itemType", "lastActivityDate", "modifiedBy", "modifiedDate", "project", "resources"], | |
| "properties": { | |
| "version": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "currentVersion": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "Currently active version of the versioned item. If no version is active, currentVersion will not be returned." | |
| }, | |
| "id": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 1 | |
| }, | |
| "documentKey": { | |
| "type": "string", | |
| "position": 3 | |
| }, | |
| "globalId": { | |
| "type": "string", | |
| "position": 5 | |
| }, | |
| "project": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 7, | |
| "description": "ID of a project" | |
| }, | |
| "itemType": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 9, | |
| "description": "ID of an item type" | |
| }, | |
| "createdDate": { | |
| "type": "string", | |
| "format": "date-time", | |
| "position": 11 | |
| }, | |
| "modifiedDate": { | |
| "type": "string", | |
| "format": "date-time", | |
| "position": 13 | |
| }, | |
| "lastActivityDate": { | |
| "type": "string", | |
| "format": "date-time", | |
| "position": 14 | |
| }, | |
| "createdBy": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 15, | |
| "description": "ID of a user" | |
| }, | |
| "modifiedBy": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 17, | |
| "description": "ID of a user" | |
| }, | |
| "resources": { | |
| "type": "object", | |
| "position": 95, | |
| "description": "A set of resources and allowed permissions", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/AllowedResource" | |
| } | |
| }, | |
| "fields": { | |
| "type": "object", | |
| "position": 99, | |
| "description": "A map of field names to field values e.g. {\"name\":\"Sample Item\", \"status\": 292, \"release\": 2, \"assigned\": 23}", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| }, | |
| "archived": { | |
| "type": "boolean", | |
| "position": 150 | |
| } | |
| } | |
| }, | |
| "VersionedTestPlanDataWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/definitions/VersionedTestPlan" | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaWrapper" | |
| } | |
| } | |
| }, | |
| "AbstractItemDataListWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/AbstractItem" | |
| } | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaListWrapper" | |
| } | |
| } | |
| }, | |
| "RequestTestPlan": { | |
| "type": "object", | |
| "required": ["fields", "project"], | |
| "properties": { | |
| "project": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 2, | |
| "description": "Only required when creating a new test plan (POST)." | |
| }, | |
| "fields": { | |
| "type": "object", | |
| "position": 99, | |
| "description": "A map of field names to field values e.g. {\"name\":\"Sample Item\", \"status\": 292, \"release\": 2, \"assigned\": 23}", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "RequestArchivedStatus": { | |
| "type": "object", | |
| "properties": { | |
| "archived": { | |
| "type": "boolean", | |
| "position": 1 | |
| } | |
| } | |
| }, | |
| "RequestTestGroupTestCase": { | |
| "type": "object", | |
| "required": ["testCase"], | |
| "properties": { | |
| "testCase": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| } | |
| }, | |
| "TestGroup": { | |
| "type": "object", | |
| "required": ["assignedTo", "id", "name"], | |
| "properties": { | |
| "id": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 10 | |
| }, | |
| "name": { | |
| "type": "string", | |
| "position": 20 | |
| }, | |
| "assignedTo": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 30, | |
| "description": "ID of a user" | |
| } | |
| } | |
| }, | |
| "TestGroupDataListWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/TestGroup" | |
| } | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaListWrapper" | |
| } | |
| } | |
| }, | |
| "RequestTestGroup": { | |
| "type": "object", | |
| "required": ["name"], | |
| "properties": { | |
| "name": { | |
| "type": "string", | |
| "position": 10 | |
| }, | |
| "assignedTo": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 20, | |
| "description": "ID of a user" | |
| } | |
| } | |
| }, | |
| "TestGroupDataWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/definitions/TestGroup" | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaWrapper" | |
| } | |
| } | |
| }, | |
| "TestPlanDataListWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/TestPlan" | |
| } | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaListWrapper" | |
| } | |
| } | |
| }, | |
| "TestRunDataWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/definitions/TestRun" | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaWrapper" | |
| } | |
| } | |
| }, | |
| "VersionedTestRun": { | |
| "type": "object", | |
| "required": ["createdBy", "createdDate", "documentKey", "fields", "globalId", "id", "itemType", "lastActivityDate", "modifiedBy", "modifiedDate", "project", "resources", "sortOrderFromTestGroup", "testCaseVersionNumber", "testGroup"], | |
| "properties": { | |
| "version": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "currentVersion": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "Currently active version of the versioned item. If no version is active, currentVersion will not be returned." | |
| }, | |
| "id": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 1 | |
| }, | |
| "documentKey": { | |
| "type": "string", | |
| "position": 3 | |
| }, | |
| "globalId": { | |
| "type": "string", | |
| "position": 5 | |
| }, | |
| "project": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 7, | |
| "description": "ID of a project" | |
| }, | |
| "itemType": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 9, | |
| "description": "ID of an item type" | |
| }, | |
| "createdDate": { | |
| "type": "string", | |
| "format": "date-time", | |
| "position": 11 | |
| }, | |
| "modifiedDate": { | |
| "type": "string", | |
| "format": "date-time", | |
| "position": 13 | |
| }, | |
| "lastActivityDate": { | |
| "type": "string", | |
| "format": "date-time", | |
| "position": 14 | |
| }, | |
| "createdBy": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 15, | |
| "description": "ID of a user" | |
| }, | |
| "modifiedBy": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 17, | |
| "description": "ID of a user" | |
| }, | |
| "testCaseVersionNumber": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 45, | |
| "description": "The version of the test case at the time of test run creation" | |
| }, | |
| "testCaseCurrentVersionNumber": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 46, | |
| "description": "The current version of the test case that the test run is based on" | |
| }, | |
| "sortOrderFromTestGroup": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 46, | |
| "description": "The sort order within the test group at the time of test cycle creation" | |
| }, | |
| "testGroup": { | |
| "type": "array", | |
| "position": 47, | |
| "description": "ID of a test cycle and ID of a test group", | |
| "items": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| "resources": { | |
| "type": "object", | |
| "position": 95, | |
| "description": "A set of resources and allowed permissions", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/AllowedResource" | |
| } | |
| }, | |
| "fields": { | |
| "type": "object", | |
| "position": 99, | |
| "description": "A map of field names to field values e.g. {\"name\":\"Sample Item\", \"status\": 292, \"release\": 2, \"assigned\": 23}", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "VersionedTestRunDataWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/definitions/VersionedTestRun" | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaWrapper" | |
| } | |
| } | |
| }, | |
| "RequestTestRun": { | |
| "type": "object", | |
| "required": ["fields"], | |
| "properties": { | |
| "fields": { | |
| "type": "object", | |
| "position": 99, | |
| "description": "A map of field names to field values e.g. {\"name\":\"Sample Item\", \"status\": 292, \"release\": 2, \"assigned\": 23}", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "RequestUserGroup": { | |
| "type": "object", | |
| "required": ["description", "name"], | |
| "properties": { | |
| "name": { | |
| "type": "string", | |
| "position": 1 | |
| }, | |
| "description": { | |
| "type": "string", | |
| "position": 3 | |
| }, | |
| "project": { | |
| "type": "integer", | |
| "format": "int32", | |
| "position": 5 | |
| } | |
| } | |
| }, | |
| "User": { | |
| "type": "object", | |
| "required": ["active", "avatarUrl", "email", "firstName", "id", "lastName", "licenseType", "location", "phone", "title", "username"], | |
| "properties": { | |
| "id": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "username": { | |
| "type": "string" | |
| }, | |
| "firstName": { | |
| "type": "string" | |
| }, | |
| "lastName": { | |
| "type": "string" | |
| }, | |
| "email": { | |
| "type": "string" | |
| }, | |
| "phone": { | |
| "type": "string" | |
| }, | |
| "title": { | |
| "type": "string" | |
| }, | |
| "location": { | |
| "type": "string" | |
| }, | |
| "licenseType": { | |
| "type": "string", | |
| "enum": ["NAMED", "FLOATING", "STAKEHOLDER", "FLOATING_COLLABORATOR", "RESERVED_COLLABORATOR", "FLOATING_REVIEWER", "RESERVED_REVIEWER", "NAMED_REVIEWER", "TEST_RUNNER", "EXPIRING_TRIAL", "INACTIVE"] | |
| }, | |
| "avatarUrl": { | |
| "type": "string" | |
| }, | |
| "active": { | |
| "type": "boolean" | |
| } | |
| } | |
| }, | |
| "UserDataListWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/User" | |
| } | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaListWrapper" | |
| } | |
| } | |
| }, | |
| "RequestGroupUser": { | |
| "type": "object", | |
| "required": ["user"], | |
| "properties": { | |
| "user": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| } | |
| }, | |
| "UserGroup": { | |
| "type": "object", | |
| "required": ["id", "name"], | |
| "properties": { | |
| "id": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "project": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "ID of a project" | |
| } | |
| } | |
| }, | |
| "UserGroupDataWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/definitions/UserGroup" | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaWrapper" | |
| } | |
| } | |
| }, | |
| "UserGroupDataListWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/UserGroup" | |
| } | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaListWrapper" | |
| } | |
| } | |
| }, | |
| "UserDataWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/definitions/User" | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaWrapper" | |
| } | |
| } | |
| }, | |
| "RequestUser": { | |
| "type": "object", | |
| "required": ["email", "firstName", "lastName", "licenseType", "password", "username"], | |
| "properties": { | |
| "username": { | |
| "type": "string", | |
| "position": 1, | |
| "description": "Required when creating a new user (POST). Optional on update (PUT)" | |
| }, | |
| "password": { | |
| "type": "string", | |
| "position": 3, | |
| "description": "Required when creating a new user (POST). Not valid on update (PUT)" | |
| }, | |
| "firstName": { | |
| "type": "string", | |
| "position": 5, | |
| "description": "Required when creating a new user (POST). Optional on update (PUT)" | |
| }, | |
| "lastName": { | |
| "type": "string", | |
| "position": 7, | |
| "description": "Required when creating a new user (POST). Optional on update (PUT)" | |
| }, | |
| "email": { | |
| "type": "string", | |
| "position": 9, | |
| "description": "Required when creating a new user (POST). Optional on update (PUT)" | |
| }, | |
| "phone": { | |
| "type": "string", | |
| "position": 11 | |
| }, | |
| "title": { | |
| "type": "string", | |
| "position": 13 | |
| }, | |
| "location": { | |
| "type": "string", | |
| "position": 15 | |
| }, | |
| "licenseType": { | |
| "type": "string", | |
| "position": 17, | |
| "description": "Required when creating a new user (POST). Optional on update (PUT)", | |
| "enum": ["NAMED", "FLOATING", "STAKEHOLDER", "FLOATING_COLLABORATOR", "RESERVED_COLLABORATOR", "FLOATING_REVIEWER", "RESERVED_REVIEWER", "NAMED_REVIEWER", "TEST_RUNNER", "EXPIRING_TRIAL", "INACTIVE"] | |
| } | |
| } | |
| }, | |
| "RequestActiveStatus": { | |
| "type": "object", | |
| "properties": { | |
| "active": { | |
| "type": "boolean", | |
| "position": 1 | |
| } | |
| } | |
| }, | |
| "WorkStatus": { | |
| "type": "object", | |
| "properties": { | |
| "workKey": { | |
| "type": "string" | |
| }, | |
| "jobName": { | |
| "type": "string" | |
| }, | |
| "inProgress": { | |
| "type": "boolean" | |
| }, | |
| "workSteps": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/WorkStepStatus" | |
| } | |
| } | |
| } | |
| }, | |
| "WorkStatusDataWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/definitions/WorkStatus" | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaWrapper" | |
| } | |
| } | |
| }, | |
| "WorkStepStatus": { | |
| "type": "object", | |
| "properties": { | |
| "stepName": { | |
| "type": "string" | |
| }, | |
| "completedWork": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "totalWork": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| } | |
| }, | |
| "DerivedDataFailure": { | |
| "type": "object", | |
| "properties": { | |
| "itemId": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "databaseValue": { | |
| "type": "object" | |
| }, | |
| "calculatedValue": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "DerivedDataHealthDetailsReport": { | |
| "type": "object", | |
| "properties": { | |
| "numberItemsChecked": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "numberChecksFailed": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "failures": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/DerivedDataFailure" | |
| } | |
| } | |
| } | |
| }, | |
| "DerivedDataHealthReport": { | |
| "type": "object", | |
| "properties": { | |
| "reportType": { | |
| "type": "string" | |
| }, | |
| "generatedDate": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "derivedDataHealthDetails": { | |
| "$ref": "#/definitions/DerivedDataHealthDetailsReport" | |
| } | |
| } | |
| }, | |
| "DerivedDataHealthReportDataWrapper": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/definitions/DerivedDataHealthReport" | |
| }, | |
| "links": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| }, | |
| "linked": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "meta": { | |
| "$ref": "#/definitions/MetaWrapper" | |
| } | |
| } | |
| }, | |
| "RequestDerivedDataHealthReport": { | |
| "type": "object", | |
| "properties": { | |
| "reportType": { | |
| "type": "string", | |
| "enum": ["TEST_CASE_STATUS", "CALCULATED", "ROLLUP", "RELATIONSHIP_STATS"] | |
| }, | |
| "repair": { | |
| "type": "boolean" | |
| } | |
| } | |
| } | |
| } | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment