{ "openapi": "3.0.0", "info": { "title": "Spira REST API", "version": "7.0", "description": "REST API for Spira v7.0" }, "servers": [ { "url": "https://eti.spiraservice.net/Services/v7_0/RestService.svc" } ], "tags": [ { "name": "Artifact Documents", "description": "This resource lets you view/add documents associated to an artifact" }, { "name": "Association", "description": "This resource lets you create, view and update artifact associations" }, { "name": "Automated Test Run", "description": "This resource allows you to retrieve, create, modify and delete automated test runs in a specific project in the system." }, { "name": "Automation Engine", "description": "This resource lets you create, and view automation engines in the system" }, { "name": "Automation Host", "description": "This resource lets you create, view, update and delete automation hosts in the system" }, { "name": "Capabilities", "description": "This resource lets you create, view, and update capabilities in a given program" }, { "name": "Capability Priority", "description": "This resource lets you create, view, and update capability priorities in the system" }, { "name": "Capability Requirement Association", "description": "This resource allows you to retrieve, create, and remove associations between a Capability and Requirement(s)" }, { "name": "Capability Status", "description": "This resource lets you create, view, and update capability statuses in the system" }, { "name": "Capability Type", "description": "This resource lets you create, view, and update capability types in the system" }, { "name": "Component", "description": "This resource lets you create, edit, delete and view components in a project" }, { "name": "Custom List", "description": "This resource allows you to retrieve and edit the custom lists defined in a specific project template" }, { "name": "Custom List Value", "description": "This resource allows you to add custom list values to a custom list in a project template" }, { "name": "Custom Property", "description": "This resource allows you to retrieve and edit the custom properties defined in a specific project template" }, { "name": "Custom Query", "description": "This resource lets you create custom ESQL queries and return data" }, { "name": "Data Mapping Artifacts", "description": "This resource lets you create and retrieve the data mapping for artifacts" }, { "name": "Data Mapping Custom Properties", "description": "This resource lets you view the custom property data mappings" }, { "name": "Data Mapping Custom Property Values", "description": "This resource lets you view the custom property value data mappings" }, { "name": "Data Mapping Field Values", "description": "This resource lets you view the standard field data mappings" }, { "name": "Data Mapping Projects", "description": "This resource lets you view the project data mappings" }, { "name": "Data Mapping Users", "description": "This resource lets you view and add user data mappings" }, { "name": "Data Sync", "description": "This resource lets you retrieve the data synchronization plugins configured and update the synchronization status" }, { "name": "Data Sync Event", "description": "This resource lets you record events in Spira from data-synchronization activities" }, { "name": "Document", "description": "This resource allows access to the document attachments in the system" }, { "name": "Document Folder", "description": "This resources provides access to the active document folders in the project" }, { "name": "Document Status", "description": "This resources provides access to the active document statuses in the product template" }, { "name": "Document Type", "description": "This resources provides access to the active document types in the product template" }, { "name": "Document Version", "description": "This resource lets you add new versions of documents" }, { "name": "Floating Licenses", "description": "This resource lets you manage floating licenses" }, { "name": "Graphs", "description": "This resource lets you retrieve custom graph data and images" }, { "name": "History", "description": "This resource lets you view the history of changes made to artifacts" }, { "name": "Incident", "description": "This resource allows you to retrieve, create, modify and delete incidents in a specific project in the system." }, { "name": "Incident Comment", "description": "This resource allows you to retrieve the comments associated with an incident as well as add new comments to an existing incident." }, { "name": "Incident Priority", "description": "This resource allows you to retrieve/create incident priorities defined in a specific project template" }, { "name": "Incident Severity", "description": "This resource allows you to retrieve/create incident severities defined in a specific project template" }, { "name": "Incident Status", "description": "This resource allows you to retrieve/create incident statuses defined in a specific project template" }, { "name": "Incident Type", "description": "This resource allows you to retrieve/create incident types defined in a specific project template" }, { "name": "Manual Test Run", "description": "This resource allows you to retrieve, create, modify and delete manual test runs in a specific project in the system." }, { "name": "Message", "description": "This resource lets you receive and send instant messages" }, { "name": "Program Milestone Releases", "description": "This resource allows you to retrieve, add and remove project releases associations to program milestones" }, { "name": "Program Milestone Statuses", "description": "This resource allows you to retrieve, add, and update system wide program milestone statuses" }, { "name": "Program Milestone Types", "description": "This resource allows you to retrieve, add, and update the system wide program milestone types" }, { "name": "Program Milestones", "description": "This resource allows you to retrieve, create, modify & delete program milestones within a given program" }, { "name": "Programs", "description": "This resource allows you to retrieve programs you have permissions to view" }, { "name": "Project", "description": "This resource allows you to retrieve projects in the system" }, { "name": "Project Role", "description": "This resource lets you view, create, update and delete project roles in the system" }, { "name": "Project Template", "description": "This resource allows you to retrieve, create, delete, and update project templates in the system" }, { "name": "Project User", "description": "This resource allows you to retrieve and modify the users associated with a specific project" }, { "name": "Release", "description": "This resource allows you to retrieve and manage the releases and iterations defined in a specific project" }, { "name": "Release Build", "description": "This resource lets you create, and view automated builds in the system" }, { "name": "Release Comments", "description": "This resource allows you to retrieve the comments associated with a release as well as add new comments to an existing release. " }, { "name": "Release Status", "description": "This resource lets you retrieve the list of release statuses in the system" }, { "name": "Release Test Cases", "description": "This resource lets you retrieve, add and remove test cases to/from releases" }, { "name": "Release Type", "description": "This resource lets you retrieve the list of release types in the system" }, { "name": "Reports: Generated", "description": "This resource lets you check the status and retrieve a generated reports" }, { "name": "Reports: Saved", "description": "This resource lets you retrieve and generate a saved report" }, { "name": "Requirement", "description": "This resource allows you to retrieve, create, modify and delete requirements in a specific project in the system." }, { "name": "Requirement Comment", "description": "This resource lets you retrieve and add comments to a requirement in the system." }, { "name": "Requirement Importance", "description": "This resource lets you retrieve the list of requirement importances in the project template" }, { "name": "Requirement Status", "description": "This resource lets you retrieve the list of requirement statuses in the project template" }, { "name": "Requirement Step", "description": "This resource lets you create, modify and retrieve requirement steps" }, { "name": "Requirement Test Coverage", "description": "This resource lets you view, add and remove test cases from requirements." }, { "name": "Requirement Test Step Coverage", "description": "This resource lets you view, add and remove test steps from requirements." }, { "name": "Requirement Type", "description": "This resource lets you retrieve the list of requirement types in the project template" }, { "name": "Risk", "description": "This resource allows you to retrieve, create, modify and delete risks in a specific project in the system." }, { "name": "Risk Comment", "description": "This resource allows you to add and retrieve risk comments in the system" }, { "name": "Risk Impact", "description": "This resource lets you retrieve the list of risk impacts in the project template" }, { "name": "Risk Mitigation", "description": "This resource lets you create, modify and retrieve risk mitigations" }, { "name": "Risk Probability", "description": "This resource lets you retrieve the list of risk probabilities in the project template" }, { "name": "Risk Status", "description": "This resource lets you retrieve the list of Risk statuses in the system" }, { "name": "Risk Type", "description": "This resource lets you retrieve the list of Risk types in the project template" }, { "name": "Saved Filters", "description": "This resource lets you retrieve the saved filters for a user" }, { "name": "Source Code", "description": "This resource lets you view changes and code in linked source code repositories" }, { "name": "Source Code File", "description": "This resource lets you view the source code files" }, { "name": "Source Code Folder", "description": "This resource lets you view the source code folders" }, { "name": "Source Code Provider Products", "description": "This resource lets you retrieve, create and modify source code product configurations, so source code can be hooked up at the product level" }, { "name": "Source Code Providers", "description": "This resource lets you retrieve, create and modify source code providers for setting up source code integrations" }, { "name": "Source Code Revision", "description": "This resource lets you view the revisions in linked source code repositories" }, { "name": "Subscriptions", "description": "This resource lets you view subscribed items as well as subscribe/unsubscribe to artifacts" }, { "name": "System", "description": "This resource contains information on the overall product instance, including version and settings information" }, { "name": "System Custom List", "description": "This resource allows you to retrieve and edit the custom lists defined for global objects" }, { "name": "System Custom Property", "description": "This resource allows you to retrieve and edit the custom properties defined for global objects" }, { "name": "Task", "description": "This resource allows you to retrieve, create, modify and delete tasks in a specific project in the system." }, { "name": "Task Comment", "description": "This resource allows you to add and retrieve task comments in the system" }, { "name": "Task Folder", "description": "This resource allows you to retrieve, create, modify and delete task folders in the project" }, { "name": "Task Priority", "description": "This resource lets you retrieve the list of task priorities in the project template" }, { "name": "Task Status", "description": "This resource lets you retrieve the list of Task statuses in the system" }, { "name": "Task Type", "description": "This resource lets you retrieve the list of Task types in the project template" }, { "name": "Test Case", "description": "This resource allows you to retrieve, create, modify and delete test cases in a specific project in the system." }, { "name": "Test Case Comment", "description": "This resource lets you add and view comments associated with test cases" }, { "name": "Test Case Folder", "description": "This resource allows you to retrieve, create, modify and delete test case folders in the project" }, { "name": "Test Case Folder Test Cases", "description": "This resources lets you retrieve test cases and count test cases by their containing folder" }, { "name": "Test Case Link", "description": "This resource lets you add linked test cases to a test case" }, { "name": "Test Case Parameter", "description": "This resource allows you to add/remove parameters to test cases" }, { "name": "Test Case Priority", "description": "This resource lets you retrieve the list of Test Case priorities in the project template" }, { "name": "Test Case Requirement Coverage", "description": "This resource lets you retrieve the list of Requirements that a Test Case is covering" }, { "name": "Test Case Status", "description": "This resource lets you retrieve the list of Test Case statuses in the system" }, { "name": "Test Case Type", "description": "This resource lets you retrieve the list of Test Case types in the project template" }, { "name": "Test Configuration Set", "description": "This resource lets you retrieve test configuration sets" }, { "name": "Test Run", "description": "This resource allows you to retrieve, create, modify and delete test runs in a specific project in the system." }, { "name": "Test Set", "description": "This resource lets you create, view, edit and delete test sets in the system" }, { "name": "Test Set Comment", "description": "This resource lets you add and view comments associated with test sets" }, { "name": "Test Set Folder", "description": "This resource lets you create, view, edit and delete test set folders in the system" }, { "name": "Test Set Folder Test Sets", "description": "This resources lets you retrieve test sets and count test sets by their containing folder" }, { "name": "Test Set Parameter", "description": "This resource lets you the retrieve test parameter values associated with test sets" }, { "name": "Test Set Test Case", "description": "This resource lets you create, view, modify the test cases associated with test sets" }, { "name": "Test Set Test Case Parameter", "description": "This resource lets you retrieve the test parameter values associated with the test cases inside a test set" }, { "name": "Test Step", "description": "This resource lets you create and delete test steps from test cases in the system" }, { "name": "Test Step Parameter", "description": "This resource lets you retrieve the parameters associated with a specific test step" }, { "name": "Timesheet Entries", "description": "This resource allows you to retrieve, create, modify and delete Timesheet Entries in the system." }, { "name": "Timesheet Status", "description": "This resource lets you retrieve the list of Timesheet statuses in the system" }, { "name": "Timesheets", "description": "This resource allows you to retrieve, create, modify and delete Timesheets in the system." }, { "name": "User", "description": "This resource lets you create, retrieve and delete users in the system" }, { "name": "User Contact", "description": "This resource lets you view a list of contacts, add a contact and remove one" } ], "components": { "securitySchemes": { "basicAuth": { "type": "http", "scheme": "basic" }, "apiKeyHeader": { "type": "apiKey", "in": "header", "name": "api-key" } }, "schemas": { "Boolean": { "type": "object", "properties": { "TrueString": {"type": "string"}, "FalseString": {"type": "string"} } }, "Byte": { "type": "object", "properties": { "MaxValue": {"type": "object", "description": "Schema: Byte"}, "MinValue": {"type": "object", "description": "Schema: Byte"} } }, "DateRange": { "type": "object" }, "DateTime": { "type": "object", "properties": { "MinValue": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z"}, "MaxValue": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z"} } }, "Int32": { "type": "object", "properties": { "MaxValue": {"type": "integer"}, "MinValue": {"type": "integer"} } }, "Int64": { "type": "object", "properties": { "MaxValue": {"type": "integer"}, "MinValue": {"type": "integer"} } }, "RemoteArtifactSubscription": { "type": "object", "properties": { "ArtifactId": {"type": "integer", "description": "The id of the artifact"}, "ArtifactTypeId": {"type": "integer", "description": "The id of the artifact type"}, "ArtifactName": {"type": "string", "description": "The name of the artifact"}, "ArtifactDescription": {"type": "string", "description": "The long description of the artifact"}, "ArtifactTypeName": {"type": "string", "description": "The display name of the type of artifact"}, "ProjectId": {"type": "integer", "description": "The id of the project"}, "ProjectName": {"type": "string", "description": "The name of the project"}, "UserId": {"type": "integer", "description": "The id of the user"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The date/time the artifact was last updated"}, "UserFullName": {"type": "string", "description": "The full name of the user"} } }, "RemoteAssociation": { "type": "object", "properties": { "ArtifactLinkId": {"type": "integer", "nullable": true, "description": "The id of the association/link"}, "SourceArtifactId": {"type": "integer", "description": "The artifact id being linked FROM"}, "SourceArtifactTypeId": {"type": "integer", "description": "The type of artifact being linked FROM"}, "SourceArtifactGuid": {"type": "string", "description": "GUID of the artifact being linked FROM"}, "DestArtifactId": {"type": "integer", "description": "The artifact id being linked TO"}, "DestArtifactTypeId": {"type": "integer", "description": "The type of artifact being linked TO"}, "DestArtifactGuid": {"type": "string", "description": "GUID of the artifact being linked TO"}, "ArtifactLinkTypeId": {"type": "integer", "description": "The type of artifact link (related to, depends-upon, etc.)"}, "CreatorId": {"type": "integer", "nullable": true, "description": "The user creating the association/link"}, "Comment": {"type": "string", "description": "A comment that describes the association in more detail"}, "CreationDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "The date/time the association was created"}, "DestArtifactName": {"type": "string", "description": "The display name of the artifact being linked to"}, "DestArtifactTypeName": {"type": "string", "description": "The display name of the type of artifact being linked to"}, "CreatorName": {"type": "string", "description": "The display name of the user that created the association/link"}, "ArtifactLinkTypeName": {"type": "string", "description": "The display name of the type of association/link"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"}, "ConcurrencyGuid": {"type": "string", "description": "GUID for representing the concurrency state of a given artifact"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last time the artifact was updated"} } }, "RemoteAutomatedTestRun": { "type": "object", "properties": { "TestRunFormatId": {"type": "integer", "description": "The format of the automation results (1=Plain Text, 2=HTML) stored in the 'RunnerStackTrace' field - required"}, "RunnerName": {"type": "string", "description": "The name of the external automated tool that executed the test - required"}, "RunnerTestName": {"type": "string", "description": "The name of the test case as it is known in the external tool - required"}, "RunnerAssertCount": {"type": "integer", "nullable": true, "description": "The number of assertions/errors reported during the automated test execution"}, "RunnerMessage": {"type": "string", "description": "The summary result of the test case - required"}, "RunnerStackTrace": {"type": "string", "description": "The detailed trace of test results reported back from the automated testing tool - required"}, "AutomationHostId": {"type": "integer", "nullable": true, "description": "The id of the automation host that the result is being recorded for"}, "AutomationEngineId": {"type": "integer", "nullable": true, "description": "The id of the automation engine that the result is being recorded for"}, "AutomationEngineToken": {"type": "string", "description": "The token of the automation engine that the result is being recorded for (read-only)"}, "AutomationAttachmentId": {"type": "integer", "nullable": true, "description": "The id of the attachment that is being used to store the test script (file or url)"}, "Parameters": {"type": "array", "description": "The list of test case parameters that have been provided", "items": {"type": "object", "description": "Schema: RemoteTestSetTestCaseParameter"}}, "ScheduledDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "The datetime the test was scheduled for"}, "TestRunSteps": {"type": "array", "description": "The list of test steps that comprise the automated test", "items": {"type": "object", "description": "Schema: RemoteTestRunStep"}}, "TestRunId": {"type": "integer", "nullable": true, "description": "The id of the test run"}, "Name": {"type": "string", "description": "The name of the test run (usually the same as the test case)"}, "TestCaseId": {"type": "integer", "description": "The id of the test case that the test run is an instance of"}, "TestCaseGuid": {"type": "string", "description": "The guid of the test case that the test run is an instance of"}, "TestRunTypeId": {"type": "integer", "description": "The id of the type of test run (automated vs. manual)"}, "TesterId": {"type": "integer", "nullable": true, "description": "The id of the user that executed the test"}, "TesterGuid": {"type": "string", "description": "The guid of the tester."}, "ExecutionStatusId": {"type": "integer", "description": "The id of overall execution status for the test run"}, "ReleaseId": {"type": "integer", "nullable": true, "description": "The id of the release that the test run should be reported against"}, "ReleaseGuid": {"type": "string", "description": "The guid of the release"}, "TestSetId": {"type": "integer", "nullable": true, "description": "The id of the test set that the test run should be reported against"}, "TestSetGuid": {"type": "string", "description": "The guid of the test set"}, "TestSetTestCaseId": {"type": "integer", "nullable": true, "description": "The id of the unique test case entry in the test set"}, "StartDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The date/time that the test execution was started"}, "EndDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "The date/time that the test execution was completed"}, "BuildId": {"type": "integer", "nullable": true, "description": "The id of the build that the test was executed against"}, "EstimatedDuration": {"type": "integer", "nullable": true, "description": "The estimated duration of how long the test should take to execute (read-only)"}, "ActualDuration": {"type": "integer", "nullable": true, "description": "The actual duration of how long the test should take to execute (read-only)"}, "TestConfigurationId": {"type": "integer", "nullable": true, "description": "The id of the specific test configuration that was used"}, "ReleaseVersionNumber": {"type": "string", "description": "version number of the release this test run was run against."}, "ProjectId": {"type": "integer", "description": "The id of the project that the artifact belongs to"}, "ProjectGuid": {"type": "string", "description": "The guid of the project that the artifact belongs to"}, "ArtifactTypeId": {"type": "integer", "description": "The type of artifact that we have"}, "ConcurrencyDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The datetime used to track optimistic concurrency to prevent edit conflicts"}, "CustomProperties": {"type": "array", "description": "The list of associated custom properties/fields for this artifact", "items": {"type": "object", "description": "Schema: RemoteArtifactCustomProperty"}}, "IsAttachments": {"type": "boolean", "description": "Does this artifact have any attachments?"}, "Tags": {"type": "string", "description": "The list of meta-tags that should be associated with the artifact"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"} } }, "RemoteAutomationEngine": { "type": "object", "properties": { "AutomationEngineId": {"type": "integer", "nullable": true, "description": "The id of the engine"}, "Name": {"type": "string", "description": "The display name of the engine"}, "Token": {"type": "string", "description": "The token of the engine"}, "Description": {"type": "string", "description": "The detailed description of the engine"}, "Active": {"type": "boolean", "description": "Is this host active for the project"} } }, "RemoteAutomationHost": { "type": "object", "properties": { "AutomationHostId": {"type": "integer", "nullable": true, "description": "The id of the host"}, "Name": {"type": "string", "description": "The name of the host"}, "Token": {"type": "string", "description": "The token of the host"}, "Description": {"type": "string", "description": "The detailed description of the host"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The date/time that the host was last modified"}, "Active": {"type": "boolean", "description": "Is this host active for the project"}, "LastContactDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "The last time this host was contacted"}, "ProjectId": {"type": "integer", "description": "The id of the project that the artifact belongs to"}, "ProjectGuid": {"type": "string", "description": "The guid of the project that the artifact belongs to"}, "ArtifactTypeId": {"type": "integer", "description": "The type of artifact that we have"}, "ConcurrencyDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The datetime used to track optimistic concurrency to prevent edit conflicts"}, "CustomProperties": {"type": "array", "description": "The list of associated custom properties/fields for this artifact", "items": {"type": "object", "description": "Schema: RemoteArtifactCustomProperty"}}, "IsAttachments": {"type": "boolean", "description": "Does this artifact have any attachments?"}, "Tags": {"type": "string", "description": "The list of meta-tags that should be associated with the artifact"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"} } }, "RemoteBuild": { "type": "object", "properties": { "BuildId": {"type": "integer", "nullable": true, "description": "The id of the build"}, "Guid": {"type": "string", "description": "The unique identifier for the build"}, "BuildStatusId": {"type": "integer", "description": "The id of the status of the build (1=Failed, 2=Passed)"}, "ProjectId": {"type": "integer", "description": "The id of the project the build belongs to"}, "ReleaseId": {"type": "integer", "description": "The id of the release or iteration the build belongs to"}, "ReleaseGuid": {"type": "string", "description": "The guid of the release or iteration the build belongs to"}, "Name": {"type": "string", "description": "The name of the build"}, "Description": {"type": "string", "description": "The detailed description of the host"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The date/time that the build was last modified"}, "CreationDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "The date the build was created"}, "BuildStatusName": {"type": "string", "description": "The display name of the status of the build"}, "Revisions": {"type": "array", "description": "The list of source code revisions associated with the build", "items": {"type": "object", "description": "Schema: RemoteBuildSourceCode"}} } }, "RemoteCapability": { "type": "object", "properties": { "CapabilityId": {"type": "integer", "nullable": true, "description": "ID of the program capability"}, "ProjectGroupId": {"type": "integer", "description": "ID of the project group which this capability belongs to"}, "MilestoneId": {"type": "integer", "nullable": true, "description": "The ID of the Program Milestone this capability belongs to"}, "MilestoneName": {"type": "string", "description": "The name of the Program Milestone this capability belongs to"}, "StatusId": {"type": "integer", "description": "ID of the capability status this capability has"}, "StatusName": {"type": "string", "description": "Name of the capability status this capability has"}, "StatusIsOpen": {"type": "boolean", "nullable": true, "description": "Whether or not this status makes this capability \"Open\""}, "TypeId": {"type": "integer", "description": "ID of the capability type this capability has"}, "TypeName": {"type": "string", "description": "Name of the capability type this capability has"}, "PriorityId": {"type": "integer", "nullable": true, "description": "ID of the capability priority this capability has"}, "PriorityName": {"type": "string", "description": "Name of the capability priority this capability has"}, "Name": {"type": "string", "description": "Name of this capability"}, "Description": {"type": "string", "description": "Description of the capability"}, "PercentComplete": {"type": "integer", "description": "Percent Completion of the capability"}, "RequirementCount": {"type": "integer", "description": "Number of requirements associated with this capability"}, "IndentLevel": {"type": "string", "description": "Indent level of this capability in the hierarchy"}, "Guid": {"type": "string", "description": "Artifact guid for avoiding concurrency interactions"}, "CreatorId": {"type": "integer", "nullable": true, "description": "UserId of the creator of this capability"}, "CreatorName": {"type": "string", "description": "Full name of the creator of this capability"}, "OwnerId": {"type": "integer", "nullable": true, "description": "UserId of the owner of this capability"}, "OwnerName": {"type": "string", "description": "Full name of the owner of this capability"}, "CreationDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true}, "IsSummary": {"type": "boolean", "description": "This Capability represents a summary in the program?"}, "ArtifactTypeId": {"type": "integer", "description": "The type of artifact that we have"}, "ConcurrencyGuid": {"type": "string", "description": "The field used to track optimistic concurrency to prevent edit conflicts"}, "CustomProperties": {"type": "array", "description": "The list of associated custom properties/fields for this workspace", "items": {"type": "object", "description": "Schema: RemoteSystemArtifactCustomProperty"}} } }, "RemoteCapabilityPriority": { "type": "object", "properties": { "CapabilityPriorityId": {"type": "integer", "nullable": true, "description": "The id of the capability priority"}, "Name": {"type": "string", "description": "The name of the priority"}, "Color": {"type": "string", "description": "The hex color code associated with the priority (string)"}, "IsActive": {"type": "boolean", "description": "Is this an active priority"}, "Score": {"type": "integer", "nullable": true, "description": "The score value"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"}, "ConcurrencyGuid": {"type": "string", "description": "GUID for representing the concurrency state of a given artifact"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last time the artifact was updated"} } }, "RemoteCapabilityStatus": { "type": "object", "properties": { "CapabilityStatusId": {"type": "integer", "nullable": true, "description": "The id of the capability status"}, "Name": {"type": "string", "description": "The name of the status"}, "Position": {"type": "integer", "description": "The position of the status in the list"}, "IsActive": {"type": "boolean", "description": "Is this an active status"}, "IsDefault": {"type": "boolean", "description": "Is this the default status"}, "IsOpen": {"type": "boolean", "description": "Is this an open status"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"}, "ConcurrencyGuid": {"type": "string", "description": "GUID for representing the concurrency state of a given artifact"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last time the artifact was updated"} } }, "RemoteCapabilityType": { "type": "object", "properties": { "CapabilityTypeId": {"type": "integer", "nullable": true, "description": "The id of the capability type"}, "Name": {"type": "string", "description": "The name of the type"}, "IsActive": {"type": "boolean", "description": "Is this an active type"}, "IsDefault": {"type": "boolean", "description": "Is this the default type"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"}, "ConcurrencyGuid": {"type": "string", "description": "GUID for representing the concurrency state of a given artifact"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last time the artifact was updated"} } }, "RemoteComment": { "type": "object", "properties": { "CommentId": {"type": "integer", "nullable": true, "description": "The unique ID for this comment / artifact type."}, "ArtifactId": {"type": "integer", "description": "The artifact ID that this comment belongs to."}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"}, "UserId": {"type": "integer", "nullable": true, "description": "The userID of the author."}, "UserGuid": {"type": "string", "description": "The user guid."}, "UserName": {"type": "string", "description": "The full name of the author."}, "Text": {"type": "string", "description": "The text of the comment."}, "CreationDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "The date and time the comment was made."}, "IsDeleted": {"type": "boolean", "description": "Whether the comment was marked for deletion or hidden."}, "IsPermanent": {"type": "boolean", "description": "Whether the comment can be deleted or is a permanent one"} } }, "RemoteComponent": { "type": "object", "properties": { "ComponentId": {"type": "integer", "nullable": true, "description": "The id of the Component (id - integer)"}, "ProjectId": {"type": "integer", "description": "The id of the project the component belongs to (id - integer)"}, "Name": {"type": "string", "description": "The name of the Component (string)"}, "IsActive": {"type": "boolean", "description": "Is the component active (boolean)"}, "IsDeleted": {"type": "boolean", "description": "Is the component deleted (boolean)"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"}, "ConcurrencyGuid": {"type": "string", "description": "GUID for representing the concurrency state of a given artifact"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last time the artifact was updated"} } }, "RemoteCustomList": { "type": "object", "properties": { "CustomPropertyListId": {"type": "integer", "nullable": true, "description": "The id of the custom list"}, "ProjectTemplateId": {"type": "integer", "description": "The id of the project template the custom list belongs to"}, "Name": {"type": "string", "description": "The name of the custom list"}, "Active": {"type": "boolean", "description": "Whether the list is active or not"}, "SortedOnValue": {"type": "boolean", "description": "Whether the list is sorted on value or not"}, "Values": {"type": "array", "description": "The collection of values in the custom list", "items": {"type": "object", "description": "Schema: RemoteCustomListValue"}}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"}, "ConcurrencyGuid": {"type": "string", "description": "GUID for representing the concurrency state of a given artifact"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last time the artifact was updated"} } }, "RemoteCustomListValue": { "type": "object", "properties": { "CustomPropertyValueId": {"type": "integer", "nullable": true, "description": "The id of the custom list value"}, "CustomPropertyListId": {"type": "integer", "description": "The id of the custom list the value belongs to"}, "Name": {"type": "string", "description": "The name of the custom list value"}, "Active": {"type": "boolean", "description": "Is the custom list value active or not"}, "ParentCustomPropertyValueId": {"type": "integer", "nullable": true, "description": "The id of any parent custom list value"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"}, "ConcurrencyGuid": {"type": "string", "description": "GUID for representing the concurrency state of a given artifact"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last time the artifact was updated"} } }, "RemoteCustomProperty": { "type": "object", "properties": { "CustomPropertyId": {"type": "integer", "nullable": true, "description": "The id of the custom property (leave null for newly created ones)"}, "ProjectTemplateId": {"type": "integer", "description": "The project template the custom property belongs to"}, "ArtifactTypeId": {"type": "integer", "description": "The artifact type that the custom property is for"}, "Name": {"type": "string", "description": "The display name for the custom property"}, "CustomList": {"type": "object", "description": "The associated custom list if this is a list custom property (Schema: RemoteCustomList)"}, "CustomPropertyFieldName": {"type": "string", "description": "The internal field name of the custom property (e.g. Custom_01)"}, "CustomPropertyTypeId": {"type": "integer", "description": "The type of custom property. It can have the following values:\n Text = 1,\n Integer = 2,\n Decimal = 3,\n Boolean = 4,\n Date = 5,\n List = 6,\n MultiList = 7,\n User = 8,\n Password = 9,\n Release = 10,\n Date and Time = 11,\n Automation Host = 12"}, "CustomPropertyTypeName": {"type": "string", "description": "The display name of the type of custom property"}, "IsDeleted": {"type": "boolean", "description": "Has this custom property been deleted"}, "PropertyNumber": {"type": "integer", "description": "The position number of this custom property (1-30). Each artifact type can have 30 custom properties per project"}, "SystemDataType": {"type": "string", "description": "The physical data type that this custom property is stored as (Int32, String, DataTime, etc.)"}, "Options": {"type": "array", "description": "The collection of custom property options", "items": {"type": "object", "description": "Schema: RemoteCustomPropertyOption"}}, "Position": {"type": "integer", "nullable": true, "description": "The position of this property in the user interface"}, "Description": {"type": "string", "description": "Describes the purpose of this custom property"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"}, "ConcurrencyGuid": {"type": "string", "description": "GUID for representing the concurrency state of a given artifact"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last time the artifact was updated"} } }, "RemoteDataMapping": { "type": "object", "properties": { "ProjectId": {"type": "integer", "nullable": true, "description": "The project that the data mapping entry relates to (null if it's not project specific)"}, "InternalId": {"type": "integer", "description": "The id of the item inside Spira"}, "ExternalKey": {"type": "string", "description": "The id of the item in the external system"}, "Primary": {"type": "boolean", "description": "Whether this is the primary external mapped value in the case of 1..n mapping"}, "ArtifactTypeId": {"type": "integer", "nullable": true, "description": "If the data mapping is an artifact data mapping, gives ArtifactTypeId whcih the InternalId relates to"} } }, "RemoteDataSyncSystem": { "type": "object", "properties": { "DataSyncSystemId": {"type": "integer", "description": "The id the data-sync plug-in"}, "DataSyncStatusId": {"type": "integer", "description": "The id of the synchronization status (for the last time it ran)"}, "Name": {"type": "string", "description": "The name of the data-sync plug-in"}, "DisplayName": {"type": "string", "description": "The display name of the data-sync plug-in"}, "Description": {"type": "string", "description": "The description of the data-sync plug-in"}, "ConnectionString": {"type": "string", "description": "The connection string (often a URL) for accessing the external system"}, "Login": {"type": "string", "description": "The username / login for accessing the external system"}, "Password": {"type": "string", "description": "The password for accessing the external system"}, "TimeOffsetHours": {"type": "integer", "description": "The number of hours to add to the last-updated date/times when making comparisons"}, "LastSyncDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "The date/time that the data-sync last ran"}, "Custom01": {"type": "string", "description": "Custom value, its use is dependent on the specific data-sync plug-in"}, "Custom02": {"type": "string", "description": "Custom value, its use is dependent on the specific data-sync plug-in"}, "Custom03": {"type": "string", "description": "Custom value, its use is dependent on the specific data-sync plug-in"}, "Custom04": {"type": "string", "description": "Custom value, its use is dependent on the specific data-sync plug-in"}, "Custom05": {"type": "string", "description": "Custom value, its use is dependent on the specific data-sync plug-in"}, "Custom06": {"type": "string", "description": "Custom value, its use is dependent on the specific data-sync plug-in"}, "Custom07": {"type": "string", "description": "Custom value, its use is dependent on the specific data-sync plug-in"}, "Custom08": {"type": "string", "description": "Custom value, its use is dependent on the specific data-sync plug-in"}, "Custom09": {"type": "string", "description": "Custom value, its use is dependent on the specific data-sync plug-in"}, "Custom10": {"type": "string", "description": "Custom value, its use is dependent on the specific data-sync plug-in"}, "Custom11": {"type": "string", "description": "Custom value, its use is dependent on the specific data-sync plug-in"}, "Custom12": {"type": "string", "description": "Custom value, its use is dependent on the specific data-sync plug-in"}, "Custom13": {"type": "string", "description": "Custom value, its use is dependent on the specific data-sync plug-in"}, "Custom14": {"type": "string", "description": "Custom value, its use is dependent on the specific data-sync plug-in"}, "Custom15": {"type": "string", "description": "Custom value, its use is dependent on the specific data-sync plug-in"}, "Custom16": {"type": "string", "description": "Custom value, its use is dependent on the specific data-sync plug-in"}, "Custom17": {"type": "string", "description": "Custom value, its use is dependent on the specific data-sync plug-in"}, "Custom18": {"type": "string", "description": "Custom value, its use is dependent on the specific data-sync plug-in"}, "Custom19": {"type": "string", "description": "Custom value, its use is dependent on the specific data-sync plug-in"}, "Custom20": {"type": "string", "description": "Custom value, its use is dependent on the specific data-sync plug-in"}, "Custom21": {"type": "string", "description": "Custom value, its use is dependent on the specific data-sync plug-in"}, "Custom22": {"type": "string", "description": "Custom value, its use is dependent on the specific data-sync plug-in"}, "Custom23": {"type": "string", "description": "Custom value, its use is dependent on the specific data-sync plug-in"}, "Custom24": {"type": "string", "description": "Custom value, its use is dependent on the specific data-sync plug-in"}, "Custom25": {"type": "string", "description": "Custom value, its use is dependent on the specific data-sync plug-in"}, "AutoMapUsers": {"type": "boolean", "description": "Should we attempt to auto-map user in the two systems"}, "DataSyncStatusName": {"type": "string", "description": "The display name of the synchronization status"}, "IsActive": {"type": "boolean", "description": "Is the data-sync system active"} } }, "RemoteDocument": { "type": "object", "properties": { "AttachmentId": {"type": "integer", "nullable": true, "description": "The id of the attachment"}, "AttachmentTypeId": {"type": "integer", "description": "The id of the attachment type"}, "DocumentTypeId": {"type": "integer", "nullable": true, "description": "The id of the document type relative to the current project template"}, "DocumentStatusId": {"type": "integer", "nullable": true, "description": "The id of the document status relative to the current project template"}, "ProjectAttachmentFolderId": {"type": "integer", "nullable": true, "description": "The id of the attachment folder id for the current project"}, "AttachedArtifacts": {"type": "array", "description": "The list of artifacts the document is attached to", "items": {"type": "object", "description": "Schema: RemoteLinkedArtifact"}}, "AuthorId": {"type": "integer", "nullable": true, "description": "The id of the user that uploaded the attachment"}, "EditorId": {"type": "integer", "nullable": true, "description": "The id of the user that edited the document"}, "AuthorGuid": {"type": "string", "description": "The guid of the author."}, "EditorGuid": {"type": "string", "description": "The guid of the editor."}, "FilenameOrUrl": {"type": "string", "description": "The filename of the file (if a file attachment) or the full URL if a URL attachment"}, "Description": {"type": "string", "description": "The description of the attachment"}, "UploadDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The date/time the attachment was uploaded"}, "EditedDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The date/time the attachment was last edited"}, "Size": {"type": "integer", "description": "The size of the attachment in bytes"}, "CurrentVersion": {"type": "string", "description": "The version name of the current attachment"}, "Versions": {"type": "array", "description": "The list of document versions", "items": {"type": "object", "description": "Schema: RemoteDocumentVersion"}}, "DocumentTypeName": {"type": "string", "description": "The display name of the attachment type relative to the current project template"}, "DocumentStatusName": {"type": "string", "description": "The display name of the document status relative to the current project template"}, "AttachmentTypeName": {"type": "string", "description": "The display name of the attachment type (i.e. whether it's a file or url)"}, "AuthorName": {"type": "string", "description": "The display name of the user that uploaded the attachment"}, "EditorName": {"type": "string", "description": "The display name of the user that edited the document"}, "ProjectId": {"type": "integer", "description": "The id of the project that the artifact belongs to"}, "ProjectGuid": {"type": "string", "description": "The guid of the project that the artifact belongs to"}, "ArtifactTypeId": {"type": "integer", "description": "The type of artifact that we have"}, "ConcurrencyDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The datetime used to track optimistic concurrency to prevent edit conflicts"}, "CustomProperties": {"type": "array", "description": "The list of associated custom properties/fields for this artifact", "items": {"type": "object", "description": "Schema: RemoteArtifactCustomProperty"}}, "IsAttachments": {"type": "boolean", "description": "Does this artifact have any attachments?"}, "Tags": {"type": "string", "description": "The list of meta-tags that should be associated with the artifact"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"} } }, "RemoteDocumentFile": { "type": "object", "properties": { "BinaryData": {"type": "array", "description": "The file data base64 encoded if using the REST service", "items": {"type": "object", "description": "Schema: Byte"}}, "AttachmentId": {"type": "integer", "nullable": true, "description": "The id of the attachment"}, "AttachmentTypeId": {"type": "integer", "description": "The id of the attachment type"}, "DocumentTypeId": {"type": "integer", "nullable": true, "description": "The id of the document type relative to the current project template"}, "DocumentStatusId": {"type": "integer", "nullable": true, "description": "The id of the document status relative to the current project template"}, "ProjectAttachmentFolderId": {"type": "integer", "nullable": true, "description": "The id of the attachment folder id for the current project"}, "AttachedArtifacts": {"type": "array", "description": "The list of artifacts the document is attached to", "items": {"type": "object", "description": "Schema: RemoteLinkedArtifact"}}, "AuthorId": {"type": "integer", "nullable": true, "description": "The id of the user that uploaded the attachment"}, "EditorId": {"type": "integer", "nullable": true, "description": "The id of the user that edited the document"}, "AuthorGuid": {"type": "string", "description": "The guid of the author."}, "EditorGuid": {"type": "string", "description": "The guid of the editor."}, "FilenameOrUrl": {"type": "string", "description": "The filename of the file (if a file attachment) or the full URL if a URL attachment"}, "Description": {"type": "string", "description": "The description of the attachment"}, "UploadDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The date/time the attachment was uploaded"}, "EditedDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The date/time the attachment was last edited"}, "Size": {"type": "integer", "description": "The size of the attachment in bytes"}, "CurrentVersion": {"type": "string", "description": "The version name of the current attachment"}, "Versions": {"type": "array", "description": "The list of document versions", "items": {"type": "object", "description": "Schema: RemoteDocumentVersion"}}, "DocumentTypeName": {"type": "string", "description": "The display name of the attachment type relative to the current project template"}, "DocumentStatusName": {"type": "string", "description": "The display name of the document status relative to the current project template"}, "AttachmentTypeName": {"type": "string", "description": "The display name of the attachment type (i.e. whether it's a file or url)"}, "AuthorName": {"type": "string", "description": "The display name of the user that uploaded the attachment"}, "EditorName": {"type": "string", "description": "The display name of the user that edited the document"}, "ProjectId": {"type": "integer", "description": "The id of the project that the artifact belongs to"}, "ProjectGuid": {"type": "string", "description": "The guid of the project that the artifact belongs to"}, "ArtifactTypeId": {"type": "integer", "description": "The type of artifact that we have"}, "ConcurrencyDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The datetime used to track optimistic concurrency to prevent edit conflicts"}, "CustomProperties": {"type": "array", "description": "The list of associated custom properties/fields for this artifact", "items": {"type": "object", "description": "Schema: RemoteArtifactCustomProperty"}}, "IsAttachments": {"type": "boolean", "description": "Does this artifact have any attachments?"}, "Tags": {"type": "string", "description": "The list of meta-tags that should be associated with the artifact"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"} } }, "RemoteDocumentFolder": { "type": "object", "properties": { "ProjectAttachmentFolderId": {"type": "integer", "nullable": true, "description": "The id of the document folder"}, "ProjectId": {"type": "integer", "description": "The id of the project that the folder belongs to"}, "ParentProjectAttachmentFolderId": {"type": "integer", "nullable": true, "description": "The id of the parent folder of this folder"}, "Name": {"type": "string", "description": "The name of the folder."}, "IndentLevel": {"type": "string", "description": "The indentation level of the artifact"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"}, "ConcurrencyGuid": {"type": "string", "description": "GUID for representing the concurrency state of a given artifact"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last time the artifact was updated"} } }, "RemoteDocumentStatus": { "type": "object", "properties": { "DocumentStatusId": {"type": "integer", "nullable": true, "description": "The id of the incident status (integer)"}, "ProjectTemplateId": {"type": "integer", "description": "The id of the project template that the status belongs to"}, "Name": {"type": "string", "description": "The name of the incident status (string)"}, "Active": {"type": "boolean", "description": "Whether this status is active or not (boolean)"}, "Default": {"type": "boolean", "description": "Whether this status is default or not (boolean)"}, "Open": {"type": "boolean", "description": "Whether this status is considered an 'open' status or not (boolean)"}, "Position": {"type": "integer", "nullable": true, "description": "The display position of this status"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"}, "ConcurrencyGuid": {"type": "string", "description": "GUID for representing the concurrency state of a given artifact"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last time the artifact was updated"} } }, "RemoteDocumentType": { "type": "object", "properties": { "DocumentTypeId": {"type": "integer", "nullable": true, "description": "The id of the document type"}, "ProjectTemplateId": {"type": "integer", "description": "The id of the project template that the type belongs to"}, "Name": {"type": "string", "description": "The name of the document type."}, "Description": {"type": "string", "description": "The description of the document type."}, "Active": {"type": "boolean", "description": "Is this type active"}, "Default": {"type": "boolean", "description": "Is this the default type for the project"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"}, "ConcurrencyGuid": {"type": "string", "description": "GUID for representing the concurrency state of a given artifact"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last time the artifact was updated"} } }, "RemoteDocumentVersion": { "type": "object", "properties": { "AttachmentVersionId": {"type": "integer", "nullable": true, "description": "The id of the document version"}, "AttachmentVersionGuid": {"type": "string", "description": "The unique identifier for the artifact"}, "AttachmentId": {"type": "integer", "description": "The id of the document"}, "AttachmentGuid": {"type": "string", "description": "The unique identifier for the artifact"}, "AuthorId": {"type": "integer", "nullable": true, "description": "The id of the user that uploaded the version"}, "FilenameOrUrl": {"type": "string", "description": "The filename of the file (if a file attachment) or the full URL if a URL attachment"}, "Description": {"type": "string", "description": "The description of the attachment version"}, "UploadDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The date/time the attachment version was uploaded"}, "Size": {"type": "integer", "description": "The size of the attachment version in bytes"}, "VersionNumber": {"type": "string", "description": "The version number"}, "AuthorName": {"type": "string", "description": "The display name of the user that uploaded the attachment version"}, "IsActive": {"type": "boolean", "description": "Discerns whether this is the current active version of this document"} } }, "RemoteDocumentVersionFile": { "type": "object", "properties": { "BinaryData": {"type": "array", "description": "The file data base64 encoded if using the REST service", "items": {"type": "object", "description": "Schema: Byte"}}, "AttachmentVersionId": {"type": "integer", "nullable": true, "description": "The id of the document version"}, "AttachmentVersionGuid": {"type": "string", "description": "The unique identifier for the artifact"}, "AttachmentId": {"type": "integer", "description": "The id of the document"}, "AttachmentGuid": {"type": "string", "description": "The unique identifier for the artifact"}, "AuthorId": {"type": "integer", "nullable": true, "description": "The id of the user that uploaded the version"}, "FilenameOrUrl": {"type": "string", "description": "The filename of the file (if a file attachment) or the full URL if a URL attachment"}, "Description": {"type": "string", "description": "The description of the attachment version"}, "UploadDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The date/time the attachment version was uploaded"}, "Size": {"type": "integer", "description": "The size of the attachment version in bytes"}, "VersionNumber": {"type": "string", "description": "The version number"}, "AuthorName": {"type": "string", "description": "The display name of the user that uploaded the attachment version"}, "IsActive": {"type": "boolean", "description": "Discerns whether this is the current active version of this document"} } }, "RemoteEvent": { "type": "object", "properties": { "EventLogEntryType": {"type": "integer", "description": "The type of event log entry (Error = 1, Warning = 2, Information = 4, SuccessAudit = 8, FailureAudit = 16)"}, "Message": {"type": "string", "description": "The short message"}, "Details": {"type": "string", "description": "The full stack-trace and details"} } }, "RemoteEvent2": { "type": "object", "properties": { "EventTypeId": {"type": "integer", "description": "The type of event log entry (Error = 1, Warning = 2, Information = 4, SuccessAudit = 8, FailureAudit = 16)"}, "EventTypeName": {"type": "string", "description": "The name of the event type"}, "Message": {"type": "string", "description": "The short message"}, "Details": {"type": "string", "description": "The full stack-trace and details"}, "EventTimeUtc": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The event time in UTC"}, "EventCategory": {"type": "string", "description": "The event category"}, "EventCode": {"type": "integer", "description": "The event code"}, "EventId": {"type": "string", "description": "The event id"} } }, "RemoteFilter": { "type": "object", "properties": { "PropertyName": {"type": "string", "description": "The name of the field being filtered on. For standard fields it would be something like 'RequirementStatusId',\n for custom properties, it would be of the format: 'Custom_01' not the display name."}, "IntValue": {"type": "integer", "nullable": true, "description": "The filter value for fields that contain integers"}, "StringValue": {"type": "string", "description": "The filter value for fields that contain strings"}, "MultiValue": {"type": "object", "description": "The filter value for fields that contain integers (Schema: MultiValueFilter)"}, "DateRangeValue": {"type": "object", "description": "The filter value for date/time fields where you want to filter on a date range (Schema: DateRange)"} } }, "RemoteFloatingLicense": { "type": "object", "properties": { "SessionId": {"type": "string", "description": "The GUID of the unique floating license session"}, "AutomationEngineToken": {"type": "string", "description": "The token of the tool which the license is for (currently only \"Rapise\" is supported)"}, "MachineId": {"type": "string", "description": "The unique ID of the machine requesting the license"}, "AutomationHost": {"type": "string", "description": "The token of the automation host assigned to this machine"}, "DateStarted": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The date the license was first issued"}, "ExpirationDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The expiration date of the license"}, "LastContactDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The date of last contact between the tool and Spira"}, "IpAddress": {"type": "string", "description": "The IP address of the machine holding the floating license"} } }, "RemoteHistoryChange": { "type": "object", "properties": { "HistoryChangeId": {"type": "integer", "description": "The id of the change"}, "ChangeSetId": {"type": "integer", "description": "The id of the change set this belongs to"}, "CustomPropertyId": {"type": "integer", "nullable": true, "description": "The id of the custom property if this was a custom property that was changed (NULL = standard field)"}, "ArtifactFieldId": {"type": "integer", "nullable": true, "description": "The id of the artifact field if this was a standard field that was changed (NULL = custom property)"}, "FieldName": {"type": "string", "description": "The system name of either the standard field or the custom property"}, "OldValue": {"type": "string", "description": "The old value of the field serialized as a string"}, "NewValue": {"type": "string", "description": "The new value of the field serialized as a string"}, "FieldCaption": {"type": "string", "description": "The display name of either the standard field or the custom property"}, "ChangeSet": {"type": "object", "description": "The changeset information (Schema: RemoteHistoryChangeSet)"} } }, "RemoteHistoryChangeSet": { "type": "object", "properties": { "HistoryChangeSetId": {"type": "integer", "description": "The ID of the change set"}, "ProjectId": {"type": "integer", "description": "The ID of the project"}, "UserId": {"type": "integer", "description": "The ID of the user that made the change"}, "UserFullName": {"type": "string", "description": "The full name of the user that made the change"}, "ArtifactId": {"type": "integer", "description": "The ID of the artifact being changed"}, "ArtifactName": {"type": "string", "description": "The name of the artifact being changed"}, "ArtifactTypeId": {"type": "integer", "description": "The id of the type of artifact"}, "ArtifactTypeName": {"type": "string", "description": "The name of the type of artifact"}, "ChangeDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The date/time of the change"}, "ChangeTypeId": {"type": "integer", "description": "The id of the type of change"}, "ChangeTypeName": {"type": "string", "description": "The name of the type of change"}, "SignedId": {"type": "integer", "description": "Whether this change was signed by an electronic signature"}, "Changes": {"type": "array", "description": "The collection of field changes in this set", "items": {"type": "object", "description": "Schema: RemoteHistoryChange"}}, "Meaning": {"type": "string", "description": "The meaning of the changed if it's a signed changeset"} } }, "RemoteIncident": { "type": "object", "properties": { "IncidentId": {"type": "integer", "nullable": true, "description": "The id of the incident (integer)"}, "PriorityId": {"type": "integer", "nullable": true, "description": "The id of the priority of the incident (integer)"}, "SeverityId": {"type": "integer", "nullable": true, "description": "The id of the severity of the incident (integer)"}, "IncidentStatusId": {"type": "integer", "nullable": true, "description": "The id of the status of the incident (integer)"}, "IncidentTypeId": {"type": "integer", "nullable": true, "description": "The id of the type of the incident (integer)"}, "OpenerId": {"type": "integer", "nullable": true, "description": "The id of the user who detected the incident (integer)"}, "OwnerId": {"type": "integer", "nullable": true, "description": "The id of the user to the incident is assigned-to (integer)"}, "OpenerGuid": {"type": "string", "description": "The guid of the opener."}, "OwnerGuid": {"type": "string", "description": "The guid of the owner."}, "TestRunStepIds": {"type": "array", "description": "The id of the test run steps that the incident relates to (integer)", "items": {"type": "integer"}}, "DetectedReleaseId": {"type": "integer", "nullable": true, "description": "The id of the release/iteration that the incident was detected in (integer)"}, "ResolvedReleaseId": {"type": "integer", "nullable": true, "description": "The id of the release/iteration that the incident will be fixed in (integer)"}, "VerifiedReleaseId": {"type": "integer", "nullable": true, "description": "The id of the release/iteration that the incident was retested in (integer)"}, "DetectedReleaseGuid": {"type": "string", "description": "The guid of the Detected release"}, "ResolvedReleaseGuid": {"type": "string", "description": "The guid of the Resolved release"}, "VerifiedReleaseGuid": {"type": "string", "description": "The guid of the Verified release"}, "ComponentIds": {"type": "array", "description": "The list of components that this incident belongs to (array of integers)", "items": {"type": "integer"}}, "Name": {"type": "string", "description": "The name of the incident (string)"}, "Description": {"type": "string", "description": "The description of the incident (string)"}, "CreationDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "The date/time that the incident was originally created"}, "StartDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "The date that work started on the incident (date-time)"}, "EndDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "The date that work is scheduled to finish on the incident (date-time)"}, "ClosedDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "The date that the incident was closed (date-time)"}, "CompletionPercent": {"type": "integer", "description": "The completion percentage (value = 0-100) of the incident as calculated in the system from the remaining effort\n vs. the original estimated effort. (integer)"}, "EstimatedEffort": {"type": "integer", "nullable": true, "description": "The estimated effort (in minutes) to resolve the incident (integer)"}, "ActualEffort": {"type": "integer", "nullable": true, "description": "The actual effort (in minutes) it took to resolve the incident (integer)"}, "RemainingEffort": {"type": "integer", "nullable": true, "description": "The effort remaining as reported by the developer"}, "ProjectedEffort": {"type": "integer", "nullable": true, "description": "The projected actual effort of the incident when it is completed (integer)"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The date/time that the incident was last modified (date-time)"}, "PriorityName": {"type": "string", "description": "The display name of the priority of the incident (string)"}, "SeverityName": {"type": "string", "description": "The display name of the severity of the incident (string)"}, "IncidentStatusName": {"type": "string", "description": "The display name of the status of the incident (string)"}, "IncidentTypeName": {"type": "string", "description": "The display name of the type of the incident (string)"}, "OpenerName": {"type": "string", "description": "The display name of the user that detected the incident (string)"}, "OwnerName": {"type": "string", "description": "The display name of the user that the incident is assigned to (string)"}, "ProjectName": {"type": "string", "description": "The display name of the project the incident belongs to (string)"}, "DetectedReleaseVersionNumber": {"type": "string", "description": "The version number of the release/iteration that the incident was detected in (string)"}, "ResolvedReleaseVersionNumber": {"type": "string", "description": "The version number of the release/iteration that the incident will be resolved in (string)"}, "VerifiedReleaseVersionNumber": {"type": "string", "description": "The version number of the release/iteration that the incident was retested in (string)"}, "IncidentStatusOpenStatus": {"type": "boolean", "nullable": true, "description": "Is the incident in an 'open' status or not?"}, "FixedBuildId": {"type": "integer", "nullable": true, "description": "The id of the build that the incident was fixed in (integer)"}, "FixedBuildName": {"type": "string", "description": "The name of the build that the incident was fixed in (string)"}, "DetectedBuildId": {"type": "integer", "nullable": true, "description": "The id of the build that the incident was detected in (integer)"}, "DetectedBuildName": {"type": "string", "description": "The name of the build that the incident was detected in (string)"}, "ProjectId": {"type": "integer", "description": "The id of the project that the artifact belongs to"}, "ProjectGuid": {"type": "string", "description": "The guid of the project that the artifact belongs to"}, "ArtifactTypeId": {"type": "integer", "description": "The type of artifact that we have"}, "ConcurrencyDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The datetime used to track optimistic concurrency to prevent edit conflicts"}, "CustomProperties": {"type": "array", "description": "The list of associated custom properties/fields for this artifact", "items": {"type": "object", "description": "Schema: RemoteArtifactCustomProperty"}}, "IsAttachments": {"type": "boolean", "description": "Does this artifact have any attachments?"}, "Tags": {"type": "string", "description": "The list of meta-tags that should be associated with the artifact"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"} } }, "RemoteIncidentPriority": { "type": "object", "properties": { "PriorityId": {"type": "integer", "nullable": true, "description": "The id of the incident priority (integer)"}, "Name": {"type": "string", "description": "The name of the incident priority (string)"}, "Active": {"type": "boolean", "description": "Whether the priority is active or not (boolean)"}, "Color": {"type": "string", "description": "The hex color code associated with the priority (string)"}, "Score": {"type": "integer", "nullable": true, "description": "The score value"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"}, "ConcurrencyGuid": {"type": "string", "description": "GUID for representing the concurrency state of a given artifact"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last time the artifact was updated"} } }, "RemoteIncidentSeverity": { "type": "object", "properties": { "SeverityId": {"type": "integer", "nullable": true, "description": "The id of the incident severity (integer)"}, "Name": {"type": "string", "description": "The name of the severity (string)"}, "Active": {"type": "boolean", "description": "Whether the severity is active or not (boolean)"}, "Color": {"type": "string", "description": "The hex color code associated with the severity (string)"}, "Score": {"type": "integer", "nullable": true, "description": "The score value"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"}, "ConcurrencyGuid": {"type": "string", "description": "GUID for representing the concurrency state of a given artifact"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last time the artifact was updated"} } }, "RemoteIncidentStatus": { "type": "object", "properties": { "IncidentStatusId": {"type": "integer", "nullable": true, "description": "The id of the incident status (integer)"}, "Name": {"type": "string", "description": "The name of the incident status (string)"}, "Active": {"type": "boolean", "description": "Whether this status is active or not (boolean)"}, "Open": {"type": "boolean", "description": "Whether this status is considered an 'open' status or not (boolean)"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"}, "ConcurrencyGuid": {"type": "string", "description": "GUID for representing the concurrency state of a given artifact"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last time the artifact was updated"} } }, "RemoteIncidentType": { "type": "object", "properties": { "IncidentTypeId": {"type": "integer", "nullable": true, "description": "The id of the incident type (integer)"}, "Name": {"type": "string", "description": "The name of the incident type (string)"}, "Active": {"type": "boolean", "description": "Whether the incident type is active or not (boolean)"}, "Issue": {"type": "boolean", "description": "Should incidents of this type appear in the 'Top Open Issues' section (boolean)"}, "Risk": {"type": "boolean", "description": "Should incidents of this type appear in the 'Top Open Issues' section (boolean)"}, "WorkflowId": {"type": "integer", "description": "The id of the workflow incidents of this type are associated with (integer)"}, "Default": {"type": "boolean", "description": "Is this type the default type for incidents in this product"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"}, "ConcurrencyGuid": {"type": "string", "description": "GUID for representing the concurrency state of a given artifact"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last time the artifact was updated"} } }, "RemoteIntegerSetting": { "type": "object", "properties": { "Name": {"type": "string", "description": "The name of the setting"}, "Value": {"type": "integer", "nullable": true, "description": "The value of the setting"} } }, "RemoteLinkedArtifact": { "type": "object", "properties": { "ArtifactId": {"type": "integer", "description": "The ID of the artifact"}, "ArtifactTypeId": {"type": "integer", "description": "The ID of the type of the artifact"}, "Name": {"type": "string", "description": "The name of the artifact"}, "Status": {"type": "string", "description": "The artifact's status name/description"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"}, "ConcurrencyGuid": {"type": "string", "description": "GUID for representing the concurrency state of a given artifact"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last time the artifact was updated"} } }, "RemoteManualTestRun": { "type": "object", "properties": { "TestRunSteps": {"type": "array", "description": "The list of test steps that comprise the manual test", "items": {"type": "object", "description": "Schema: RemoteTestRunStep"}}, "TestRunId": {"type": "integer", "nullable": true, "description": "The id of the test run"}, "Name": {"type": "string", "description": "The name of the test run (usually the same as the test case)"}, "TestCaseId": {"type": "integer", "description": "The id of the test case that the test run is an instance of"}, "TestCaseGuid": {"type": "string", "description": "The guid of the test case that the test run is an instance of"}, "TestRunTypeId": {"type": "integer", "description": "The id of the type of test run (automated vs. manual)"}, "TesterId": {"type": "integer", "nullable": true, "description": "The id of the user that executed the test"}, "TesterGuid": {"type": "string", "description": "The guid of the tester."}, "ExecutionStatusId": {"type": "integer", "description": "The id of overall execution status for the test run"}, "ReleaseId": {"type": "integer", "nullable": true, "description": "The id of the release that the test run should be reported against"}, "ReleaseGuid": {"type": "string", "description": "The guid of the release"}, "TestSetId": {"type": "integer", "nullable": true, "description": "The id of the test set that the test run should be reported against"}, "TestSetGuid": {"type": "string", "description": "The guid of the test set"}, "TestSetTestCaseId": {"type": "integer", "nullable": true, "description": "The id of the unique test case entry in the test set"}, "StartDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The date/time that the test execution was started"}, "EndDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "The date/time that the test execution was completed"}, "BuildId": {"type": "integer", "nullable": true, "description": "The id of the build that the test was executed against"}, "EstimatedDuration": {"type": "integer", "nullable": true, "description": "The estimated duration of how long the test should take to execute (read-only)"}, "ActualDuration": {"type": "integer", "nullable": true, "description": "The actual duration of how long the test should take to execute (read-only)"}, "TestConfigurationId": {"type": "integer", "nullable": true, "description": "The id of the specific test configuration that was used"}, "ReleaseVersionNumber": {"type": "string", "description": "version number of the release this test run was run against."}, "ProjectId": {"type": "integer", "description": "The id of the project that the artifact belongs to"}, "ProjectGuid": {"type": "string", "description": "The guid of the project that the artifact belongs to"}, "ArtifactTypeId": {"type": "integer", "description": "The type of artifact that we have"}, "ConcurrencyDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The datetime used to track optimistic concurrency to prevent edit conflicts"}, "CustomProperties": {"type": "array", "description": "The list of associated custom properties/fields for this artifact", "items": {"type": "object", "description": "Schema: RemoteArtifactCustomProperty"}}, "IsAttachments": {"type": "boolean", "description": "Does this artifact have any attachments?"}, "Tags": {"type": "string", "description": "The list of meta-tags that should be associated with the artifact"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"} } }, "RemoteMessage": { "type": "object", "properties": { "MessageId": {"type": "integer", "description": "The id of the message"}, "SenderUser": {"type": "object", "description": "The sender of the message (Schema: RemoteUser)"}, "RecipientUser": {"type": "object", "description": "The recipient (null for a group message) (Schema: RemoteUser)"}, "CreationDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The date/time this message was created"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The date/time this message was last updated"}, "Body": {"type": "string", "description": "The contents of the message"}, "IsRead": {"type": "boolean", "description": "Has this message been read"}, "RecipientArtifact": {"type": "object", "description": "The artifact the message was sent to, populated for group messages (Schema: RemoteLinkedArtifact)"} } }, "RemoteMessageIndividual": { "type": "object", "properties": { "RecipientUserId": {"type": "integer", "description": "The id of the recipient user"}, "MessageText": {"type": "string", "description": "The contents of the message"} } }, "RemoteMessageInfo": { "type": "object", "properties": { "UnreadMessages": {"type": "integer", "nullable": true, "description": "The total number of unread messages"}, "OnlineUsers": {"type": "array", "description": "The ids of online users", "items": {"type": "integer"}} } }, "RemoteProductSourceCodeProvider": { "type": "object", "properties": { "ProjectId": {"type": "integer", "description": "ID of the product this source code provider configuration is for"}, "VersionControlSystemId": {"type": "integer", "description": "Unique internal ID of this version control configuration"}, "IsActive": {"type": "boolean", "description": "Whether or not this configuration is active"}, "ConnectionInfo": {"type": "string", "description": "Connection info intended for this product"}, "Login": {"type": "string", "description": "Login credential for connecting to the relevant provider"}, "Password": {"type": "string", "description": "Update only password field for setting the password credential on a newly created provider or when updating a provider"}, "Domain": {"type": "string", "description": "Used by specific integrations for setting some domain information which is separate from the connection info"}, "Custom01": {"type": "string", "description": "Custom input field for behavior or information specific to a given source code provider"}, "Custom02": {"type": "string", "description": "Custom input field for behavior or information specific to a given source code provider"}, "Custom03": {"type": "string", "description": "Custom input field for behavior or information specific to a given source code provider"}, "Custom04": {"type": "string", "description": "Custom input field for behavior or information specific to a given source code provider"}, "Custom05": {"type": "string", "description": "Custom input field for behavior or information specific to a given source code provider"} } }, "RemoteProgram": { "type": "object", "properties": { "WorkspaceTypeId": {"type": "integer"}, "ProgramId": {"type": "integer", "nullable": true, "description": "ID of the program"}, "Name": {"type": "string", "description": "Name of the program"}, "Description": {"type": "string", "description": "Description of the program"}, "Website": {"type": "string", "description": "Website associated with this program"}, "PortfolioId": {"type": "integer", "nullable": true, "description": "ID of the portfolio this program belongs to"}, "ProjectTemplateId": {"type": "integer", "nullable": true, "description": "Project template ID associated with this program"}, "isActive": {"type": "boolean", "description": "Whether or not this program is active"}, "isDefault": {"type": "boolean", "description": "Whether or not this program is the default"}, "Guid": {"type": "string", "description": "The unique identifier for the workspace"}, "LastUpdatedDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last time this item was updated"}, "ArtifactTypeId": {"type": "integer", "description": "The type of artifact that we have"}, "ConcurrencyGuid": {"type": "string", "description": "The field used to track optimistic concurrency to prevent edit conflicts"}, "CustomProperties": {"type": "array", "description": "The list of associated custom properties/fields for this workspace", "items": {"type": "object", "description": "Schema: RemoteSystemArtifactCustomProperty"}} } }, "RemoteProgramMilestone": { "type": "object", "properties": { "MilestoneId": {"type": "integer", "nullable": true, "description": "ID of the program milestone"}, "Guid": {"type": "string", "description": "Artifact guid for unique identification of an artifact"}, "CreatorId": {"type": "integer", "nullable": true, "description": "UserId of the creator of this milestone"}, "CreatorName": {"type": "string", "description": "Full name of the creator of this milestone"}, "OwnerId": {"type": "integer", "nullable": true, "description": "UserId of the owner of this milestone"}, "OwnerName": {"type": "string", "description": "Full name of the owner of this milestone"}, "StatusId": {"type": "integer", "nullable": true, "description": "ID of the program milestone status this milestone has"}, "StatusIsOpen": {"type": "boolean", "nullable": true, "description": "Whether or not this status makes this milestone \"Open\""}, "StatusName": {"type": "string", "description": "Name of the milestone status this milestone has"}, "TypeId": {"type": "integer", "nullable": true, "description": "ID of the program milestone type this milestone has"}, "TypeName": {"type": "string", "description": "Name of the program milestone type this milestone has"}, "Name": {"type": "string", "description": "Name of this milestone"}, "Description": {"type": "string", "description": "Description of the milestone"}, "ProjectGroupId": {"type": "integer", "description": "ID of the project group which this milestone belongs to"}, "ProjectGroupName": {"type": "string", "description": "Name of the project group this milestone belongs to"}, "StartDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Start date of this milestone"}, "ChildrenStartDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Earliest start date of this milestone's children releases"}, "EndDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "End date of this milestone"}, "ChildrenEndDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Earliest end date of this milestone's children releases"}, "CreationDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true}, "PercentComplete": {"type": "integer", "description": "Percent of the associated capabilities which are completed"}, "ReleaseCount": {"type": "integer", "description": "Number of releases associated with this milestone"}, "RequirementCount": {"type": "integer", "description": "Number of requirements which are within the child releases"}, "ArtifactTypeId": {"type": "integer", "description": "The type of artifact that we have"}, "ConcurrencyGuid": {"type": "string", "description": "The field used to track optimistic concurrency to prevent edit conflicts"}, "CustomProperties": {"type": "array", "description": "The list of associated custom properties/fields for this workspace", "items": {"type": "object", "description": "Schema: RemoteSystemArtifactCustomProperty"}} } }, "RemoteProgramMilestoneStatus": { "type": "object", "properties": { "StatusId": {"type": "integer", "description": "ID of this program milestone Status"}, "Name": {"type": "string", "description": "Name of this status"}, "IsOpen": {"type": "boolean", "description": "Whether or not this is an \"Open\" status"}, "IsActive": {"type": "boolean", "description": "Whether or not this status is active (Able to be used in User Interface)"}, "IsDefault": {"type": "boolean", "description": "Whether or not this is the default program milestone status"} } }, "RemoteProgramMilestoneType": { "type": "object", "properties": { "TypeId": {"type": "integer", "description": "ID of this program milestone type"}, "Name": {"type": "string", "description": "Name of this type"}, "IsActive": {"type": "boolean", "description": "Whether or not this type is active (Able to be used in User Interface)"}, "IsDefault": {"type": "boolean", "description": "Whether or not this is the default program milestone type"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"}, "ConcurrencyGuid": {"type": "string", "description": "GUID for representing the concurrency state of a given artifact"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last time the artifact was updated"} } }, "RemoteProject": { "type": "object", "properties": { "ProjectId": {"type": "integer", "nullable": true, "description": "The id of the project (integer)"}, "ProjectTemplateId": {"type": "integer", "nullable": true, "description": "The id of the project template (null on create, means create a new template)"}, "ProjectGroupId": {"type": "integer", "nullable": true, "description": "The id of the project group / program (null on create, means use default group)"}, "Name": {"type": "string", "description": "The name of the project (string)"}, "Description": {"type": "string", "description": "The description of the project (string)"}, "Website": {"type": "string", "description": "The url associated with the project (string)"}, "CreationDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The date/time the project was created (datetime)"}, "Active": {"type": "boolean", "description": "Whether the project is active or not (boolean)"}, "WorkingHours": {"type": "integer", "description": "How many working hours are in a day for this project (integer)"}, "WorkingDays": {"type": "integer", "description": "How many working days are in a week for this project (integer)"}, "NonWorkingHours": {"type": "integer", "description": "How many special non-working hours are there in a month in the project (integer)"}, "StartDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "The start date of the project for planning purposes"}, "EndDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "The end date of the project for planning purposes"}, "PercentComplete": {"type": "integer", "description": "The percentage complete of the project"}, "RequirementCount": {"type": "integer", "description": "The requirement count of the project"}, "WorkspaceTypeId": {"type": "integer", "description": "The type of workspace that we have"}, "Guid": {"type": "string", "description": "The unique identifier for the workspace"}, "LastUpdatedDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last time this item was updated"}, "ArtifactTypeId": {"type": "integer", "description": "The type of artifact that we have"}, "ConcurrencyGuid": {"type": "string", "description": "The field used to track optimistic concurrency to prevent edit conflicts"}, "CustomProperties": {"type": "array", "description": "The list of associated custom properties/fields for this workspace", "items": {"type": "object", "description": "Schema: RemoteSystemArtifactCustomProperty"}} } }, "RemoteProjectArtifact": { "type": "object", "properties": { "ProjectId": {"type": "integer", "description": "The id of the project"}, "ArtifactIds": {"type": "array", "description": "The list of artifacts in this project", "items": {"type": "integer"}} } }, "RemoteProjectRole": { "type": "object", "properties": { "ProjectRoleId": {"type": "integer", "nullable": true, "description": "The id of the project role"}, "Name": {"type": "string", "description": "The name of the project role"}, "Description": {"type": "string", "description": "The description of the project role"}, "Active": {"type": "boolean", "description": "Whether the role is active or not"}, "Admin": {"type": "boolean", "description": "Whether the role is a project owner or not"}, "DiscussionsAdd": {"type": "boolean", "description": "Can this role add discussions/comments to the project"}, "SourceCodeView": {"type": "boolean", "description": "Can this role view the source code repository of the project"}, "Permissions": {"type": "array", "description": "The collection of role permissions", "items": {"type": "object", "description": "Schema: RemoteRolePermission"}}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"}, "ConcurrencyGuid": {"type": "string", "description": "GUID for representing the concurrency state of a given artifact"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last time the artifact was updated"} } }, "RemoteProjectTemplate": { "type": "object", "properties": { "ProjectTemplateId": {"type": "integer", "nullable": true, "description": "The id of the project template"}, "Name": {"type": "string", "description": "The name of the project template"}, "Description": {"type": "string", "description": "The description of the project template"}, "IsActive": {"type": "boolean", "description": "Is this template active or not"}, "WorkspaceTypeId": {"type": "integer", "description": "The type of workspace that we have"}, "Guid": {"type": "string", "description": "The unique identifier for the workspace"}, "LastUpdatedDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last time this item was updated"}, "ArtifactTypeId": {"type": "integer", "description": "The type of artifact that we have"}, "ConcurrencyGuid": {"type": "string", "description": "The field used to track optimistic concurrency to prevent edit conflicts"}, "CustomProperties": {"type": "array", "description": "The list of associated custom properties/fields for this workspace", "items": {"type": "object", "description": "Schema: RemoteSystemArtifactCustomProperty"}} } }, "RemoteProjectUser": { "type": "object", "properties": { "ProjectId": {"type": "integer", "description": "The ID of the project"}, "ProjectGuid": {"type": "string", "description": "The unique identifier for the project"}, "ProjectRoleId": {"type": "integer", "description": "The ID of the role the user has on the project"}, "ProjectRoleGuid": {"type": "string", "description": "The guid of the role the user has on the project"}, "ProjectRoleName": {"type": "string", "description": "The name of the role the user has on the project"}, "UserId": {"type": "integer", "nullable": true, "description": "The id of the user"}, "UserGuid": {"type": "string", "description": "The guid of the user"}, "FirstName": {"type": "string", "description": "The first (given) name of the user"}, "LastName": {"type": "string", "description": "The last name (surname) of the user"}, "MiddleInitial": {"type": "string", "description": "The middle initials of the user"}, "UserName": {"type": "string", "description": "The login used by the user"}, "LdapDn": {"type": "string", "description": "The LDAP Distinguished Name for the user (null for non-LDAP users)"}, "EmailAddress": {"type": "string", "description": "The email address of the user"}, "Admin": {"type": "boolean", "description": "Whether the user is a system administrator"}, "Active": {"type": "boolean", "description": "Whether the user is active in the system"}, "Department": {"type": "string", "description": "The department of the user"}, "Approved": {"type": "boolean", "description": "Is this user approved by the system administrator"}, "Locked": {"type": "boolean", "description": "Is this user locked-out of their account"}, "RssToken": {"type": "string", "description": "This is the RSS token for this user"}, "FullName": {"type": "string", "description": "The full name of the user concatenated (First + Middle + Last)"}, "LastUpdatedDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true}, "LastLockoutDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last date this users account was locked out"}, "LastActivityDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last date this users account did something"}, "LastLoginDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last date this users account was logged in to"}, "LastPasswordChange": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last date this users account password was changed"}, "OrganizationName": {"type": "string", "description": "Organization name of the user"}, "OrganizationId": {"type": "integer", "nullable": true, "description": "ID of the organization this user belongs to"}, "EmailsEnabled": {"type": "boolean", "description": "Whether or not a user has opted to recieve emails or not"}, "ReportAdmin": {"type": "boolean", "description": "Whether the user is a report admin"}, "PortfolioViewer": {"type": "boolean", "description": "Whether this user has permissions to view all portfolios"}, "TimesheetManager": {"type": "boolean", "description": "Whether this user is a timesheet manager"}, "OAuthProvider": {"type": "string", "description": "Name of the external OAuth provider being used to access this account"}, "MutliFactorAuthentication": {"type": "boolean", "description": "Whether this user is using Spira's integrated MFA implementation."}, "CustomProperties": {"type": "array", "description": "The list of associated custom properties/fields for this user", "items": {"type": "object", "description": "Schema: RemoteSystemArtifactCustomProperty"}}, "ArtifactTypeId": {"type": "integer", "description": "The type of artifact that we have"}, "ConcurrencyGuid": {"type": "string", "description": "The field used to track optimistic concurrency to prevent edit conflicts"} } }, "RemotePullRequest": { "type": "object", "properties": { "SourceBranchId": {"type": "integer", "nullable": true, "description": "ID of the branch being merged from"}, "SourceBranchName": {"type": "string", "description": "Name of the branch being merged from"}, "DestBranchId": {"type": "integer", "nullable": true, "description": "Id of the branch being merged to"}, "DestBranchName": {"type": "string", "description": "Name of the branch being merged to"}, "TaskId": {"type": "integer", "nullable": true, "description": "The id of the task"}, "TaskStatusId": {"type": "integer", "description": "The id of the status of the task"}, "TaskTypeId": {"type": "integer", "nullable": true, "description": "The id of the type of the task (null for default)"}, "TaskFolderId": {"type": "integer", "nullable": true, "description": "The of the folder the task is stored in (null for root)"}, "RequirementId": {"type": "integer", "nullable": true, "description": "The id of the parent requirement that the task belongs to"}, "ReleaseId": {"type": "integer", "nullable": true, "description": "The id of the release/iteration that the task is scheduled for"}, "ReleaseGuid": {"type": "string", "description": "The guid of the release"}, "ComponentId": {"type": "integer", "nullable": true, "description": "The id of the component that this task belongs to"}, "CreatorId": {"type": "integer", "nullable": true, "description": "The id of the user that originally created the task"}, "OwnerId": {"type": "integer", "nullable": true, "description": "The id of the user that the task is assigned-to"}, "CreatorGuid": {"type": "string", "description": "The guid of the creator."}, "OwnerGuid": {"type": "string", "description": "The guid of the owner."}, "TaskPriorityId": {"type": "integer", "nullable": true, "description": "The id of the priority of the task"}, "Name": {"type": "string", "description": "The name of the task"}, "Description": {"type": "string", "description": "The detailed description of the task"}, "CreationDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The date/time that the task was originally created"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The date/time that the task was last modified"}, "StartDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "The scheduled start date for the task"}, "EndDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "The scheduled end date for the task"}, "CompletionPercent": {"type": "integer", "description": "The completion percentage (value = 0-100) of the task as calculated in the system from the remaining effort\n vs. the original estimated effort."}, "EstimatedEffort": {"type": "integer", "nullable": true, "description": "The originally estimated effort (in minutes) of the task"}, "ActualEffort": {"type": "integer", "nullable": true, "description": "The actual effort expended so far (in minutes) for the task"}, "RemainingEffort": {"type": "integer", "nullable": true, "description": "The effort remaining as reported by the developer"}, "ProjectedEffort": {"type": "integer", "nullable": true, "description": "The projected actual effort of the task when it is completed"}, "TaskStatusName": {"type": "string", "description": "The display name of the status of the task"}, "TaskTypeName": {"type": "string", "description": "The display name of the type of the task"}, "OwnerName": {"type": "string", "description": "The display name of the user who the task is assigned-to"}, "TaskPriorityName": {"type": "string", "description": "The display name of the priority of the task"}, "ProjectName": {"type": "string", "description": "The display name of the project the task belongs to"}, "ReleaseVersionNumber": {"type": "string", "description": "The version number of the release/iteration the task is scheduled for"}, "RequirementName": {"type": "string", "description": "The name of the requirement that the task is associated with"}, "RiskId": {"type": "integer", "nullable": true, "description": "The risk that the task is associated with"}, "ProjectId": {"type": "integer", "description": "The id of the project that the artifact belongs to"}, "ProjectGuid": {"type": "string", "description": "The guid of the project that the artifact belongs to"}, "ArtifactTypeId": {"type": "integer", "description": "The type of artifact that we have"}, "ConcurrencyDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The datetime used to track optimistic concurrency to prevent edit conflicts"}, "CustomProperties": {"type": "array", "description": "The list of associated custom properties/fields for this artifact", "items": {"type": "object", "description": "Schema: RemoteArtifactCustomProperty"}}, "IsAttachments": {"type": "boolean", "description": "Does this artifact have any attachments?"}, "Tags": {"type": "string", "description": "The list of meta-tags that should be associated with the artifact"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"} } }, "RemoteRelease": { "type": "object", "properties": { "ReleaseId": {"type": "integer", "nullable": true, "description": "The id of the release"}, "CreatorId": {"type": "integer", "nullable": true, "description": "The id of the user that created the release"}, "OwnerId": {"type": "integer", "nullable": true, "description": "The id of the user that the release is assigned to"}, "CreatorGuid": {"type": "string", "description": "The guid of the creator."}, "OwnerGuid": {"type": "string", "description": "The guid of the owner."}, "OwnerName": {"type": "string", "description": "The name of the user that the release is assigned to"}, "IndentLevel": {"type": "string", "description": "The indentation level of the artifact"}, "Name": {"type": "string", "description": "The name of the release"}, "Description": {"type": "string", "description": "The description of the release"}, "VersionNumber": {"type": "string", "description": "The version number string of the release"}, "CreationDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The date the release was originally created"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The date the release was last modified"}, "Summary": {"type": "boolean", "description": "Is this release a summary one (i.e. does it have child releases)"}, "Active": {"type": "boolean", "description": "Is this release active for the project"}, "ReleaseStatusId": {"type": "integer", "description": "The status of the release"}, "ReleaseTypeId": {"type": "integer", "description": "The type of the release"}, "StartDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "What is the start date for the release"}, "EndDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "What is the end date for the release"}, "ResourceCount": {"type": "number", "description": "How many people are working on the release"}, "DaysNonWorking": {"type": "number", "description": "How many non-working days are associated with the release"}, "PlannedEffort": {"type": "integer", "nullable": true, "description": "What is the estimated planned effort associated with the release"}, "AvailableEffort": {"type": "integer", "nullable": true, "description": "How much effort is still available in the release for planning"}, "TaskEstimatedEffort": {"type": "integer", "nullable": true, "description": "How much effort was estimated for all the tasks scheduled for this release"}, "TaskActualEffort": {"type": "integer", "nullable": true, "description": "How much effort was actually expended for all the tasks scheduled for this release"}, "TaskCount": {"type": "integer", "nullable": true, "description": "How many tasks are scheduled for this release"}, "CreatorName": {"type": "string", "description": "What is the full display name of the person who created this release"}, "FullName": {"type": "string", "description": "The full name and version number of the release combined"}, "ReleaseStatusName": {"type": "string", "description": "The display name for the release status"}, "ReleaseTypeName": {"type": "string", "description": "The display name for the release type"}, "CountBlocked": {"type": "integer", "description": "The count of blocked test cases in this release"}, "CountCaution": {"type": "integer", "description": "The count of caution test cases in this release"}, "CountFailed": {"type": "integer", "description": "The count of failed test cases in this release"}, "CountNotApplicable": {"type": "integer", "description": "The count of N/A test cases in this release"}, "CountNotRun": {"type": "integer", "description": "The count of not run test cases in this release"}, "CountPassed": {"type": "integer", "description": "The count of passed test cases in this release"}, "PercentComplete": {"type": "integer", "description": "The percentage complete of the project/sprint"}, "RequirementCount": {"type": "integer", "description": "Number of requirements assigned to this release"}, "RequirementPoints": {"type": "number", "nullable": true, "description": "Number of effort points assigned to the requirements of this release"}, "ProjectId": {"type": "integer", "description": "The id of the project that the artifact belongs to"}, "ProjectGuid": {"type": "string", "description": "The guid of the project that the artifact belongs to"}, "ArtifactTypeId": {"type": "integer", "description": "The type of artifact that we have"}, "ConcurrencyDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The datetime used to track optimistic concurrency to prevent edit conflicts"}, "CustomProperties": {"type": "array", "description": "The list of associated custom properties/fields for this artifact", "items": {"type": "object", "description": "Schema: RemoteArtifactCustomProperty"}}, "IsAttachments": {"type": "boolean", "description": "Does this artifact have any attachments?"}, "Tags": {"type": "string", "description": "The list of meta-tags that should be associated with the artifact"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"} } }, "RemoteReleaseStatus": { "type": "object", "properties": { "ReleaseStatusId": {"type": "integer", "description": "The id of the release status"}, "Name": {"type": "string", "description": "The name of the release status"}, "Active": {"type": "boolean", "description": "Is this an active release status"}, "Position": {"type": "integer", "description": "The display position of this status"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"}, "ConcurrencyGuid": {"type": "string", "description": "GUID for representing the concurrency state of a given artifact"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last time the artifact was updated"} } }, "RemoteReleaseTestCaseMapping": { "type": "object", "properties": { "ReleaseId": {"type": "integer", "description": "The id of the release"}, "TestCaseId": {"type": "integer", "description": "The id of the test case"} } }, "RemoteReleaseType": { "type": "object", "properties": { "ReleaseTypeId": {"type": "integer", "description": "The id of the release type"}, "Name": {"type": "string", "description": "The name of the release type"}, "WorkflowId": {"type": "integer", "nullable": true, "description": "The id of the workflow the release type is associated with, for the current project"}, "Active": {"type": "boolean", "description": "Is this an active release type"}, "Position": {"type": "integer", "description": "The display position of this type"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"}, "ConcurrencyGuid": {"type": "string", "description": "GUID for representing the concurrency state of a given artifact"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last time the artifact was updated"} } }, "RemoteRequirement": { "type": "object", "properties": { "RequirementId": {"type": "integer", "nullable": true, "description": "The id of the requirement (integer)"}, "IndentLevel": {"type": "string", "description": "The indentation level of the artifact (string)"}, "StatusId": {"type": "integer", "nullable": true, "description": "The id of the requirement's status (integer)."}, "RequirementTypeId": {"type": "integer", "nullable": true, "description": "The type of requirement (integer)."}, "AuthorId": {"type": "integer", "nullable": true, "description": "The id of the user that wrote the requirement (integer)"}, "OwnerId": {"type": "integer", "nullable": true, "description": "The id of the user that the requirement is assigned-to (integer)"}, "AuthorGuid": {"type": "string", "description": "The guid of the author."}, "OwnerGuid": {"type": "string", "description": "The guid of the owner."}, "ImportanceId": {"type": "integer", "nullable": true, "description": "The id of the importance of the requirement (integer)"}, "ReleaseId": {"type": "integer", "nullable": true, "description": "The id of the release the requirement is scheduled to implemented in (integer)"}, "ReleaseGuid": {"type": "string", "description": "The guid of the release"}, "ComponentId": {"type": "integer", "nullable": true, "description": "The id of the component the requirement is a part of (integer - these are created on a per project user by an administrator)"}, "Name": {"type": "string", "description": "The name of the requirement (string - required for POST)"}, "Description": {"type": "string", "description": "The description of the requirement (string)"}, "CreationDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The date/time the requirement was originally created (date-time)"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The date/time the requirement was last modified (date-time)"}, "Summary": {"type": "boolean", "description": "Is this a summary requirement or not (boolean)"}, "CoverageCountTotal": {"type": "integer", "nullable": true, "description": "How many test cases cover this requirement (integer)"}, "CoverageCountPassed": {"type": "integer", "nullable": true, "description": "How many of the test cases that cover this requirement have passed (integer)"}, "CoverageCountFailed": {"type": "integer", "nullable": true, "description": "How many of the test cases that cover this requirement have failed (integer)"}, "CoverageCountCaution": {"type": "integer", "nullable": true, "description": "How many of the test cases that cover this requirement have been marked as caution (integer)"}, "CoverageCountBlocked": {"type": "integer", "nullable": true, "description": "How many of the test cases that cover this requirement have blocked (integer)"}, "EstimatePoints": {"type": "number", "nullable": true, "description": "The estimate of the requirement (decimal - in story points)"}, "EstimatedEffort": {"type": "integer", "nullable": true, "description": "What was the original top-down level of effort estimated for this requirement, calculated from the points estimate (integer)"}, "TaskEstimatedEffort": {"type": "integer", "nullable": true, "description": "What is the bottom-up estimated effort for all the tasks associated with this requirement (integer)"}, "TaskActualEffort": {"type": "integer", "nullable": true, "description": "What is the bottom-up actual effort for all the tasks associated with this requirement (integer)"}, "TaskCount": {"type": "integer", "nullable": true, "description": "How many tasks are associated with this requirement (integer)"}, "ReleaseVersionNumber": {"type": "string", "description": "The version number string of the release that the requirement is scheduled for (string)"}, "AuthorName": {"type": "string", "description": "The display name of the user that wrote this requirement (string)"}, "OwnerName": {"type": "string", "description": "The display name of the user that this requirement is assigned-to (string)"}, "StatusName": {"type": "string", "description": "The display name of the status the requirement is in (string)"}, "ImportanceName": {"type": "string", "description": "The display name of the importance that the requirement is in (string)"}, "ProjectName": {"type": "string", "description": "The display name of the project that the requirement is associated with (string)"}, "RequirementTypeName": {"type": "string", "description": "The display name of the type of requirement (string)"}, "Steps": {"type": "array", "description": "The list of scenarios steps (array - only available for Use Case requirement types)", "items": {"type": "object", "description": "Schema: RemoteRequirementStep"}}, "StartDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "The start date of the requirement for planning purposes"}, "EndDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "The end date of the requirement for planning purposes"}, "PercentComplete": {"type": "integer", "nullable": true, "description": "The percentage complete of the requirement"}, "GoalId": {"type": "integer", "nullable": true, "description": "The id of the goal that the requirement belongs to"}, "IsSuspect": {"type": "boolean", "description": "Is the requirement marked as suspect due to dependent item changes"}, "ProjectId": {"type": "integer", "description": "The id of the project that the artifact belongs to"}, "ProjectGuid": {"type": "string", "description": "The guid of the project that the artifact belongs to"}, "ArtifactTypeId": {"type": "integer", "description": "The type of artifact that we have"}, "ConcurrencyDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The datetime used to track optimistic concurrency to prevent edit conflicts"}, "CustomProperties": {"type": "array", "description": "The list of associated custom properties/fields for this artifact", "items": {"type": "object", "description": "Schema: RemoteArtifactCustomProperty"}}, "IsAttachments": {"type": "boolean", "description": "Does this artifact have any attachments?"}, "Tags": {"type": "string", "description": "The list of meta-tags that should be associated with the artifact"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"} } }, "RemoteRequirementImportance": { "type": "object", "properties": { "ImportanceId": {"type": "integer", "nullable": true, "description": "The id of the requirement importance (integer)"}, "Name": {"type": "string", "description": "The name of the requirement importance (string)"}, "Active": {"type": "boolean", "description": "Whether the priority is active or not (boolean)"}, "Color": {"type": "string", "description": "The hex color code associated with the priority (string)"}, "Score": {"type": "integer", "nullable": true, "description": "The score value"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"}, "ConcurrencyGuid": {"type": "string", "description": "GUID for representing the concurrency state of a given artifact"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last time the artifact was updated"} } }, "RemoteRequirementStatus": { "type": "object", "properties": { "RequirementStatusId": {"type": "integer", "description": "The id of the requirement status"}, "Name": {"type": "string", "description": "The name of the status"}, "Active": {"type": "boolean", "description": "Is this an active status"}, "Position": {"type": "integer", "description": "The display position of this status"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"}, "ConcurrencyGuid": {"type": "string", "description": "GUID for representing the concurrency state of a given artifact"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last time the artifact was updated"} } }, "RemoteRequirementStep": { "type": "object", "properties": { "RequirementStepId": {"type": "integer", "nullable": true, "description": "The id of the step"}, "Guid": {"type": "string", "description": "The unique identifier for the step"}, "RequirementId": {"type": "integer", "description": "The id of the requirement the step belongs to"}, "RequirementGuid": {"type": "string", "description": "The guid of the requirement the step belongs to"}, "Position": {"type": "integer", "description": "The position of the step in the requirement"}, "Description": {"type": "string", "description": "The description of this step"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The date the step was last updated"}, "ConcurrencyDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The date the step was edited"}, "CreationDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The date the step was created"} } }, "RemoteRequirementTestCaseMapping": { "type": "object", "properties": { "RequirementId": {"type": "integer", "description": "The id of the requirement"}, "TestCaseId": {"type": "integer", "description": "The id of the test case"}, "RequirementGuid": {"type": "string", "description": "The guid of the requirement"}, "TestCaseGuid": {"type": "string", "description": "The guid of the test case"} } }, "RemoteRequirementTestStepMapping": { "type": "object", "properties": { "RequirementId": {"type": "integer", "description": "The id of the requirement"}, "TestStepId": {"type": "integer", "description": "The id of the test step"}, "RequirementGuid": {"type": "string", "description": "The guid of the requirement"}, "TestStepGuid": {"type": "string", "description": "The guid of the test step"} } }, "RemoteRequirementType": { "type": "object", "properties": { "RequirementTypeId": {"type": "integer", "description": "The id of the requirement type"}, "Name": {"type": "string", "description": "The name of the type"}, "WorkflowId": {"type": "integer", "nullable": true, "description": "The id of the workflow the type is associated with, for the current project"}, "IsActive": {"type": "boolean", "description": "Is this an active type"}, "IsDefault": {"type": "boolean", "description": "Is this the default type"}, "IsSteps": {"type": "boolean", "description": "Does this type have steps"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"}, "ConcurrencyGuid": {"type": "string", "description": "GUID for representing the concurrency state of a given artifact"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last time the artifact was updated"} } }, "RemoteRisk": { "type": "object", "properties": { "RiskId": {"type": "integer", "nullable": true, "description": "The id of the risk"}, "ClosedDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "The date the risk was closed (optional) (in UTC)"}, "ComponentId": {"type": "integer", "nullable": true, "description": "The id of the component the risk is associated with (optional)"}, "ComponentName": {"type": "string", "description": "The name of the component (read-only)"}, "CreationDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "The date the risk was created (in UTC)"}, "CreatorId": {"type": "integer", "nullable": true, "description": "The id of the user that created the risk"}, "CreatorGuid": {"type": "string", "description": "The guid of the creator."}, "CreatorName": {"type": "string", "description": "The name of the user that created the risk (read-only)"}, "Description": {"type": "string", "description": "The description of the risk"}, "IsDeleted": {"type": "boolean", "description": "Is the risk deleted"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The date/time the risk was last updated (in UTC)"}, "Name": {"type": "string", "description": "The name of the risk"}, "OwnerId": {"type": "integer", "nullable": true, "description": "The id of the user that the risk is assigned to currently (optional)"}, "OwnerGuid": {"type": "string", "description": "The guid of the owner."}, "OwnerName": {"type": "string", "description": "The name of the user that the risk is assigned to currently (read-only)"}, "ReleaseId": {"type": "integer", "nullable": true, "description": "The id of the release that the risk is currently assigned to (optional)"}, "ReleaseName": {"type": "string", "description": "The name of the release that the risk is currently assigned to (read-only)"}, "ReleaseVersionNumber": {"type": "string", "description": "The version number of the release that the risk is currently assigned to (read-only)"}, "ReleaseGuid": {"type": "string", "description": "The guid of the release"}, "ReviewDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "The date/time the risk needs to be reviewed (in UTC)"}, "RiskImpactId": {"type": "integer", "nullable": true, "description": "The id of the risk impact (optional)"}, "RiskImpactName": {"type": "string", "description": "The name of the risk impact (read-only)"}, "RiskProbabilityId": {"type": "integer", "nullable": true, "description": "The id of the risk probability (optional)"}, "RiskProbabilityName": {"type": "string", "description": "The name of the risk probability (read-only)"}, "RiskStatusId": {"type": "integer", "nullable": true, "description": "The id of the risk status (default if not populated)"}, "RiskStatusName": {"type": "string", "description": "The name of the risk status (read-only)"}, "RiskTypeId": {"type": "integer", "nullable": true, "description": "The id of the risk type (default if not populated)"}, "RiskTypeName": {"type": "string", "description": "The name of the risk type (read-only)"}, "RiskExposure": {"type": "integer", "nullable": true, "description": "The calculated risk exposure score (read-only)"}, "ProjectGroupId": {"type": "integer", "nullable": true, "description": "The id of the project group (not used)"}, "RiskDetectabilityId": {"type": "integer", "nullable": true, "description": "The id of the risk detectability (not used)"}, "RiskDetectabilityName": {"type": "string", "description": "The name of the risk detectability (not used)"}, "GoalId": {"type": "integer", "nullable": true, "description": "The id of the project goal (not used)"}, "ProjectId": {"type": "integer", "description": "The id of the project that the artifact belongs to"}, "ProjectGuid": {"type": "string", "description": "The guid of the project that the artifact belongs to"}, "ArtifactTypeId": {"type": "integer", "description": "The type of artifact that we have"}, "ConcurrencyDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The datetime used to track optimistic concurrency to prevent edit conflicts"}, "CustomProperties": {"type": "array", "description": "The list of associated custom properties/fields for this artifact", "items": {"type": "object", "description": "Schema: RemoteArtifactCustomProperty"}}, "IsAttachments": {"type": "boolean", "description": "Does this artifact have any attachments?"}, "Tags": {"type": "string", "description": "The list of meta-tags that should be associated with the artifact"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"} } }, "RemoteRiskImpact": { "type": "object", "properties": { "RiskImpactId": {"type": "integer", "nullable": true, "description": "The id of the risk impact (integer)"}, "Name": {"type": "string", "description": "The name of the risk impact (string)"}, "Active": {"type": "boolean", "description": "Whether the impact is active or not (boolean)"}, "Position": {"type": "integer", "description": "The display position of this impact"}, "Color": {"type": "string", "description": "The hex color code associated with the impact (string)"}, "Score": {"type": "integer", "description": "The score value"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"}, "ConcurrencyGuid": {"type": "string", "description": "GUID for representing the concurrency state of a given artifact"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last time the artifact was updated"} } }, "RemoteRiskMitigation": { "type": "object", "properties": { "RiskMitigationId": {"type": "integer", "nullable": true, "description": "The id of the mitigation"}, "RiskId": {"type": "integer", "description": "The id of the risk the mitigation belongs to"}, "RiskMitigationGuid": {"type": "string", "description": "The guid of the mitigation"}, "RiskGuid": {"type": "string", "description": "The guid of the risk"}, "Position": {"type": "integer", "description": "The position of the step in the requirement"}, "Description": {"type": "string", "description": "The description of this step"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The date the step was last updated"}, "ConcurrencyDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The date the step was edited"}, "CreationDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The date the step was created"}, "IsDeleted": {"type": "boolean", "description": "Is this mitigation deleted?"}, "IsActive": {"type": "boolean", "description": "Is this mitigation active?"}, "ReviewDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "The scheduled review date (optional)"} } }, "RemoteRiskProbability": { "type": "object", "properties": { "RiskProbabilityId": {"type": "integer", "nullable": true, "description": "The id of the risk probability (integer)"}, "Name": {"type": "string", "description": "The name of the risk probability (string)"}, "Active": {"type": "boolean", "description": "Whether the probability is active or not (boolean)"}, "Position": {"type": "integer", "description": "The display position of this probability"}, "Color": {"type": "string", "description": "The hex color code associated with the probability (string)"}, "Score": {"type": "integer", "description": "The score value"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"}, "ConcurrencyGuid": {"type": "string", "description": "GUID for representing the concurrency state of a given artifact"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last time the artifact was updated"} } }, "RemoteRiskStatus": { "type": "object", "properties": { "RiskStatusId": {"type": "integer", "description": "The id of the risk status"}, "Name": {"type": "string", "description": "The name of the risk status"}, "Active": {"type": "boolean", "description": "Is this an active risk status"}, "Position": {"type": "integer", "description": "The display position of this status"}, "Open": {"type": "boolean", "description": "Is this status an \"Open\" status"}, "Default": {"type": "boolean", "description": "Is this status the default status for risks in this project template"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"}, "ConcurrencyGuid": {"type": "string", "description": "GUID for representing the concurrency state of a given artifact"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last time the artifact was updated"} } }, "RemoteRiskType": { "type": "object", "properties": { "RiskTypeId": {"type": "integer", "description": "The id of the risk type"}, "Name": {"type": "string", "description": "The name of the risk type"}, "WorkflowId": {"type": "integer", "nullable": true, "description": "The id of the workflow the risk type is associated with, for the current project"}, "IsActive": {"type": "boolean", "description": "Is this an active risk type"}, "Position": {"type": "integer", "description": "The display position of this type"}, "IsDefault": {"type": "boolean", "description": "Is this the default risk type"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"}, "ConcurrencyGuid": {"type": "string", "description": "GUID for representing the concurrency state of a given artifact"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last time the artifact was updated"} } }, "RemoteSavedFilter": { "type": "object", "properties": { "SavedFilterId": {"type": "integer", "description": "The id of the saved filter"}, "ProjectId": {"type": "integer", "description": "The id of the project"}, "ArtifactTypeId": {"type": "integer", "description": "The id of the type of artifact this is for"}, "Name": {"type": "string", "description": "The name given to the collection of filters"}, "IsShared": {"type": "boolean", "description": "Is this a shared filter"}, "Sort": {"type": "object", "description": "The sort associated with the filter (not currently used) (Schema: RemoteSort)"}, "Filters": {"type": "array", "description": "The individual filters that make up this saved filter", "items": {"type": "object", "description": "Schema: RemoteFilter"}}, "ArtifactTypeName": {"type": "string", "description": "The display name of the artifact type"}, "ProjectName": {"type": "string", "description": "The display name of the project"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"}, "ConcurrencyGuid": {"type": "string", "description": "GUID for representing the concurrency state of a given artifact"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last time the artifact was updated"} } }, "RemoteSavedReport": { "type": "object", "properties": { "SavedReportId": {"type": "integer", "description": "The id of the saved report"}, "ProjectId": {"type": "integer", "nullable": true, "description": "The id of the project"}, "Name": {"type": "string", "description": "The name of the saved report"}, "IsShared": {"type": "boolean", "description": "Is this a shared saved report"}, "ReportFormatId": {"type": "integer", "description": "The id of the format of the report"}, "CreatorId": {"type": "integer", "nullable": true, "description": "UserId of the creator of the retrieved report"}, "CreatorName": {"type": "string", "description": "Name of the user who created the retrieved report"}, "CreationDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true} } }, "RemoteSetting": { "type": "object", "properties": { "Name": {"type": "string", "description": "The name of the setting"}, "Value": {"type": "string", "description": "The value of the setting"} } }, "RemoteSourceCodeBranch": { "type": "object", "properties": { "Id": {"type": "string", "description": "The ID of the branch"}, "Name": {"type": "string", "description": "The display name of the branch"}, "IsDefault": {"type": "boolean", "description": "Is this the default branch"} } }, "RemoteSourceCodeConnection": { "type": "object", "properties": { "ProviderName": {"type": "string", "description": "The provider name (GitProvider SubversionProvider)"}, "Connection": {"type": "string", "description": "The connection string (typically a url) for this source code repository"}, "Login": {"type": "string", "description": "The login to the source code provider (legacy)"}, "Password": {"type": "string", "description": "The password / API key to the source code provider (legacy)"} } }, "RemoteSourceCodeFile": { "type": "object", "properties": { "Id": {"type": "string", "description": "The file's unique key."}, "Name": {"type": "string", "description": "The full filename"}, "ParentFolder": {"type": "object", "description": "The parent folder, if it has one. (Schema: RemoteSourceCodeFolder)"}, "Size": {"type": "integer", "description": "The size of the file, in bytes."}, "AuthorName": {"type": "string", "description": "The name of the file's author"}, "LastRevision": {"type": "object", "description": "The most recent revision of the file (Schema: RemoteSourceCodeRevision)"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The last update date/time"}, "Action": {"type": "string", "description": "The name of the last action performed on the file"}, "Path": {"type": "string", "description": "The file's path (usually the connection string + any sub directories."}, "LinkedArtifacts": {"type": "array", "description": "Any artifacts this file is linked to", "items": {"type": "object", "description": "Schema: RemoteLinkedArtifact"}} } }, "RemoteSourceCodeFolder": { "type": "object", "properties": { "Id": {"type": "string", "description": "The id of the folder"}, "Name": {"type": "string", "description": "The full nema of the folder."}, "ParentFolder": {"type": "object", "description": "The parent folder, if it has one. (Schema: RemoteSourceCodeFolder)"}, "Files": {"type": "array", "description": "A list of Files that are contained within this folder.", "items": {"type": "object", "description": "Schema: RemoteSourceCodeFile"}}, "Folders": {"type": "array", "description": "A list of child Folders that are contained within this folder.", "items": {"type": "object", "description": "Schema: RemoteSourceCodeFolder"}}, "IsRoot": {"type": "boolean", "description": "Flag indicating whether the current folder is the root folder or not."} } }, "RemoteSourceCodeRevision": { "type": "object", "properties": { "Id": {"type": "string", "description": "The ID of the revision"}, "Name": {"type": "string", "description": "The display name of the revision."}, "AuthorName": {"type": "string", "description": "The name of the author who submitted the update."}, "Message": {"type": "string", "description": "The commit message submnitted with the changes."}, "UpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The date of the revision."}, "ContentChanged": {"type": "boolean", "description": "Flag specifying wether the Content has been changed."}, "PropertiesChanged": {"type": "boolean", "description": "Flag indicating whether the Properties have been changed."}, "Files": {"type": "array", "description": "A list of files that were included in this revision.", "items": {"type": "object", "description": "Schema: RemoteSourceCodeFile"}} } }, "RemoteSystemCustomList": { "type": "object", "properties": { "CustomPropertyListId": {"type": "integer", "nullable": true, "description": "The id of the custom list"}, "Name": {"type": "string", "description": "The name of the custom list"}, "Active": {"type": "boolean", "description": "Whether the list is active or not"}, "SortedOnValue": {"type": "boolean", "description": "Whether the list is sorted on value or not"}, "Values": {"type": "array", "description": "The collection of values in the custom list", "items": {"type": "object", "description": "Schema: RemoteSystemCustomListValue"}}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"}, "ConcurrencyGuid": {"type": "string", "description": "GUID for representing the concurrency state of a given artifact"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last time the artifact was updated"} } }, "RemoteSystemCustomListValue": { "type": "object", "properties": { "CustomPropertyValueId": {"type": "integer", "nullable": true, "description": "The id of the custom list value"}, "CustomPropertyListId": {"type": "integer", "description": "The id of the custom list the value belongs to"}, "Name": {"type": "string", "description": "The name of the custom list value"}, "Active": {"type": "boolean", "description": "Is the custom list value active or not"}, "ParentCustomPropertyValueId": {"type": "integer", "nullable": true, "description": "The id of any parent custom list value"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"}, "ConcurrencyGuid": {"type": "string", "description": "GUID for representing the concurrency state of a given artifact"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last time the artifact was updated"} } }, "RemoteSystemCustomProperty": { "type": "object", "properties": { "CustomPropertyId": {"type": "integer", "nullable": true, "description": "The id of the custom property (leave null for newly created ones)"}, "ArtifactTypeId": {"type": "integer", "description": "The artifact type that the custom property is for"}, "Name": {"type": "string", "description": "The display name for the custom property"}, "CustomList": {"type": "object", "description": "The associated custom list if this is a list custom property (Schema: RemoteSystemCustomList)"}, "CustomPropertyFieldName": {"type": "string", "description": "The internal field name of the custom property (e.g. Custom_01)"}, "CustomPropertyTypeId": {"type": "integer", "description": "The type of custom property. It can have the following values:\n Text = 1,\n Integer = 2,\n Decimal = 3,\n Boolean = 4,\n Date = 5,\n List = 6,\n MultiList = 7,\n User = 8,\n Password = 9,\n Release = 10,\n Date and Time = 11,\n Automation Host = 12"}, "CustomPropertyTypeName": {"type": "string", "description": "The display name of the type of custom property"}, "IsDeleted": {"type": "boolean", "description": "Has this custom property been deleted"}, "PropertyNumber": {"type": "integer", "description": "The position number of this custom property (1-30). Each artifact type can have 30 custom properties per project"}, "SystemDataType": {"type": "string", "description": "The physical data type that this custom property is stored as (Int32, String, DataTime, etc.)"}, "Options": {"type": "array", "description": "The collection of custom property options", "items": {"type": "object", "description": "Schema: RemoteSystemCustomPropertyOption"}}, "Position": {"type": "integer", "nullable": true, "description": "Determines the position of this custom property relative to other custom properties in the UI"}, "Description": {"type": "string", "description": "Tooltip which appears when hovering the custom property name on a details page"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"}, "ConcurrencyGuid": {"type": "string", "description": "GUID for representing the concurrency state of a given artifact"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last time the artifact was updated"} } }, "RemoteSystemSourceCodeProvider": { "type": "object", "properties": { "Name": {"type": "string", "description": "This is the name of the source code provider integration which is being used such as GitProvider or SubversionProvider"}, "Description": {"type": "string", "description": "This is a description for any internal notes about what this source code provider does"}, "VersionControlSystemId": {"type": "integer", "description": "Unique internal ID of this version control configuration"}, "IsActive": {"type": "boolean", "description": "Whether or not this configuration is active"}, "ConnectionInfo": {"type": "string", "description": "Connection info intended for this product"}, "Login": {"type": "string", "description": "Login credential for connecting to the relevant provider"}, "Password": {"type": "string", "description": "Update only password field for setting the password credential on a newly created provider or when updating a provider"}, "Domain": {"type": "string", "description": "Used by specific integrations for setting some domain information which is separate from the connection info"}, "Custom01": {"type": "string", "description": "Custom input field for behavior or information specific to a given source code provider"}, "Custom02": {"type": "string", "description": "Custom input field for behavior or information specific to a given source code provider"}, "Custom03": {"type": "string", "description": "Custom input field for behavior or information specific to a given source code provider"}, "Custom04": {"type": "string", "description": "Custom input field for behavior or information specific to a given source code provider"}, "Custom05": {"type": "string", "description": "Custom input field for behavior or information specific to a given source code provider"} } }, "RemoteTableData": { "type": "object", "properties": { "Columns": {"type": "array", "description": "The list of columns in the table", "items": {"type": "object", "description": "Schema: RemoteTableColumn"}}, "Rows": {"type": "array", "description": "The list of rows in the table", "items": {"type": "object", "description": "Schema: RemoteTableRow"}} } }, "RemoteTask": { "type": "object", "properties": { "TaskId": {"type": "integer", "nullable": true, "description": "The id of the task"}, "TaskStatusId": {"type": "integer", "description": "The id of the status of the task"}, "TaskTypeId": {"type": "integer", "nullable": true, "description": "The id of the type of the task (null for default)"}, "TaskFolderId": {"type": "integer", "nullable": true, "description": "The of the folder the task is stored in (null for root)"}, "RequirementId": {"type": "integer", "nullable": true, "description": "The id of the parent requirement that the task belongs to"}, "ReleaseId": {"type": "integer", "nullable": true, "description": "The id of the release/iteration that the task is scheduled for"}, "ReleaseGuid": {"type": "string", "description": "The guid of the release"}, "ComponentId": {"type": "integer", "nullable": true, "description": "The id of the component that this task belongs to"}, "CreatorId": {"type": "integer", "nullable": true, "description": "The id of the user that originally created the task"}, "OwnerId": {"type": "integer", "nullable": true, "description": "The id of the user that the task is assigned-to"}, "CreatorGuid": {"type": "string", "description": "The guid of the creator."}, "OwnerGuid": {"type": "string", "description": "The guid of the owner."}, "TaskPriorityId": {"type": "integer", "nullable": true, "description": "The id of the priority of the task"}, "Name": {"type": "string", "description": "The name of the task"}, "Description": {"type": "string", "description": "The detailed description of the task"}, "CreationDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The date/time that the task was originally created"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The date/time that the task was last modified"}, "StartDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "The scheduled start date for the task"}, "EndDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "The scheduled end date for the task"}, "CompletionPercent": {"type": "integer", "description": "The completion percentage (value = 0-100) of the task as calculated in the system from the remaining effort\n vs. the original estimated effort."}, "EstimatedEffort": {"type": "integer", "nullable": true, "description": "The originally estimated effort (in minutes) of the task"}, "ActualEffort": {"type": "integer", "nullable": true, "description": "The actual effort expended so far (in minutes) for the task"}, "RemainingEffort": {"type": "integer", "nullable": true, "description": "The effort remaining as reported by the developer"}, "ProjectedEffort": {"type": "integer", "nullable": true, "description": "The projected actual effort of the task when it is completed"}, "TaskStatusName": {"type": "string", "description": "The display name of the status of the task"}, "TaskTypeName": {"type": "string", "description": "The display name of the type of the task"}, "OwnerName": {"type": "string", "description": "The display name of the user who the task is assigned-to"}, "TaskPriorityName": {"type": "string", "description": "The display name of the priority of the task"}, "ProjectName": {"type": "string", "description": "The display name of the project the task belongs to"}, "ReleaseVersionNumber": {"type": "string", "description": "The version number of the release/iteration the task is scheduled for"}, "RequirementName": {"type": "string", "description": "The name of the requirement that the task is associated with"}, "RiskId": {"type": "integer", "nullable": true, "description": "The risk that the task is associated with"}, "ProjectId": {"type": "integer", "description": "The id of the project that the artifact belongs to"}, "ProjectGuid": {"type": "string", "description": "The guid of the project that the artifact belongs to"}, "ArtifactTypeId": {"type": "integer", "description": "The type of artifact that we have"}, "ConcurrencyDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The datetime used to track optimistic concurrency to prevent edit conflicts"}, "CustomProperties": {"type": "array", "description": "The list of associated custom properties/fields for this artifact", "items": {"type": "object", "description": "Schema: RemoteArtifactCustomProperty"}}, "IsAttachments": {"type": "boolean", "description": "Does this artifact have any attachments?"}, "Tags": {"type": "string", "description": "The list of meta-tags that should be associated with the artifact"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"} } }, "RemoteTaskFolder": { "type": "object", "properties": { "TaskFolderId": {"type": "integer", "nullable": true, "description": "The id of the task folder"}, "ProjectId": {"type": "integer", "description": "The id of the project this folder belongs to"}, "IndentLevel": {"type": "string", "description": "The indentation level of the folder"}, "Name": {"type": "string", "description": "The name of the task folder"}, "ParentTaskFolderId": {"type": "integer", "nullable": true, "description": "The ID of the parent folder of this folder (if any)"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"}, "ConcurrencyGuid": {"type": "string", "description": "GUID for representing the concurrency state of a given artifact"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last time the artifact was updated"} } }, "RemoteTaskPriority": { "type": "object", "properties": { "PriorityId": {"type": "integer", "nullable": true, "description": "The id of the task priority (integer)"}, "Name": {"type": "string", "description": "The name of the task priority (string)"}, "Active": {"type": "boolean", "description": "Whether the priority is active or not (boolean)"}, "Color": {"type": "string", "description": "The hex color code associated with the priority (string)"}, "Score": {"type": "integer", "nullable": true, "description": "The score value"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"}, "ConcurrencyGuid": {"type": "string", "description": "GUID for representing the concurrency state of a given artifact"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last time the artifact was updated"} } }, "RemoteTaskStatus": { "type": "object", "properties": { "TaskStatusId": {"type": "integer", "description": "The id of the task status"}, "Name": {"type": "string", "description": "The name of the task status"}, "Active": {"type": "boolean", "description": "Is this an active task status"}, "Position": {"type": "integer", "description": "The display position of this status"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"}, "ConcurrencyGuid": {"type": "string", "description": "GUID for representing the concurrency state of a given artifact"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last time the artifact was updated"} } }, "RemoteTaskType": { "type": "object", "properties": { "TaskTypeId": {"type": "integer", "description": "The id of the task type"}, "Name": {"type": "string", "description": "The name of the task type"}, "WorkflowId": {"type": "integer", "nullable": true, "description": "The id of the workflow the task type is associated with, for the current project"}, "IsActive": {"type": "boolean", "description": "Is this an active task type"}, "Position": {"type": "integer", "description": "The display position of this type"}, "IsDefault": {"type": "boolean", "description": "Is this the default task type"}, "IsCodeReview": {"type": "boolean", "description": "Is this a code review task"}, "IsPullRequest": {"type": "boolean", "description": "Is this a pull request task"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"}, "ConcurrencyGuid": {"type": "string", "description": "GUID for representing the concurrency state of a given artifact"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last time the artifact was updated"} } }, "RemoteTestCase": { "type": "object", "properties": { "TestCaseId": {"type": "integer", "nullable": true, "description": "The id of the test case"}, "ExecutionStatusId": {"type": "integer", "nullable": true, "description": "The execution status id of the test case"}, "AuthorId": {"type": "integer", "nullable": true, "description": "The id of the user that wrote the test case"}, "OwnerId": {"type": "integer", "nullable": true, "description": "The id of the user that the test case is assigned-to"}, "AuthorGuid": {"type": "string", "description": "The guid of the author."}, "OwnerGuid": {"type": "string", "description": "The guid of the owner."}, "TestCasePriorityId": {"type": "integer", "nullable": true, "description": "The id of the priority of the test case"}, "TestCaseTypeId": {"type": "integer", "nullable": true, "description": "The type of test case, pass null to use the default value"}, "TestCaseStatusId": {"type": "integer", "description": "The status of the test case, pass 0 to use the default value"}, "TestCaseFolderId": {"type": "integer", "nullable": true, "description": "The id of the folder the test case belongs to. Null = root folder"}, "ComponentIds": {"type": "array", "description": "The list of components that this test case belongs to", "items": {"type": "integer"}}, "AutomationEngineId": {"type": "integer", "nullable": true, "description": "The id of the automation engine the associated test script uses (null if manual only)"}, "AutomationAttachmentId": {"type": "integer", "nullable": true, "description": "The id of the attachment that is being used to store the test script (file or url)"}, "Name": {"type": "string", "description": "The name of the test case"}, "Description": {"type": "string", "description": "The description of the test case"}, "CreationDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The date the test case was created"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The date the test case was last updated"}, "ExecutionDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "The date the test case was last executed"}, "EstimatedDuration": {"type": "integer", "nullable": true, "description": "The estimated time to execute the test case"}, "AuthorName": {"type": "string", "description": "The display name of the user that wrote the test case"}, "OwnerName": {"type": "string", "description": "The display name of the user that the test case is assigned-to"}, "ProjectName": {"type": "string", "description": "The display name of the project that the test case belongs to"}, "TestCasePriorityName": {"type": "string", "description": "The display name of the priority of the test case"}, "TestCaseStatusName": {"type": "string", "description": "The display name of the status of the test case"}, "TestCaseTypeName": {"type": "string", "description": "The display name of the type of the test case"}, "ExecutionStatusName": {"type": "string", "description": "The display name of the execution status"}, "TestSteps": {"type": "array", "description": "The list of test steps that comprise the test case", "items": {"type": "object", "description": "Schema: RemoteTestStep"}}, "ActualDuration": {"type": "integer", "nullable": true, "description": "The actual result from the most recent test run of the this test case"}, "IsSuspect": {"type": "boolean", "description": "Have any of the requirements associated with this test case changed"}, "IsTestSteps": {"type": "boolean", "description": "Does this test case have steps"}, "ProjectId": {"type": "integer", "description": "The id of the project that the artifact belongs to"}, "ProjectGuid": {"type": "string", "description": "The guid of the project that the artifact belongs to"}, "ArtifactTypeId": {"type": "integer", "description": "The type of artifact that we have"}, "ConcurrencyDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The datetime used to track optimistic concurrency to prevent edit conflicts"}, "CustomProperties": {"type": "array", "description": "The list of associated custom properties/fields for this artifact", "items": {"type": "object", "description": "Schema: RemoteArtifactCustomProperty"}}, "IsAttachments": {"type": "boolean", "description": "Does this artifact have any attachments?"}, "Tags": {"type": "string", "description": "The list of meta-tags that should be associated with the artifact"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"} } }, "RemoteTestCaseFolder": { "type": "object", "properties": { "TestCaseFolderId": {"type": "integer", "nullable": true, "description": "The id of the test case folder"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"}, "ProjectId": {"type": "integer", "description": "The id of the project this folder belongs to"}, "IndentLevel": {"type": "string", "description": "The indentation level of the folder"}, "Name": {"type": "string", "description": "The name of the test case folder"}, "Description": {"type": "string", "description": "The description of the test case folder"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The date the test case folder was last updated"}, "ExecutionDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "The date the test cases in the folder were last executed"}, "EstimatedDuration": {"type": "integer", "nullable": true, "description": "The estimated time to execute the test case"}, "ProjectName": {"type": "string", "description": "The display name of the project that the test case folder belongs to"}, "ParentTestCaseFolderId": {"type": "integer", "nullable": true, "description": "The ID of the parent folder of this folder (if any)"}, "ActualDuration": {"type": "integer", "nullable": true, "description": "The actual duration of all the tests in the folder"}, "CountBlocked": {"type": "integer", "description": "The count of blocked test cases in the folder"}, "CountCaution": {"type": "integer", "description": "The count of blocked test cases in the folder"}, "CountFailed": {"type": "integer", "description": "The count of blocked test cases in the folder"}, "CountNotApplicable": {"type": "integer", "description": "The count of blocked test cases in the folder"}, "CountNotRun": {"type": "integer", "description": "The count of blocked test cases in the folder"}, "CountPassed": {"type": "integer", "description": "The count of blocked test cases in the folder"} } }, "RemoteTestCaseParameter": { "type": "object", "properties": { "TestCaseParameterId": {"type": "integer", "nullable": true, "description": "The id of the test case parameter"}, "TestCaseId": {"type": "integer", "description": "The id of the test case the parameter is defined for"}, "Name": {"type": "string", "description": "The name of the parameter"}, "DefaultValue": {"type": "string", "description": "The default value when none is provided by a parent test case"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"}, "ConcurrencyGuid": {"type": "string", "description": "GUID for representing the concurrency state of a given artifact"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last time the artifact was updated"} } }, "RemoteTestCasePriority": { "type": "object", "properties": { "PriorityId": {"type": "integer", "nullable": true, "description": "The id of the test case priority (integer)"}, "Name": {"type": "string", "description": "The name of the test case priority (string)"}, "Active": {"type": "boolean", "description": "Whether the priority is active or not (boolean)"}, "Color": {"type": "string", "description": "The hex color code associated with the priority (string)"}, "Score": {"type": "integer", "nullable": true, "description": "The score value"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"}, "ConcurrencyGuid": {"type": "string", "description": "GUID for representing the concurrency state of a given artifact"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last time the artifact was updated"} } }, "RemoteTestCaseStatus": { "type": "object", "properties": { "TestCaseStatusId": {"type": "integer", "description": "The id of the test case status"}, "Name": {"type": "string", "description": "The name of the status"}, "Active": {"type": "boolean", "description": "Is this an active status"}, "Position": {"type": "integer", "description": "The display position of this status"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"}, "ConcurrencyGuid": {"type": "string", "description": "GUID for representing the concurrency state of a given artifact"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last time the artifact was updated"} } }, "RemoteTestCaseType": { "type": "object", "properties": { "TestCaseTypeId": {"type": "integer", "description": "The id of the test case type"}, "Name": {"type": "string", "description": "The name of the type"}, "WorkflowId": {"type": "integer", "nullable": true, "description": "The id of the workflow the type is associated with, for the current project"}, "IsActive": {"type": "boolean", "description": "Is this an active type"}, "Position": {"type": "integer", "description": "The display position of this type"}, "IsDefault": {"type": "boolean", "description": "Is this the default test case type"}, "IsExploratory": {"type": "boolean", "description": "Is this an exploratory test case"}, "IsBdd": {"type": "boolean", "description": "Is this a BDD format test case"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"}, "ConcurrencyGuid": {"type": "string", "description": "GUID for representing the concurrency state of a given artifact"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last time the artifact was updated"} } }, "RemoteTestConfigurationSet": { "type": "object", "properties": { "TestConfigurationSetId": {"type": "integer", "description": "The id of the test configuration set"}, "TestConfigurationSetGuid": {"type": "string", "description": "The guid of the test configuration set"}, "IsActive": {"type": "boolean", "description": "Is the item active"}, "CreationDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The date/time this item was created"}, "LastUpdatedDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The date/time this item was updated"}, "ConcurrencyDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The date-time field used to maintain concurrency"}, "ProjectId": {"type": "integer", "description": "The ID of the project"}, "ProjectGuid": {"type": "string", "description": "The guid of the project"}, "Name": {"type": "string", "description": "The name of the Test Configuration Set"}, "Description": {"type": "string", "description": "The long description of the Test Configuration Set"}, "Entries": {"type": "array", "description": "The list of test configuration entries in the set", "items": {"type": "object", "description": "Schema: RemoteTestConfigurationEntry"}} } }, "RemoteTestConfigurationSetParameter": { "type": "object", "properties": { "TestCaseParameterId": {"type": "integer", "description": "The id of the test case parameter"}, "CustomListId": {"type": "integer", "description": "The id of the custom list to use for values"} } }, "RemoteTestRun": { "type": "object", "properties": { "TestRunId": {"type": "integer", "nullable": true, "description": "The id of the test run"}, "Name": {"type": "string", "description": "The name of the test run (usually the same as the test case)"}, "TestCaseId": {"type": "integer", "description": "The id of the test case that the test run is an instance of"}, "TestCaseGuid": {"type": "string", "description": "The guid of the test case that the test run is an instance of"}, "TestRunTypeId": {"type": "integer", "description": "The id of the type of test run (automated vs. manual)"}, "TesterId": {"type": "integer", "nullable": true, "description": "The id of the user that executed the test"}, "TesterGuid": {"type": "string", "description": "The guid of the tester."}, "ExecutionStatusId": {"type": "integer", "description": "The id of overall execution status for the test run"}, "ReleaseId": {"type": "integer", "nullable": true, "description": "The id of the release that the test run should be reported against"}, "ReleaseGuid": {"type": "string", "description": "The guid of the release"}, "TestSetId": {"type": "integer", "nullable": true, "description": "The id of the test set that the test run should be reported against"}, "TestSetGuid": {"type": "string", "description": "The guid of the test set"}, "TestSetTestCaseId": {"type": "integer", "nullable": true, "description": "The id of the unique test case entry in the test set"}, "StartDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The date/time that the test execution was started"}, "EndDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "The date/time that the test execution was completed"}, "BuildId": {"type": "integer", "nullable": true, "description": "The id of the build that the test was executed against"}, "EstimatedDuration": {"type": "integer", "nullable": true, "description": "The estimated duration of how long the test should take to execute (read-only)"}, "ActualDuration": {"type": "integer", "nullable": true, "description": "The actual duration of how long the test should take to execute (read-only)"}, "TestConfigurationId": {"type": "integer", "nullable": true, "description": "The id of the specific test configuration that was used"}, "ReleaseVersionNumber": {"type": "string", "description": "version number of the release this test run was run against."}, "ProjectId": {"type": "integer", "description": "The id of the project that the artifact belongs to"}, "ProjectGuid": {"type": "string", "description": "The guid of the project that the artifact belongs to"}, "ArtifactTypeId": {"type": "integer", "description": "The type of artifact that we have"}, "ConcurrencyDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The datetime used to track optimistic concurrency to prevent edit conflicts"}, "CustomProperties": {"type": "array", "description": "The list of associated custom properties/fields for this artifact", "items": {"type": "object", "description": "Schema: RemoteArtifactCustomProperty"}}, "IsAttachments": {"type": "boolean", "description": "Does this artifact have any attachments?"}, "Tags": {"type": "string", "description": "The list of meta-tags that should be associated with the artifact"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"} } }, "RemoteTestSet": { "type": "object", "properties": { "TestSetId": {"type": "integer", "nullable": true, "description": "The id of the test set"}, "IndentLevel": {"type": "string", "description": "(Not used in this version of the API)"}, "TestSetStatusId": {"type": "integer", "description": "The id of the test set's status"}, "CreatorId": {"type": "integer", "nullable": true, "description": "The id of the user who created the test set"}, "OwnerId": {"type": "integer", "nullable": true, "description": "The id of the user who the test set is assigned-to"}, "CreatorGuid": {"type": "string", "description": "The guid of the creator."}, "OwnerGuid": {"type": "string", "description": "The guid of the owner."}, "ReleaseId": {"type": "integer", "nullable": true, "description": "The id of the release that the test set is assigned-to"}, "ReleaseGuid": {"type": "string", "description": "The guid of the release"}, "AutomationHostId": {"type": "integer", "nullable": true, "description": "The id of the automation host the test set is assigned-to"}, "TestRunTypeId": {"type": "integer", "nullable": true, "description": "The id of the type of test set (1 = Manual, 2 = Automated)"}, "RecurrenceId": {"type": "integer", "nullable": true, "description": "The id of the recurrence pattern the test set is scheduled for"}, "Name": {"type": "string", "description": "The name of the test set"}, "Description": {"type": "string", "description": "The detailed description of the test set"}, "CreationDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The date the test set was originally created"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The date the test set was last modified"}, "PlannedDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "The date that the test set needs is planned to be executed on"}, "ExecutionDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "The date that the test set was last executed by a tester"}, "CountPassed": {"type": "integer", "nullable": true, "description": "How many passed test cases are in the set"}, "CountFailed": {"type": "integer", "nullable": true, "description": "How many failed test cases are in the set"}, "CountCaution": {"type": "integer", "nullable": true, "description": "How many cautioned test cases are in the set"}, "CountBlocked": {"type": "integer", "nullable": true, "description": "How many blocked test cases are in the set"}, "CountNotRun": {"type": "integer", "nullable": true, "description": "How many test cases in the set have not been run"}, "CountNotApplicable": {"type": "integer", "nullable": true, "description": "How many test cases in the set are not applicable"}, "CreatorName": {"type": "string", "description": "The display name of the user that created the test set"}, "OwnerName": {"type": "string", "description": "The display name of the user that the test set is assigned-to"}, "ProjectName": {"type": "string", "description": "The display name of the project that the test set belongs to"}, "TestSetStatusName": {"type": "string", "description": "The display name of the status of the test set"}, "ReleaseVersionNumber": {"type": "string", "description": "The version number of the release the test set is scheduled for"}, "RecurrenceName": {"type": "string", "description": "The display name of the recurrence pattern"}, "TestSetFolderId": {"type": "integer", "nullable": true, "description": "The ID of the test set folder this test set belongs to (NULL = root)"}, "EstimatedDuration": {"type": "integer", "nullable": true, "description": "The total estimated duration for all the test cases in this set"}, "ActualDuration": {"type": "integer", "nullable": true, "description": "The total actual duration for all the test cases in this set"}, "IsAutoScheduled": {"type": "boolean", "description": "Is this test set auto-scheduled when a build associated with the release runs"}, "IsDynamic": {"type": "boolean", "description": "Is this a dynamic test set"}, "DynamicQuery": {"type": "string", "description": "The underlying query if this is a dynamic test set"}, "TestConfigurationSetId": {"type": "integer", "nullable": true, "description": "The id of any test configuration set to be used with this test set"}, "BuildExecuteTimeInterval": {"type": "integer", "nullable": true, "description": "The interval between a build finishing and the test being execution (if auto-scheduled)"}, "ProjectId": {"type": "integer", "description": "The id of the project that the artifact belongs to"}, "ProjectGuid": {"type": "string", "description": "The guid of the project that the artifact belongs to"}, "ArtifactTypeId": {"type": "integer", "description": "The type of artifact that we have"}, "ConcurrencyDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The datetime used to track optimistic concurrency to prevent edit conflicts"}, "CustomProperties": {"type": "array", "description": "The list of associated custom properties/fields for this artifact", "items": {"type": "object", "description": "Schema: RemoteArtifactCustomProperty"}}, "IsAttachments": {"type": "boolean", "description": "Does this artifact have any attachments?"}, "Tags": {"type": "string", "description": "The list of meta-tags that should be associated with the artifact"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"} } }, "RemoteTestSetFolder": { "type": "object", "properties": { "TestSetFolderId": {"type": "integer", "nullable": true, "description": "The id of the test set folder"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"}, "ProjectId": {"type": "integer", "description": "The id of the project this folder belongs to"}, "IndentLevel": {"type": "string", "description": "The indentation level of the folder"}, "Name": {"type": "string", "description": "The name of the test set folder"}, "Description": {"type": "string", "description": "The description of the test set folder"}, "CreationDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The date the test set folder was created"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The date the test set folder was last updated"}, "ExecutionDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "The date the test sets in the folder were last executed"}, "EstimatedDuration": {"type": "integer", "nullable": true, "description": "The estimated time to execute the test set"}, "ProjectName": {"type": "string", "description": "The display name of the project that the test set folder belongs to"}, "ParentTestSetFolderId": {"type": "integer", "nullable": true, "description": "The ID of the parent folder of this folder (if any)"}, "ActualDuration": {"type": "integer", "nullable": true, "description": "The actual duration of all the tests in the folder"}, "CountBlocked": {"type": "integer", "description": "The count of blocked test sets in the folder"}, "CountCaution": {"type": "integer", "description": "The count of blocked test sets in the folder"}, "CountFailed": {"type": "integer", "description": "The count of blocked test sets in the folder"}, "CountNotApplicable": {"type": "integer", "description": "The count of blocked test sets in the folder"}, "CountNotRun": {"type": "integer", "description": "The count of blocked test sets in the folder"}, "CountPassed": {"type": "integer", "description": "The count of blocked test sets in the folder"} } }, "RemoteTestSetParameter": { "type": "object", "properties": { "TestSetId": {"type": "integer", "description": "The id of the test set"}, "TestCaseParameterId": {"type": "integer", "description": "The id of the test case parameter"}, "TestCaseParameterGuid": {"type": "string", "description": "The guid of the test case parameter"}, "Name": {"type": "string", "description": "The name of the test case parameter"}, "Value": {"type": "string", "description": "The value of the parameter to be passed from the test set to the test cases"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"}, "ConcurrencyGuid": {"type": "string", "description": "GUID for representing the concurrency state of a given artifact"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last time the artifact was updated"} } }, "RemoteTestSetTestCaseMapping": { "type": "object", "properties": { "TestSetTestCaseId": {"type": "integer", "description": "The unique id of the test case in the test set"}, "TestSetId": {"type": "integer", "description": "The id of the test set"}, "TestCaseId": {"type": "integer", "description": "The id of the test case"}, "TestSetGuid": {"type": "string", "description": "The guid of the test set"}, "TestCaseGuid": {"type": "string", "description": "The guid of the test case"}, "OwnerId": {"type": "integer", "nullable": true, "description": "The id of the owner of the test case in the test set"}, "OwnerGuid": {"type": "string", "description": "The guid of the owner"}, "PlannedDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Does the test case in the test set have a specific planned date"}, "IsSetupTeardown": {"type": "boolean", "description": "Is this a setup or teardown test case in the test set"}, "Position": {"type": "integer", "nullable": true, "description": "This value determines the position of this test case in the test set's list of test cases"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"}, "ConcurrencyGuid": {"type": "string", "description": "GUID for representing the concurrency state of a given artifact"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last time the artifact was updated"} } }, "RemoteTestSetTestCaseParameter": { "type": "object", "properties": { "TestSetTestCaseId": {"type": "integer", "description": "The id of the test set test case"}, "TestCaseParameterId": {"type": "integer", "description": "The id of the test case parameter"}, "TestCaseParameterGuid": {"type": "string", "description": "The guid of the test case parameter"}, "Name": {"type": "string", "description": "The name of the test case parameter"}, "Value": {"type": "string", "description": "The value of the parameter to be passed from the test set to the test case"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"}, "ConcurrencyGuid": {"type": "string", "description": "GUID for representing the concurrency state of a given artifact"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last time the artifact was updated"} } }, "RemoteTestStep": { "type": "object", "properties": { "TestStepId": {"type": "integer", "nullable": true, "description": "The id of the test step"}, "TestCaseId": {"type": "integer", "description": "The id of the test case the step belongs to"}, "TestCaseGuid": {"type": "string", "description": "The guid of the test case the step belongs to"}, "ExecutionStatusId": {"type": "integer", "nullable": true, "description": "The id of the execution status for the last time it was executed"}, "Position": {"type": "integer", "description": "The position of the step in the test case"}, "Description": {"type": "string", "description": "The description of what the tester should do to execute this step"}, "ExpectedResult": {"type": "string", "description": "The description of what the tester should see if the step succeeds"}, "SampleData": {"type": "string", "description": "Any sample data that the tester should use during execution"}, "LinkedTestCaseId": {"type": "integer", "nullable": true, "description": "If this step is really a linked test case, this is the id of the linked test case"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The date the test step was last updated"}, "Precondition": {"type": "string", "description": "Precondition field (used for BDD tests)"}, "ProjectId": {"type": "integer", "description": "The id of the project that the artifact belongs to"}, "ProjectGuid": {"type": "string", "description": "The guid of the project that the artifact belongs to"}, "ArtifactTypeId": {"type": "integer", "description": "The type of artifact that we have"}, "ConcurrencyDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The datetime used to track optimistic concurrency to prevent edit conflicts"}, "CustomProperties": {"type": "array", "description": "The list of associated custom properties/fields for this artifact", "items": {"type": "object", "description": "Schema: RemoteArtifactCustomProperty"}}, "IsAttachments": {"type": "boolean", "description": "Does this artifact have any attachments?"}, "Tags": {"type": "string", "description": "The list of meta-tags that should be associated with the artifact"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"} } }, "RemoteTestStepParameter": { "type": "object", "properties": { "Name": {"type": "string", "description": "The name of the test step parameter"}, "Value": {"type": "string", "description": "The value of the parameter to be passed from the parent test case to the child test case"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"}, "ConcurrencyGuid": {"type": "string", "description": "GUID for representing the concurrency state of a given artifact"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last time the artifact was updated"} } }, "RemoteTimesheet": { "type": "object", "properties": { "TimesheetId": {"type": "integer", "nullable": true, "description": "The id of the timesheet"}, "TimesheetStatusId": {"type": "integer", "nullable": true, "description": "The status id of the timesheet"}, "SubmitterUserId": {"type": "integer", "nullable": true, "description": "The id of the user that created the timesheet"}, "ApproverUserId": {"type": "integer", "nullable": true, "description": "The id of the user that approved the timesheet"}, "Submitter": {"type": "string", "description": "The name of the user that created the timesheet"}, "Approver": {"type": "string", "description": "The name of the user that approved the timesheet"}, "StatusName": {"type": "string", "description": "The name of the status of the timesheet"}, "CreationDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The date the timesheet was created"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The date the timesheet was updated last"}, "StartDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The initial date the timesheet covers"}, "EndDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The final date the timesheet covers"}, "ApprovalDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "The date the timesheet was approved"}, "IsDeleted": {"type": "boolean", "description": "Was this timesheet deleted from the system?"}, "Entries": {"type": "array", "description": "The list of entries of this timesheet", "items": {"type": "object", "description": "Schema: RemoteTimesheetEntry"}}, "SubmitterComments": {"type": "string", "description": "The comment(s) made by the submitter of this timesheet"}, "ApproverComments": {"type": "string", "description": "The comment(s) made by the approver of this timesheet"}, "Status": {"type": "object", "description": "Information about the current status. (Schema: RemoteTimesheetStatus)"} } }, "RemoteTimesheetEntry": { "type": "object", "properties": { "ProjectId": {"type": "integer", "nullable": true, "description": "The product which this artifact exists or existed within"}, "TimesheetEntryId": {"type": "integer", "nullable": true, "description": "The id of the timesheet entry"}, "ArtifactId": {"type": "integer", "nullable": true, "description": "The ID of the artifact recorded in this entry"}, "EntryArtifactTypeId": {"type": "integer", "nullable": true, "description": "The type of the artifact recorded in this entry"}, "ProjectGroupId": {"type": "integer", "nullable": true, "description": "The program this entry belongs to"}, "ResourceCategoryId": {"type": "integer", "nullable": true, "description": "The resource category of this entry"}, "TimesheetId": {"type": "integer", "nullable": true, "description": "The id of the timesheet this entry belongs to"}, "TimesheetEntryTypeId": {"type": "integer", "nullable": true, "description": "The id of the timesheet entry type"}, "Description": {"type": "string", "description": "The description of this entry"}, "Effort": {"type": "integer", "description": "The effort of this entry (in minutes)"}, "EffortDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "description": "The date corresponding to the effort"}, "UserId": {"type": "integer", "nullable": true, "description": "The id of the user that created this entry"} } }, "RemoteTimesheetStatus": { "type": "object", "properties": { "TimesheetStatusId": {"type": "integer", "nullable": true, "description": "The id of the timesheet status"}, "Name": {"type": "string", "description": "The name of the timesheet status"}, "IsActive": {"type": "boolean", "description": "Whether this status is active or not"}, "IsOpen": {"type": "boolean", "description": "Whether this status can be classified as Open or not"} } }, "RemoteUser": { "type": "object", "properties": { "UserId": {"type": "integer", "nullable": true, "description": "The id of the user"}, "UserGuid": {"type": "string", "description": "The guid of the user"}, "FirstName": {"type": "string", "description": "The first (given) name of the user"}, "LastName": {"type": "string", "description": "The last name (surname) of the user"}, "MiddleInitial": {"type": "string", "description": "The middle initials of the user"}, "UserName": {"type": "string", "description": "The login used by the user"}, "LdapDn": {"type": "string", "description": "The LDAP Distinguished Name for the user (null for non-LDAP users)"}, "EmailAddress": {"type": "string", "description": "The email address of the user"}, "Admin": {"type": "boolean", "description": "Whether the user is a system administrator"}, "Active": {"type": "boolean", "description": "Whether the user is active in the system"}, "Department": {"type": "string", "description": "The department of the user"}, "Approved": {"type": "boolean", "description": "Is this user approved by the system administrator"}, "Locked": {"type": "boolean", "description": "Is this user locked-out of their account"}, "RssToken": {"type": "string", "description": "This is the RSS token for this user"}, "FullName": {"type": "string", "description": "The full name of the user concatenated (First + Middle + Last)"}, "LastUpdatedDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true}, "LastLockoutDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last date this users account was locked out"}, "LastActivityDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last date this users account did something"}, "LastLoginDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last date this users account was logged in to"}, "LastPasswordChange": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last date this users account password was changed"}, "OrganizationName": {"type": "string", "description": "Organization name of the user"}, "OrganizationId": {"type": "integer", "nullable": true, "description": "ID of the organization this user belongs to"}, "EmailsEnabled": {"type": "boolean", "description": "Whether or not a user has opted to recieve emails or not"}, "ReportAdmin": {"type": "boolean", "description": "Whether the user is a report admin"}, "PortfolioViewer": {"type": "boolean", "description": "Whether this user has permissions to view all portfolios"}, "TimesheetManager": {"type": "boolean", "description": "Whether this user is a timesheet manager"}, "OAuthProvider": {"type": "string", "description": "Name of the external OAuth provider being used to access this account"}, "MutliFactorAuthentication": {"type": "boolean", "description": "Whether this user is using Spira's integrated MFA implementation."}, "CustomProperties": {"type": "array", "description": "The list of associated custom properties/fields for this user", "items": {"type": "object", "description": "Schema: RemoteSystemArtifactCustomProperty"}}, "ArtifactTypeId": {"type": "integer", "description": "The type of artifact that we have"}, "ConcurrencyGuid": {"type": "string", "description": "The field used to track optimistic concurrency to prevent edit conflicts"} } }, "RemoteUserMessage": { "type": "object", "properties": { "UserId": {"type": "integer", "description": "The id of the user"}, "UnreadMessages": {"type": "integer", "description": "The number of unread messages for this user"} } }, "RemoteVersion": { "type": "object", "properties": { "Version": {"type": "string", "description": "The version number of the installation"}, "Patch": {"type": "integer", "nullable": true, "description": "The patch number (if any)"} } }, "RemoteWorkflow": { "type": "object", "properties": { "WorkflowId": {"type": "integer", "description": "Id of the workflow being retrieved / updated / deleted"}, "Name": {"type": "string", "description": "Name of the workflow this object represents"}, "IsActive": {"type": "boolean", "description": "Is this workflow active in this template"}, "IsDefault": {"type": "boolean", "description": "Is this workflow the default for this template"}, "NotifyForTransitions": {"type": "boolean", "nullable": true, "description": "Incidents Only: Should transitions within this workflow notify (send emails) to relevant users"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"}, "ConcurrencyGuid": {"type": "string", "description": "GUID for representing the concurrency state of a given artifact"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last time the artifact was updated"} } }, "RemoteWorkflowCustomProperty": { "type": "object", "properties": { "FieldCaption": {"type": "string", "description": "What is the caption for the custom property"}, "FieldName": {"type": "string", "description": "What is the system name of the custom property"}, "CustomPropertyId": {"type": "integer", "description": "What is the id of the custom property"}, "FieldStateId": {"type": "integer", "description": "What is the state of the custom property that this represents"}, "ArtifactTypeId": {"type": "integer", "nullable": true, "description": "What is the artifact type this workflow custom property maps to"}, "ArtifactStatusId": {"type": "integer", "nullable": true, "description": "What is the artifact status ID this workflow field state is tied to"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"}, "ConcurrencyGuid": {"type": "string", "description": "GUID for representing the concurrency state of a given artifact"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last time the artifact was updated"} } }, "RemoteWorkflowField": { "type": "object", "properties": { "FieldCaption": {"type": "string", "description": "What is the caption for the field"}, "FieldName": {"type": "string", "description": "What is the system name of the field"}, "FieldId": {"type": "integer", "description": "What is the id of the field"}, "FieldStateId": {"type": "integer", "description": "What is the state of the field that this represents"}, "ArtifactTypeId": {"type": "integer", "nullable": true, "description": "What is the artifact type this workflow custom property maps to"}, "ArtifactStatusId": {"type": "integer", "nullable": true, "description": "What is the artifact status ID this workflow field state is tied to"}, "ArtifactStatusName": {"type": "string", "description": "Name of the artifact status this workflow field state is tied to"}, "WorkflowId": {"type": "integer", "nullable": true, "description": "ID of the workflow this particular workflow field is tied to"}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"}, "ConcurrencyGuid": {"type": "string", "description": "GUID for representing the concurrency state of a given artifact"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last time the artifact was updated"} } }, "RemoteWorkflowTransition": { "type": "object", "properties": { "ExecuteByCreator": {"type": "boolean", "description": "Can this transition be executed by the creator of the artifact"}, "ExecuteByOwner": {"type": "boolean", "description": "Can this transition be executed by the owner of the artifact"}, "StatusId_Input": {"type": "integer", "description": "What is the id of the input artifact status"}, "StatusName_Input": {"type": "string", "description": "What is the display name of the input artifact status"}, "StatusId_Output": {"type": "integer", "description": "What is the id of the output artifact status"}, "StatusName_Output": {"type": "string", "description": "What is the display name of the output artifact status"}, "Name": {"type": "string", "description": "What is the name of the transition"}, "WorkflowId": {"type": "integer", "description": "What workflow does this transition belong to"}, "TransitionId": {"type": "integer", "description": "What is the id of this transition"}, "RequireSignature": {"type": "boolean", "description": "Does it require an electronic signature"}, "BlankOwner": {"type": "boolean", "description": "Does the status this transition transitions to allow the Owner (OwnerId) field to be blank on the artifact being transitioned"}, "NotifyCreator": {"type": "boolean", "description": "Does this transition notify the artifact creator"}, "NotifyOwner": {"type": "boolean", "description": "Does this transition notify the artifact owner"}, "NotificationSubject": {"type": "string", "description": "Transition notification email subject line for emails sent to users configured to recieve notifications for this transition. (Incidents only)"}, "UserRoles": {"type": "array", "description": "UserRoleIds for who can execute this transition", "items": {"type": "integer"}}, "NotificationRoles": {"type": "array", "description": "UserRoleIds for who is notified when this transition occurrs (Incidents only)", "items": {"type": "integer"}}, "Guid": {"type": "string", "description": "The unique identifier for the artifact"}, "ConcurrencyGuid": {"type": "string", "description": "GUID for representing the concurrency state of a given artifact"}, "LastUpdateDate": {"type": "string", "format": "date-time", "example": "2023-05-16T00:00:00Z", "nullable": true, "description": "Last time the artifact was updated"} } }, "String": { "type": "object", "properties": { "Empty": {"type": "string"} } } } }, "paths": { "/automation-engines": { "get": { "operationId": "AutomationEngine_Retrieve", "summary": "Retrieves the list of automation engines in the system", "tags": ["Automation Engine"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "active_only", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "active_only", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteAutomationEngine"} } } } } } }, "post": { "operationId": "AutomationEngine_Create", "summary": "Creates a new Automation Engine in the system.", "tags": ["Automation Engine"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteAutomationEngine"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteAutomationEngine"} } } } } }, "put": { "operationId": "AutomationEngine_Update", "summary": "Updates an existing automation engine in the system", "tags": ["Automation Engine"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteAutomationEngine"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/automation-engines/{automation_engine_id}": { "get": { "operationId": "AutomationEngine_RetrieveById", "summary": "Retrieves a single automation engine record by its ID", "tags": ["Automation Engine"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "automation_engine_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteAutomationEngine"} } } } } } }, "/automation-engines/tokens{token}": { "get": { "operationId": "AutomationEngine_RetrieveByToken", "summary": "Retrieves a single automation engine record by its Token", "tags": ["Automation Engine"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteAutomationEngine"} } } } } } }, "/capabilities/priorities": { "get": { "operationId": "Capability_RetrievePriorities", "summary": "Retrieves the list of capability priorities in the system", "tags": ["Capability Priority"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteCapabilityPriority"} } } } } } }, "post": { "operationId": "Capability_AddPriority", "summary": "Adds a new capability priority to the system", "tags": ["Capability Priority"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteCapabilityPriority"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteCapabilityPriority"} } } } } }, "put": { "operationId": "Capability_UpdatePriority", "summary": "Updates a capability priority in the system", "tags": ["Capability Priority"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteCapabilityPriority"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/capabilities/priorities/{capability_priority_id}": { "get": { "operationId": "Capability_RetrievePriorityById", "summary": "Retrieves a single capability priority from the system", "tags": ["Capability Priority"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "capability_priority_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteCapabilityPriority"} } } } } } }, "/capabilities/statuses": { "get": { "operationId": "Capability_RetrieveStatuses", "summary": "Retrieves a list of the capability statuses of the system", "tags": ["Capability Status"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteCapabilityStatus"} } } } } } }, "post": { "operationId": "Capability_AddStatus", "summary": "Adds a new capability status to the system", "tags": ["Capability Status"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteCapabilityStatus"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteCapabilityStatus"} } } } } }, "put": { "operationId": "Capability_UpdateStatus", "summary": "Updates an existing capability status in the in the system", "tags": ["Capability Status"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteCapabilityStatus"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/capabilities/statuses/{capability_status_id}": { "get": { "operationId": "Capability_RetrieveStatusById", "summary": "Retrieves a single capability status from the system", "tags": ["Capability Status"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "capability_status_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteCapabilityStatus"} } } } } } }, "/capabilities/types": { "get": { "operationId": "Capability_RetrieveTypes", "summary": "Retrieves the list of capability types in the system", "tags": ["Capability Type"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteCapabilityType"} } } } } } }, "post": { "operationId": "Capability_AddType", "summary": "Adds a new capability type to the system", "tags": ["Capability Type"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteCapabilityType"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteCapabilityType"} } } } } }, "put": { "operationId": "Capability_UpdateType", "summary": "Updates a capability type in the system", "tags": ["Capability Type"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteCapabilityType"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/capabilities/types/{capability_type_id}": { "get": { "operationId": "Capability_RetrieveTypeById", "summary": "Retrieves a single capability type from the system", "tags": ["Capability Type"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "capability_type_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteCapabilityType"} } } } } } }, "/data-mappings/{data_sync_system_id}/artifacts/{artifact_type_id}/search": { "post": { "operationId": "DataMapping_SearchArtifactMappings", "summary": "Retrieves a list of data mappings for a specific artifact across all projects in the system the user is authorized to view", "tags": ["Data Mapping Artifacts"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "data_sync_system_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "artifact_type_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/String"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteProjectArtifact"} } } } } } } }, "/data-mappings/{data_sync_system_id}/projects": { "get": { "operationId": "DataMapping_RetrieveProjectMappings", "summary": "Retrieves a list of data mappings for projects in the system", "tags": ["Data Mapping Projects"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "data_sync_system_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteDataMapping"} } } } } } } }, "/data-mappings/{data_sync_system_id}/projects/{project_id}": { "put": { "operationId": "DataMapping_UpdateProjectMapping", "summary": "Updates the project data mapping for a specific data sync plugin.\n Only the ExternalKey is updated; the Active status is not modified.", "tags": ["Data Mapping Projects"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "data_sync_system_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteDataMapping"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/data-mappings/{data_sync_system_id}/users": { "post": { "operationId": "DataMapping_AddUserMappings", "summary": "Adds new user data mapping entries", "tags": ["Data Mapping Users"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "data_sync_system_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteDataMapping"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "get": { "operationId": "DataMapping_RetrieveUserMappings", "summary": "Retrieves a list of data mappings for users in the system", "tags": ["Data Mapping Users"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "data_sync_system_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteDataMapping"} } } } } } } }, "/data-syncs": { "get": { "operationId": "DataSyncSystem_Retrieve", "summary": "Retrieves a list of data-sync plug-ins that need to be synchronized with", "tags": ["Data Sync"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteDataSyncSystem"} } } } } } }, "post": { "operationId": "DataSyncSystem_Create", "summary": "Creates a new data sync system entry", "description": "Does not activate the sync for any projects", "tags": ["Data Sync"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteDataSyncSystem"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteDataSyncSystem"} } } } } } }, "/data-syncs/{data_sync_system_id}": { "get": { "operationId": "DataSyncSystem_RetrieveById", "summary": "Retrieves a single data sync system by its ID", "tags": ["Data Sync"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "data_sync_system_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteDataSyncSystem"} } } } } }, "put": { "operationId": "DataSyncSystem_Update", "summary": "Updates an existing data sync system entry", "tags": ["Data Sync"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "data_sync_system_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteDataSyncSystem"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/data-syncs/{data_sync_system_id}/failure": { "post": { "operationId": "DataSyncSystem_SaveRunFailure", "summary": "Updates the status for a failed data-sync plug-in", "tags": ["Data Sync"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "data_sync_system_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/data-syncs/{data_sync_system_id}/running": { "post": { "operationId": "DataSyncSystem_SaveRunningState", "summary": "Updates the status for a data-sync plug-in that just started executing to 'Running'", "tags": ["Data Sync"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "data_sync_system_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/data-syncs/{data_sync_system_id}/success": { "post": { "operationId": "DataSyncSystem_SaveRunSuccess", "summary": "Updates the status for a successful data-sync plug-in", "tags": ["Data Sync"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "data_sync_system_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/DateTime"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/data-syncs/{data_sync_system_id}/warning": { "post": { "operationId": "DataSyncSystem_SaveRunWarning", "summary": "Updates the status for a data-sync plug-in that executed with warnings", "tags": ["Data Sync"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "data_sync_system_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/DateTime"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/data-syncs/events": { "post": { "operationId": "DataSyncSystem_WriteEvent", "summary": "Writes an error/warning event entry to the SpiraTeam database log", "tags": ["Data Sync Event"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteEvent"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/data-syncs/extended": { "get": { "operationId": "DataSyncSystem_RetrieveExtended", "summary": "Retrieves a list of data-sync plug-ins including their 25 custom properties", "tags": ["Data Sync"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteDataSyncSystem"} } } } } } } }, "/floating-licenses": { "post": { "operationId": "FloatingLicense_CreateNewSession", "summary": "Creates a new floating license session", "tags": ["Floating Licenses"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteFloatingLicense"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteFloatingLicense"} } } } } } }, "/floating-licenses/{session_id}/engine/{automation_engine_token}/host/{automation_host}": { "put": { "operationId": "FloatingLicense_ExtendSession", "summary": "Extends the current floating license session", "tags": ["Floating Licenses"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "automation_engine_token", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "automation_host", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "expiration_date", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "expiration_date", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteFloatingLicense"} } } } } }, "delete": { "operationId": "FloatingLicense_ReleaseSession", "summary": "Releases the current floating license session for use by another user", "tags": ["Floating Licenses"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "automation_engine_token", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "automation_host", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/Boolean"} } } } } }, "get": { "operationId": "FloatingLicense_GetLicenseInfoBySessionId", "summary": "Retrieves the current floating license session", "tags": ["Floating Licenses"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "automation_engine_token", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "automation_host", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteFloatingLicense"} } } } } } }, "/floating-licenses/engine/{automation_engine_token}": { "get": { "operationId": "FloatingLicense_GetLicenseCounts", "summary": "Gets the count of licenses purchased, available and in use at the present time", "tags": ["Floating Licenses"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "automation_engine_token", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteIntegerSetting"} } } } } } } }, "/graphs/{custom_graph_id}/data": { "get": { "operationId": "Reports_RetrieveCustomGraphData", "summary": "Returns the grid of data from a specific custom graph created by an administrator", "description": "You need to be a system administrator to be able to call this API method\n (for safety since query can be across all artifacts, projects and programs).", "tags": ["Graphs"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "custom_graph_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "project_group_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "project_id", "in": "query", "schema": {"type": "string"} }, { "name": "project_group_id", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTableData"} } } } } } }, "/incidents": { "get": { "operationId": "Incident_RetrieveForOwner", "summary": "Retrieves all incidents owned by the currently authenticated user", "tags": ["Incident"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteIncident"} } } } } } } }, "/messages": { "get": { "operationId": "Message_GetInfo", "summary": "Retrieves the IM status for the current user", "tags": ["Message"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteMessageInfo"} } } } } }, "post": { "operationId": "Message_PostNew", "summary": "Posts a new message to a specific recipient", "tags": ["Message"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteMessageIndividual"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/Int64"} } } } } } }, "/messages/senders": { "get": { "operationId": "Message_GetUnreadMessageSenders", "summary": "Gets the list of users and number of unread messages from them", "tags": ["Message"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteUserMessage"} } } } } } } }, "/messages/senders/{sender_user_id}": { "delete": { "operationId": "Message_MarkAllAsRead", "summary": "Marks all the messages as read for a specific sending user", "tags": ["Message"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "sender_user_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/messages/unread": { "get": { "operationId": "Message_RetrieveUnread", "summary": "Retrieves the list of unread messages", "tags": ["Message"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteMessage"} } } } } } } }, "/program-milestones/statuses": { "get": { "operationId": "ProgramMilestone_RetrieveStatuses", "summary": "Retrieves the statuses for program milestones", "tags": ["Program Milestone Statuses"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteProgramMilestoneStatus"} } } } } } }, "post": { "operationId": "ProgramMilestone_AddStatus", "summary": "Creates a program milestone status", "tags": ["Program Milestone Statuses"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteProgramMilestoneStatus"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteProgramMilestoneStatus"} } } } } }, "put": { "operationId": "ProgramMilestone_UpdateStatus", "summary": "Updates an existing program milestone status", "description": "You cannot make the default status inactive or no longer default - instead you must make a different status default first", "tags": ["Program Milestone Statuses"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteProgramMilestoneStatus"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/program-milestones/statuses/{status_id}": { "get": { "operationId": "ProgramMilestone_RetrieveStatusById", "summary": "Retrieves a specific program milestone status", "tags": ["Program Milestone Statuses"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "status_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteProgramMilestoneStatus"} } } } } } }, "/program-milestones/types": { "get": { "operationId": "ProgramMilestone_RetrieveTypes", "summary": "Retrieves the types for program milestones", "tags": ["Program Milestone Types"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteProgramMilestoneType"} } } } } } }, "post": { "operationId": "ProgramMilestone_AddType", "summary": "Creates a program milestone type", "tags": ["Program Milestone Types"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteProgramMilestoneType"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteProgramMilestoneType"} } } } } }, "put": { "operationId": "ProgramMilestone_UpdateType", "summary": "Updates an existing program milestone type", "description": "You cannot make the default type inactive or no longer default - instead you must make a different type default first", "tags": ["Program Milestone Types"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteProgramMilestoneType"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/program-milestones/types/{type_id}": { "get": { "operationId": "ProgramMilestone_RetrieveTypeById", "summary": "Retrieves a specific program milestone type", "tags": ["Program Milestone Types"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "type_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteProgramMilestoneType"} } } } } } }, "/programs": { "get": { "operationId": "Program_Retrieve", "summary": "Retrieves a particular program by its ID", "tags": ["Programs"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteProgram"} } } } } } } }, "/programs/{program_id}": { "get": { "operationId": "Program_RetrieveById", "summary": "Retrieves a particular program by its ID", "tags": ["Programs"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "program_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteProgram"} } } } } } }, "/programs/{program_id}/capabilities": { "post": { "operationId": "Capability_Create", "summary": "Creates a new program capability", "tags": ["Capabilities"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "program_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteCapability"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteCapability"} } } } } } }, "/programs/{program_id}/capabilities/{capability_id}": { "get": { "operationId": "Capability_RetrieveById", "summary": "Retrieves a single program capability from the program", "tags": ["Capabilities"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "program_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "capability_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteCapability"} } } } } }, "put": { "operationId": "Capability_Update", "summary": "Updates a program capability", "tags": ["Capabilities"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "program_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "capability_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteCapability"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "delete": { "operationId": "Capability_Delete", "summary": "Deletes a capability from a given program", "tags": ["Capabilities"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "program_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "capability_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/programs/{program_id}/capabilities/{capability_id}/children": { "get": { "operationId": "Capability_RetrieveChildren", "summary": "Retrieves all the children capability of a given capabilityId from the program", "tags": ["Capabilities"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "program_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "capability_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteCapability"} } } } } } } }, "/programs/{program_id}/capabilities/{capability_id}/indent": { "put": { "operationId": "Capability_Indent", "summary": "Indents a capability from a given program", "tags": ["Capabilities"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "program_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "capability_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/programs/{program_id}/capabilities/{capability_id}/move/{dest_capability_id}": { "put": { "operationId": "Capability_Move", "summary": "Moves a capability in the hierarchy in a given program", "tags": ["Capabilities"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "program_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "capability_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "dest_capability_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/programs/{program_id}/capabilities/{capability_id}/outdent": { "put": { "operationId": "Capability_Outdent", "summary": "Outdents a capability from a given program", "tags": ["Capabilities"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "program_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "capability_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/programs/{program_id}/capabilities/{capability_id}/requirements": { "get": { "operationId": "Capability_RetrieveRequirementAssociations", "summary": "Retrieves the requirement associations for a given capability", "tags": ["Capability Requirement Association"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "program_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "capability_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteAssociation"} } } } } } }, "post": { "operationId": "Capability_RetrieveFilteredRequirementAssociations", "summary": "Retrieves a paginated list of requirement associations for a given capability", "tags": ["Capability Requirement Association"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "program_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "capability_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "page_size", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "current_page", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "page_size", "in": "query", "schema": {"type": "string"} }, { "name": "current_page", "in": "query", "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteFilter"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteAssociation"} } } } } } } }, "/programs/{program_id}/capabilities/{capability_id}/requirements/{requirement_id}": { "post": { "operationId": "Capability_AddRequirementAssociation", "summary": "Adds a requirement association to a capability", "tags": ["Capability Requirement Association"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "program_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "capability_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "requirement_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "delete": { "operationId": "Capability_RemoveRequirementAssociation", "summary": "Removes a requirement association from a capability", "tags": ["Capability Requirement Association"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "program_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "capability_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "requirement_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/programs/{program_id}/capabilities/{parent_capability_id}": { "post": { "operationId": "Capability_CreateChild", "summary": "Creates a new program capability under the specified parent Capability", "tags": ["Capabilities"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "program_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "parent_capability_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteCapability"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteCapability"} } } } } } }, "/programs/{program_id}/capabilities/search": { "get": { "operationId": "Capability_Retrieve", "summary": "Retrieves a list of capabilities in a given program", "tags": ["Capabilities"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "program_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "current_page", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "page_size", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "current_page", "in": "query", "schema": {"type": "string"} }, { "name": "page_size", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteCapability"} } } } } } }, "post": { "operationId": "Capability_SortedRetrieve", "summary": "Retrieves a sorted list of capabilities in a given program that match the provided filter", "tags": ["Capabilities"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "program_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "starting_row", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_field", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_direction", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "starting_row", "in": "query", "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "query", "schema": {"type": "string"} }, { "name": "sort_field", "in": "query", "schema": {"type": "string"} }, { "name": "sort_direction", "in": "query", "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteFilter"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteCapability"} } } } } } } }, "/programs/{program_id}/milestones": { "get": { "operationId": "ProgramMilestone_Retrieve", "summary": "Retrieves all the milestones within a program", "tags": ["Program Milestones"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "program_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteProgramMilestone"} } } } } } }, "post": { "operationId": "ProgramMilestone_Create", "summary": "Creates a new program milestone", "tags": ["Program Milestones"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "program_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteProgramMilestone"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteProgramMilestone"} } } } } } }, "/programs/{program_id}/milestones/{milestone_id}": { "get": { "operationId": "ProgramMilestone_RetrieveById", "summary": "Retrieves 1 program milestone by ID", "tags": ["Program Milestones"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "program_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "milestone_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteProgramMilestone"} } } } } }, "put": { "operationId": "ProgramMilestone_Update", "summary": "Updates a program milestone", "tags": ["Program Milestones"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "program_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "milestone_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteProgramMilestone"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "delete": { "operationId": "ProgramMilestone_Delete", "summary": "Deletes a milestone from a given program", "tags": ["Program Milestones"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "program_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "milestone_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/programs/{program_id}/milestones/{milestone_id}/releases": { "get": { "operationId": "ProgramMilestone_RetrieveReleaseAssociations", "summary": "Retrieves the release associations for a given milestone", "tags": ["Program Milestone Releases"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "program_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "milestone_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteAssociation"} } } } } } }, "post": { "operationId": "ProgramMilestone_RetrieveFilteredReleaseAssociations", "summary": "Retrieves a paginated list of release associations for a given milestone", "tags": ["Program Milestone Releases"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "program_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "milestone_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "page_size", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "current_page", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "page_size", "in": "query", "schema": {"type": "string"} }, { "name": "current_page", "in": "query", "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteFilter"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteAssociation"} } } } } } } }, "/programs/{program_id}/milestones/{milestone_id}/releases/{release_id}": { "post": { "operationId": "ProgramMilestone_AddReleaseAssociation", "summary": "Adds a release association to a milestone", "tags": ["Program Milestone Releases"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "program_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "milestone_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "delete": { "operationId": "ProgramMilestone_RemoveReleaseAssociation", "summary": "Removes a release association from a milestone", "tags": ["Program Milestone Releases"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "program_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "milestone_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/programs/{program_id}/milestones/search": { "post": { "operationId": "ProgramMilestone_SortedRetrieve", "summary": "Retrieves pages of the milestones within a program", "tags": ["Program Milestones"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "program_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "starting_row", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_field", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_direction", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "starting_row", "in": "query", "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "query", "schema": {"type": "string"} }, { "name": "sort_field", "in": "query", "schema": {"type": "string"} }, { "name": "sort_direction", "in": "query", "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteFilter"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteProgramMilestone"} } } } } } } }, "/project-roles": { "get": { "operationId": "ProjectRole_Retrieve", "summary": "Retrieves a list of project roles in the system", "tags": ["Project Role"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteProjectRole"} } } } } } }, "post": { "operationId": "ProjectRole_Create", "summary": "Allows a user to add a project role to the list of project roles. Only takes into account name, description, admin, active, discussionsAdd, SourceCodeView and permissions.", "tags": ["Project Role"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteProjectRole"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteProjectRole"} } } } } }, "put": { "operationId": "ProjectRole_Update", "summary": "Updates a project role and its permissions", "tags": ["Project Role"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteProjectRole"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/project-roles/{project_role_id}": { "delete": { "operationId": "ProjectRole_Delete", "summary": "Deletes a project role from the system. Fails if the project role is undeletable or currently in use for any user in any product.", "tags": ["Project Role"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_role_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects": { "get": { "operationId": "Project_Retrieve", "summary": "Retrieves a list of projects that the authenticated user has access to.", "tags": ["Project"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteProject"} } } } } } }, "post": { "operationId": "Project_Create", "summary": "Creates a new project in the system and makes the authenticated user owner of it. \"Name\" is the only required field in the body of the request (eg {\"Name\": \"New Project\"})", "tags": ["Project"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "existing_project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "existing_project_id", "in": "query", "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteProject"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteProject"} } } } } } }, "/projects/{project_id}": { "get": { "operationId": "Project_RetrieveById", "summary": "Retrieves a single project in the system", "tags": ["Project"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteProject"} } } } } }, "delete": { "operationId": "Project_Delete", "summary": "Deletes an existing project in the system", "tags": ["Project"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "put": { "operationId": "Project_Update", "summary": "Updates an existing project", "tags": ["Project"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteProject"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/artifact-types/{artifact_type_id}/artifacts/{artifact_id}/documents": { "get": { "operationId": "Document_RetrieveForArtifact1", "summary": "Retrieves the list of documents/attachments in a project attached to a specific artifact", "tags": ["Artifact Documents"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "artifact_type_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "artifact_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteDocument"} } } } } } } }, "/projects/{project_id}/artifact-types/{artifact_type_id}/artifacts/{artifact_id}/documents/{document_id}": { "post": { "operationId": "Document_AddToArtifactId", "summary": "Adds an existing attachment to the specified artifact.", "tags": ["Artifact Documents"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "artifact_type_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "artifact_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "document_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "delete": { "operationId": "Document_DeleteFromArtifact", "summary": "Deletes an attachment from an artifact. The attachment will still remain in the project", "tags": ["Artifact Documents"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "artifact_type_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "artifact_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "document_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/artifact-types/{artifact_type_id}/artifacts/{artifact_id}/documents/search": { "post": { "operationId": "Document_RetrieveForArtifact2", "summary": "Retrieves the list of documents/attachments in a project attached to a specific artifact", "tags": ["Artifact Document"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "artifact_type_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "artifact_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_by", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_by", "in": "query", "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteFilter"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteDocument"} } } } } } } }, "/projects/{project_id}/artifact-types/{artifact_type_id}/artifacts/{artifact_id}/history": { "get": { "operationId": "History_RetrieveForArtifact1", "summary": "Retrieves the history of changes for a specific artifact", "description": "Includes the field-level details of each change", "tags": ["History"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "artifact_type_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "artifact_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "start_row", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "number_rows", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_property", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_direction", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "start_row", "in": "query", "schema": {"type": "string"} }, { "name": "number_rows", "in": "query", "schema": {"type": "string"} }, { "name": "sort_property", "in": "query", "schema": {"type": "string"} }, { "name": "sort_direction", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteHistoryChange"} } } } } } }, "post": { "operationId": "History_RetrieveForArtifact2", "summary": "Retrieves the history of changes for a specific artifact", "description": "Includes the field-level details of each change", "tags": ["History"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "artifact_type_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "artifact_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "start_row", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "number_rows", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_property", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_direction", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "start_row", "in": "query", "schema": {"type": "string"} }, { "name": "number_rows", "in": "query", "schema": {"type": "string"} }, { "name": "sort_property", "in": "query", "schema": {"type": "string"} }, { "name": "sort_direction", "in": "query", "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteFilter"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteHistoryChange"} } } } } } } }, "/projects/{project_id}/artifact-types/{artifact_type_id}/artifacts/{artifact_id}/subscriptions": { "post": { "operationId": "Subscription_SubscribeToArtifact", "summary": "Subscribes to a specified artifact", "tags": ["Subscriptions"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "artifact_type_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "artifact_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "delete": { "operationId": "Subscription_UnsubscribeFromArtifact", "summary": "Unsubscribes from a specified artifact", "tags": ["Subscriptions"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "artifact_type_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "artifact_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "get": { "operationId": "Subscription_RetrieveForArtifact", "summary": "Retrieves a list of all the users subscribed to an artifact", "tags": ["Subscriptions"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "artifact_type_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "artifact_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteArtifactSubscription"} } } } } } } }, "/projects/{project_id}/associations": { "post": { "operationId": "Association_Create", "summary": "Adds a new association in the system", "tags": ["Association"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteAssociation"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteAssociation"} } } } } }, "put": { "operationId": "Association_Update", "summary": "Updates the specified Association's information", "description": "Currently only the comment field is updated", "tags": ["Association"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteAssociation"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/associations/{artifact_link_id}": { "delete": { "operationId": "Association_Delete", "summary": "Deletes an association between two artifacts", "description": "Requires modify permissions for the source artifact. Only positive link ids can be deleted (negative numbers are managed by the system)", "tags": ["Association"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "artifact_link_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/associations/{artifact_type_id}/{artifact_id}": { "get": { "operationId": "Association_RetrieveForArtifact1", "summary": "Retrieves a set of associations to the specified artifact", "description": "The source artifact type and id will be the same as the ones passed in", "tags": ["Association"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "artifact_type_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "artifact_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteAssociation"} } } } } } } }, "/projects/{project_id}/associations/{artifact_type_id}/{artifact_id}/search": { "post": { "operationId": "Association_RetrieveForArtifact2", "summary": "Retrieves a set of associations to the specified artifact", "description": "The source artifact type and id will be the same as the ones passed in", "tags": ["Association"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "artifact_type_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "artifact_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_by", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_by", "in": "query", "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteFilter"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteAssociation"} } } } } } } }, "/projects/{project_id}/automation-hosts": { "get": { "operationId": "AutomationHost_Retrieve1", "summary": "Retrieves the list of all the automation hosts in the current project", "tags": ["Automation Host"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteAutomationHost"} } } } } } }, "post": { "operationId": "AutomationHost_Create", "summary": "Creates a new automation host in the system", "tags": ["Automation Host"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteAutomationHost"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteAutomationHost"} } } } } }, "put": { "operationId": "AutomationHost_Update", "summary": "Updates an automation host in the system", "tags": ["Automation Host"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteAutomationHost"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/automation-hosts/{automation_host_id}": { "get": { "operationId": "AutomationHost_RetrieveById", "summary": "Retrieves a single automation host by its id", "tags": ["Automation Host"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "automation_host_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteAutomationHost"} } } } } }, "delete": { "operationId": "AutomationHost_Delete", "summary": "Deletes a automation host in the system", "tags": ["Automation Host"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "automation_host_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/automation-hosts/search": { "post": { "operationId": "AutomationHost_Retrieve2", "summary": "Retrieves the list of automation hosts in the current project", "tags": ["Automation Host"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "starting_row", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_field", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_direction", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "starting_row", "in": "query", "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "query", "schema": {"type": "string"} }, { "name": "sort_field", "in": "query", "schema": {"type": "string"} }, { "name": "sort_direction", "in": "query", "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteFilter"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteAutomationHost"} } } } } } } }, "/projects/{project_id}/automation-hosts/tokens/{token}": { "get": { "operationId": "AutomationHost_RetrieveByToken", "summary": "Retrieves a single automation host by its token name", "description": "Token names are only unique within a project", "tags": ["Automation Host"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "token", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteAutomationHost"} } } } } } }, "/projects/{project_id}/components": { "get": { "operationId": "Component_Retrieve", "summary": "Retrieves a list of all the components in the current project", "tags": ["Component"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "active_only", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "include_deleted", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "active_only", "in": "query", "schema": {"type": "string"} }, { "name": "include_deleted", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteComponent"} } } } } } }, "post": { "operationId": "Component_Create", "summary": "Creates a new component in the current project", "tags": ["Component"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteComponent"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteComponent"} } } } } } }, "/projects/{project_id}/components/{component_id}": { "get": { "operationId": "Component_RetrieveById", "summary": "Retrieves a single component by its ID", "tags": ["Component"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "component_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteComponent"} } } } } }, "put": { "operationId": "Component_Update", "summary": "Updates an existing component in the current project", "tags": ["Component"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "component_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteComponent"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "delete": { "operationId": "Component_Delete", "summary": "Deletes a component in the current project", "tags": ["Component"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "component_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/components/{component_id}/undelete": { "post": { "operationId": "Component_Undelete", "summary": "Undeletes a component in the current project", "tags": ["Component"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "component_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/data-mappings/{data_sync_system_id}/artifacts/{artifact_type_id}": { "get": { "operationId": "DataMapping_RetrieveArtifactMappings", "summary": "Retrieves a list of data mappings for artifact ids in the system", "tags": ["Data Mapping Artifacts"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "data_sync_system_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "artifact_type_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteDataMapping"} } } } } } }, "post": { "operationId": "DataMapping_AddArtifactMappings", "summary": "Adds new artifact data mapping entries", "tags": ["Data Mapping Artifacts"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "data_sync_system_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "artifact_type_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteDataMapping"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "delete": { "operationId": "DataMapping_RemoveArtifactMappings", "summary": "Removes existing artifact data mapping entries", "tags": ["Data Mapping Artifacts"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "data_sync_system_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "artifact_type_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteDataMapping"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/data-mappings/{data_sync_system_id}/artifacts/{artifact_type_id}/custom-properties/{custom_property_id}": { "get": { "operationId": "DataMapping_RetrieveCustomPropertyMapping", "summary": "Retrieves the data mapping for a custom property", "tags": ["Data Mapping Custom Properties"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "data_sync_system_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "artifact_type_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "custom_property_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteDataMapping"} } } } } } }, "/projects/{project_id}/data-mappings/{data_sync_system_id}/artifacts/{artifact_type_id}/custom-properties/{custom_property_id}/values": { "get": { "operationId": "DataMapping_RetrieveCustomPropertyValueMappings", "summary": "Retrieves a list of data mappings for custom property values", "tags": ["Data Mapping Custom Property Values"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "data_sync_system_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "artifact_type_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "custom_property_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteDataMapping"} } } } } } } }, "/projects/{project_id}/data-mappings/{data_sync_system_id}/field-values/{artifact_field_id}": { "get": { "operationId": "DataMapping_RetrieveFieldValueMappings", "summary": "Retrieves a list of data mappings for artifact field values", "tags": ["Data Mapping Field Values"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "data_sync_system_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "artifact_field_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteDataMapping"} } } } } } } }, "/projects/{project_id}/document-folders": { "get": { "operationId": "Document_RetrieveFolders", "summary": "Retrieves a list of all the document folders in the current project", "tags": ["Document Folder"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteDocumentFolder"} } } } } } }, "post": { "operationId": "Document_AddFolder", "summary": "Adds a new document folder into the current project", "tags": ["Document Folder"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteDocumentFolder"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteDocumentFolder"} } } } } } }, "/projects/{project_id}/document-folders/{folder_id}": { "get": { "operationId": "Document_RetrieveFolderById", "summary": "Retrieves the folder by the specified ID.", "tags": ["Document Folder"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "folder_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteDocumentFolder"} } } } } }, "delete": { "operationId": "Document_DeleteFolder", "summary": "Deletes an existing document folder from the current project", "description": "This will delete all child folders and documents/attachements", "tags": ["Document Folder"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "folder_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "put": { "operationId": "Document_UpdateFolder", "summary": "Updates the name and position of an existing folder in the project", "tags": ["Document Folder"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "folder_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteDocumentFolder"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/document-folders/{folder_id}/documents/search": { "post": { "operationId": "Document_RetrieveForFolder", "summary": "Retrieves a filtered list of documents/attachments in a project for the specified folder", "tags": ["Document"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "folder_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "start_row", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "number_rows", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_by", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "start_row", "in": "query", "schema": {"type": "string"} }, { "name": "number_rows", "in": "query", "schema": {"type": "string"} }, { "name": "sort_by", "in": "query", "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteFilter"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteDocument"} } } } } } } }, "/projects/{project_id}/document-folders/children": { "get": { "operationId": "Document_RetrieveFoldersByParentFolderId", "summary": "Retrieves a list of all the document folders directly under the specified parent folder", "tags": ["Document Folder"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "parent_folder_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "parent_folder_id", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteDocumentFolder"} } } } } } } }, "/projects/{project_id}/documents": { "put": { "operationId": "Document_Update", "summary": "Updates information about a document (version information is not updated)", "description": "Only fields like status, owner, description, and custom properties are updated. This update method does not update version information (no versions are added, removed, or changed). Modify all or bulk edit document permissions required.", "tags": ["Document"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteDocument"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "get": { "operationId": "Document_Retrieve1", "summary": "Retrieves a list of all the documents/attachments in a project across all folders", "tags": ["Document"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteDocument"} } } } } } } }, "/projects/{project_id}/documents/{document_id}": { "get": { "operationId": "Document_RetrieveById", "summary": "Retrieves a single project document by its id", "description": "1) For files it does not include the raw file data, you need to use Document_OpenById\n 2) It also retrieves the list of document versions", "tags": ["Document"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "document_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteDocument"} } } } } }, "delete": { "operationId": "Document_Delete", "summary": "Deletes an attachment from the project completely", "tags": ["Document"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "document_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/documents/{document_id}/open": { "get": { "operationId": "Document_OpenFile", "summary": "Returns the actual binary content of a file attachment in the system", "tags": ["Document"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "document_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/Byte"} } } } } } } }, "/projects/{project_id}/documents/{document_id}/versions/file": { "post": { "operationId": "Document_AddFileVersion", "summary": "Adds a new version to a file attachment in the system", "tags": ["Document Version"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "document_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "make_current", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "make_current", "in": "query", "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteDocumentVersionFile"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteDocumentVersion"} } } } } } }, "/projects/{project_id}/documents/{document_id}/versions/url": { "post": { "operationId": "Document_AddUrlVersion", "summary": "Adds a new version to a URL attachment in the system", "tags": ["Document Version"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "document_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "make_current", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "make_current", "in": "query", "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteDocumentVersion"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteDocumentVersion"} } } } } } }, "/projects/{project_id}/documents/file": { "post": { "operationId": "Document_AddFile", "summary": "Adds a new document (file) into the system and associates it with the provided artifact (optional)\n and project folder/type (optional)", "tags": ["Document"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteDocumentFile"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteDocument"} } } } } } }, "/projects/{project_id}/documents/search": { "post": { "operationId": "Document_Retrieve2", "summary": "Retrieves a filtered list of documents/attachments in a project across all folders", "tags": ["Document"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "start_row", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "number_rows", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_by", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "start_row", "in": "query", "schema": {"type": "string"} }, { "name": "number_rows", "in": "query", "schema": {"type": "string"} }, { "name": "sort_by", "in": "query", "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteFilter"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteDocument"} } } } } } } }, "/projects/{project_id}/documents/types/{document_type_id}/workflow/transitions": { "get": { "operationId": "Document_RetrieveWorkflowTransitionsForUser", "summary": "Will retrieve available transitions for the specied status ID for the currently logged-on user.", "tags": ["Document Type"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "document_type_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "document_status_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "is_creator", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "is_owner", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "is_creator", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowTransition"} } } } } } } }, "/projects/{project_id}/documents/url": { "post": { "operationId": "Document_AddUrl", "summary": "Adds a new document (url) into the system and associates it with the provided artifact (optional)\n and project folder/type (optional)", "tags": ["Document"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteDocument"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteDocument"} } } } } } }, "/projects/{project_id}/documents/versions/{attachment_version_id}": { "delete": { "operationId": "Document_DeleteVersion", "summary": "Deletes an attachment version from the project completely", "description": "To delete a version you must have modify permissions for documents. You can't delete the current version.", "tags": ["Document Version"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "attachment_version_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/documents/versions/{attachment_version_id}/open": { "get": { "operationId": "Document_OpenVersion", "summary": "Returns the actual binary content of a specific version of an attachment in the system", "tags": ["Document Version"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "attachment_version_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/Byte"} } } } } } } }, "/projects/{project_id}/history/{history_change_set_id}": { "get": { "operationId": "History_RetrieveById", "summary": "Retrieves the details of a specific change made", "description": "Includes the field-level details of each change", "tags": ["History"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "history_change_set_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteHistoryChangeSet"} } } } } } }, "/projects/{project_id}/incidents": { "get": { "operationId": "Incident_Retrieve1", "summary": "Retrieves the list of incidents in the project, ordered by the most recent. Only returns the first 500 results", "tags": ["Incident"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteIncident"} } } } } } }, "post": { "operationId": "Incident_Create", "summary": "Creates a new incident in the specified project in the system", "tags": ["Incident"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteIncident"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteIncident"} } } } } } }, "/projects/{project_id}/incidents/{incident_id}": { "get": { "operationId": "Incident_RetrieveById", "summary": "Retrieves a single incident in the system", "tags": ["Incident"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "incident_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteIncident"} } } } } }, "put": { "operationId": "Incident_Update", "summary": "Updates an incident already present in the system.", "tags": ["Incident"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "incident_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteIncident"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "delete": { "operationId": "Incident_Delete", "summary": "Deletes an incident in a specific project in the system", "tags": ["Incident"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "incident_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/incidents/{incident_id}/comments": { "get": { "operationId": "Incident_RetrieveComments", "summary": "Retrieves a list of comments that belong to the specified incident", "tags": ["Incident Comment"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "incident_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteComment"} } } } } } }, "post": { "operationId": "Incident_AddComments", "summary": "Adds new incident comments to an incident in a project in the system", "tags": ["Incident Comment"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "incident_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteComment"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteComment"} } } } } } } }, "/projects/{project_id}/incidents/{incident_id}/fixed/{fixed_build_id}": { "put": { "operationId": "Incident_UpdateResolvedBuild", "summary": "Updates the field 'ResolvedBuild' of a given incident (already present in the system)", "tags": ["Incident"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "incident_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "fixed_build_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/incidents/count": { "get": { "operationId": "Incident_Count", "summary": "Returns the count of the number of incidents in the project", "tags": ["Incident"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/Int64"} } } } } } }, "/projects/{project_id}/incidents/recent": { "get": { "operationId": "Incident_RetrieveNew", "summary": "Retrieves all new incidents added in the system since the date specified", "tags": ["Incident"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "start_row", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "number_rows", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "creation_date", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "start_row", "in": "query", "schema": {"type": "string"} }, { "name": "number_rows", "in": "query", "schema": {"type": "string"} }, { "name": "creation_date", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteIncident"} } } } } } } }, "/projects/{project_id}/incidents/search": { "get": { "operationId": "Incident_Retrieve2", "summary": "Retrieves the list of incidents in the project. This operation allows you to specify the sort column and the pagination range", "tags": ["Incident"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "start_row", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "number_rows", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_by", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "start_row", "in": "query", "schema": {"type": "string"} }, { "name": "number_rows", "in": "query", "schema": {"type": "string"} }, { "name": "sort_by", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteIncident"} } } } } } }, "post": { "operationId": "Incident_Retrieve3", "summary": "Searches the list of incidents in the project. This operation allows you to specify a list of filters, the sort column (optional) and the pagination range", "tags": ["Incident"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "start_row", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "number_rows", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_by", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "start_row", "in": "query", "schema": {"type": "string"} }, { "name": "number_rows", "in": "query", "schema": {"type": "string"} }, { "name": "sort_by", "in": "query", "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteFilter"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteIncident"} } } } } } } }, "/projects/{project_id}/incidents/search-by-ids": { "get": { "operationId": "Incident_RetrieveByIdList", "summary": "Retrieves a list of incidents that match the comma-separated list of ids", "tags": ["Incident"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "incident_ids", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteIncident"} } } } } } } }, "/projects/{project_id}/incidents/search-by-test-case/{test_case_id}": { "get": { "operationId": "Incident_RetrieveByTestCase", "summary": "Retrieves a list of incidents in the system that are linked to a specific test case\n (either through test runs or test steps)", "tags": ["Incident"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_case_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "open_only", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "open_only", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteIncident"} } } } } } } }, "/projects/{project_id}/incidents/search-by-test-run-step/{test_run_step_id}": { "get": { "operationId": "Incident_RetrieveByTestRunStep", "summary": "Retrieves a list of incidents in the system that are linked to a specific test run step", "tags": ["Incident"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_run_step_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteIncident"} } } } } } } }, "/projects/{project_id}/incidents/search-by-test-step/{test_step_id}": { "get": { "operationId": "Incident_RetrieveByTestStep", "summary": "Retrieves a list of incidents in the system that are linked to a specific test step\n (either directly or indirectly through test runs)", "tags": ["Incident"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_step_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteIncident"} } } } } } } }, "/projects/{project_id}/incidents/types/{incident_type_id}/workflow/transitions": { "get": { "operationId": "Incident_RetrieveWorkflowTransitionsForUser", "summary": "Will retrieve available transitions for the specied status ID for the currently logged-on user.", "tags": ["Incident Type"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "incident_type_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "incident_status_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "is_creator", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "is_owner", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "is_creator", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowTransition"} } } } } } } }, "/projects/{project_id}/inflectra-ai": { "put": { "operationId": "InflectraAi_UpdateForProject", "summary": "Updates the Inflectra.ai enabled status for a specific project", "tags": ["Inflectra.ai Admin"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "enabled", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "enabled", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/pull-requests": { "get": { "operationId": "PullRequest_Retrieve", "summary": "Retrieves all pull requests from a certain project", "tags": ["Pull Request"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "start_row", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "start_row", "in": "query", "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemotePullRequest"} } } } } } }, "post": { "operationId": "PullRequest_Create", "summary": "Creates a pull request using the source and dest branch names. If the name of the pull request is left blank it will be populated with the default PR naming scheme.", "tags": ["Pull Request"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemotePullRequest"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemotePullRequest"} } } } } }, "put": { "operationId": "PullRequest_Update", "summary": "Updates a pull request in the system. Pull request branches cannot be changed after pull request creation.", "tags": ["Pull Request"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemotePullRequest"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/pull-requests/{pull_request_id}": { "get": { "operationId": "PullRequest_RetrieveById", "summary": "Retrieves a pull request by its Id (TaskId)", "tags": ["Pull Request"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "pull_request_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemotePullRequest"} } } } } }, "delete": { "operationId": "PullRequest_Delete", "summary": "Deletes a pull request from the internal system", "tags": ["Pull Request"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "pull_request_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/refresh-caches": { "post": { "operationId": "Project_RefreshProgressExecutionStatusCaches1", "summary": "Refreshes the task progress and test execution status for a project.\n Typically this needs to be called after TestRun_RecordAutomated3(...) API calls\n to ensure the data in the system is consistent", "tags": ["Project"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "run_async", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "run_async", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/refresh-caches/{release_id}": { "post": { "operationId": "Project_RefreshProgressExecutionStatusCaches2", "summary": "Refreshes the task progress and test execution status for a project.\n Typically this needs to be called after TestRun_RecordAutomated3(...) API calls\n to ensure the data in the system is consistent", "tags": ["Project"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "run_async", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "run_async", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/releases": { "get": { "operationId": "Release_Retrieve1", "summary": "Retrieves all the releases belonging to the current project", "description": "Does not include iterations", "tags": ["Release"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "active_only", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "active_only", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteRelease"} } } } } } }, "post": { "operationId": "Release_Create1", "summary": "Creates a new release in the system at the root level", "tags": ["Release"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteRelease"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteRelease"} } } } } }, "put": { "operationId": "Release_Update", "summary": "Updates a release in the system", "tags": ["Release"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteRelease"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/releases/{parent_release_id}": { "post": { "operationId": "Release_Create2", "summary": "Creates a new release in the system under a specified parent release", "tags": ["Release"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "parent_release_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteRelease"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteRelease"} } } } } } }, "/projects/{project_id}/releases/{release_id}": { "get": { "operationId": "Release_RetrieveById", "summary": "Retrieves a single release in the system", "tags": ["Release"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteRelease"} } } } } }, "delete": { "operationId": "Release_Delete", "summary": "Deletes a release in the system", "tags": ["Release"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/releases/{release_id}/builds": { "get": { "operationId": "Build_RetrieveByReleaseId1", "summary": "Retrieves the list of builds that are associated with a specific Release", "tags": ["Release Build"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteBuild"} } } } } } }, "post": { "operationId": "Build_Create", "summary": "Creates a new build in the system, including any linked source code revisions", "tags": ["Release Build"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteBuild"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteBuild"} } } } } }, "delete": { "operationId": "Build_DeleteForRelease", "summary": "Deletes all builds on a release", "tags": ["Release Build"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/releases/{release_id}/builds/{build_id}": { "get": { "operationId": "Build_RetrieveById", "summary": "Retrieves the a single build (and associated source code revisions) by its id", "tags": ["Release Build"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "build_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteBuild"} } } } } } }, "/projects/{project_id}/releases/{release_id}/builds/{build_id}/no_description": { "get": { "operationId": "Build_RetrieveById_NoDescription", "summary": "Retrieves the a single build (and associated source code revisions) by its id, without including the build description field", "tags": ["Release Build"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "build_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteBuild"} } } } } } }, "/projects/{project_id}/releases/{release_id}/builds/no_description": { "get": { "operationId": "Build_RetrieveByReleaseId_NoDescription", "summary": "Retrieves the list of builds that are associated with a specific Release, without including the build description fields", "tags": ["Release Build"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteBuild"} } } } } } } }, "/projects/{project_id}/releases/{release_id}/builds/search": { "post": { "operationId": "Build_RetrieveByReleaseIdSearch", "summary": "Retrieves the list of builds that are associated with a specific Release", "tags": ["Release Build"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "starting_row", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_by", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "starting_row", "in": "query", "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "query", "schema": {"type": "string"} }, { "name": "sort_by", "in": "query", "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteFilter"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteBuild"} } } } } } } }, "/projects/{project_id}/releases/{release_id}/children": { "get": { "operationId": "Release_RetrieveChildren", "summary": "Retrieves children of a provided release", "tags": ["Release"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteRelease"} } } } } } } }, "/projects/{project_id}/releases/{release_id}/comments": { "get": { "operationId": "Release_RetrieveComments", "summary": "Retrieves comments for a specified release.", "tags": ["Release Comments"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteComment"} } } } } } }, "post": { "operationId": "Release_CreateComment", "summary": "Creates a new comment for a release.", "tags": ["Release Comments"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteComment"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteComment"} } } } } } }, "/projects/{project_id}/releases/{release_id}/indent": { "post": { "operationId": "Release_Indent", "summary": "Indents a release one position", "tags": ["Release"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/releases/{release_id}/move": { "post": { "operationId": "Release_Move", "summary": "Moves a release to another location in the hierarchy", "tags": ["Release"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "destination_release_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "query", "schema": {"type": "string"} }, { "name": "destination_release_id", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/releases/{release_id}/outdent": { "post": { "operationId": "Release_Outdent", "summary": "Outdents a release one position", "tags": ["Release"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/releases/{release_id}/test-cases": { "post": { "operationId": "Release_AddTestMapping", "summary": "Maps a release to a test case, so that the test case is needs to be tested for that release", "description": "Pass in an array of test case ids into the body of the call. If the mapping record already exists no error is raised", "tags": ["Release Test Cases"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/Int32"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "get": { "operationId": "Release_RetrieveTestMapping", "summary": "Retrieves the mapped test cases for a specific release", "tags": ["Release Test Cases"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteReleaseTestCaseMapping"} } } } } } } }, "/projects/{project_id}/releases/{release_id}/test-cases/{test_case_id}": { "delete": { "operationId": "Release_RemoveTestMapping", "summary": "Removes a mapping entry for a specific release and test case", "tags": ["Release Test Cases"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_case_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/releases/count": { "post": { "operationId": "Release_Count", "summary": "Returns the number of releases that match the filter.", "tags": ["Release"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteFilter"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/Int64"} } } } } } }, "/projects/{project_id}/releases/search": { "post": { "operationId": "Release_Retrieve2", "summary": "Retrieves a list of releases in the system that match the provided filter", "tags": ["Release"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "start_row", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "number_rows", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "start_row", "in": "query", "schema": {"type": "string"} }, { "name": "number_rows", "in": "query", "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteFilter"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteRelease"} } } } } } } }, "/projects/{project_id}/releases/types/{Release_type_id}/workflow/transitions": { "get": { "operationId": "Release_RetrieveWorkflowTransitionsForUser", "summary": "Will retrieve available transitions for the specied status ID for the currently logged-on user.", "tags": ["Release Type"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "Release_type_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "Release_status_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "is_creator", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "is_owner", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "is_creator", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowTransition"} } } } } } } }, "/projects/{project_id}/reports/generated": { "get": { "operationId": "Reports_CheckGeneratedReportStatus", "summary": "Checks on the status of the generation of a specific user's saved report (step 3 in getting the output of a report)", "description": "Returns: -1 if the report was not found, 0 if the generation is in progress, an int with the ID of the completed report. This API call is currently limited to system administrators because of the potential performance impact of running large reports", "tags": ["Reports: Generated"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "report_generation_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "report_generation_id", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/Int32"} } } } } } }, "/projects/{project_id}/reports/generated/{generated_report_id}": { "get": { "operationId": "Reports_RetrieveGeneratedReport", "summary": "Retrieves the contents of the generated report (step 4 in getting the output of a report)", "description": "This returns the report contents in binary form. This API call is currently limited to system administrators because of the potential performance impact of running large reports", "tags": ["Reports: Generated"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "generated_report_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/Byte"} } } } } } } }, "/projects/{project_id}/reports/saved": { "get": { "operationId": "Reports_RetrieveSaved", "summary": "Retrieves the list of saved reports for a specific user (step 1 in getting the output of a report)", "description": "Only reports saved by a user are returned - in other words, standard reports cannot be generated via the API", "tags": ["Reports: Saved"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "include_shared", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "include_shared", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteSavedReport"} } } } } } } }, "/projects/{project_id}/reports/saved/{saved_report_id}/generate": { "post": { "operationId": "Reports_GenerateSavedReport", "summary": "Starts the generation of a specific user's saved report (step 2 in getting the output of a report)", "description": "This call returns the GUID of the report generation id (used to check status and retrieve it). This API call is currently limited to system administrators because of the potential performance impact of running large reports.", "tags": ["Reports: Saved"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "saved_report_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/String"} } } } } } }, "/projects/{project_id}/requirements": { "post": { "operationId": "Requirement_Create1", "summary": "Creates a new requirement record in the current project at the end of the list the user has access to. \n Note: the indent level is set at the same as the last one in the list the user has access to", "description": "Name and RequirementTypeId are the only non-optional fields. Do not include the RequirementId field.", "tags": ["Requirement"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteRequirement"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteRequirement"} } } } } }, "get": { "operationId": "Requirement_Retrieve2", "summary": "Retrieves a list of requirements in the system", "tags": ["Requirement"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "starting_row", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "starting_row", "in": "query", "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteRequirement"} } } } } } }, "put": { "operationId": "Requirement_Update", "summary": "Updates a requirement in the system", "tags": ["Requirement"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteRequirement"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/requirements/{requirement_id}": { "get": { "operationId": "Requirement_RetrieveById", "summary": "Retrieves a single requirement in the system", "description": "Includes any steps", "tags": ["Requirement"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "requirement_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteRequirement"} } } } } }, "delete": { "operationId": "Requirement_Delete", "summary": "Deletes a requirement in the system", "tags": ["Requirement"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "requirement_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/requirements/{requirement_id}/children": { "get": { "operationId": "Requirement_RetrieveChildren", "summary": "Retrieves children requirements of a requirement", "tags": ["Requirement"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "requirement_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteRequirement"} } } } } } } }, "/projects/{project_id}/requirements/{requirement_id}/comments": { "get": { "operationId": "Requirement_RetrieveComments", "summary": "Retrieves comments for a specified requirement.", "tags": ["Requirement Comment"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "requirement_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteComment"} } } } } } }, "post": { "operationId": "Requirement_CreateComment", "summary": "Creates a new comment for a requirement.", "tags": ["Requirement Comment"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "requirement_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteComment"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteComment"} } } } } } }, "/projects/{project_id}/requirements/{requirement_id}/indent": { "post": { "operationId": "Requirement_Indent", "summary": "Indents a requirement one position", "tags": ["Requirement"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "requirement_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/requirements/{requirement_id}/move": { "post": { "operationId": "Requirement_Move", "summary": "Moves a requirement to another location in the hierarchy", "tags": ["Requirement"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "requirement_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "destination_requirement_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "requirement_id", "in": "query", "schema": {"type": "string"} }, { "name": "destination_requirement_id", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/requirements/{requirement_id}/outdent": { "post": { "operationId": "Requirement_Outdent", "summary": "Outdents a requirement one position", "tags": ["Requirement"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "requirement_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/requirements/{requirement_id}/parents": { "get": { "operationId": "Requirement_RetrieveParents", "summary": "Retrieves the parent requirements of a requirement", "tags": ["Requirement"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "requirement_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteRequirement"} } } } } } } }, "/projects/{project_id}/requirements/{requirement_id}/steps": { "get": { "operationId": "Requirement_RetrieveSteps", "summary": "Retrieves a list of requirement steps", "tags": ["Requirement Step"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "requirement_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteRequirementStep"} } } } } } }, "post": { "operationId": "Requirement_AddStep", "summary": "Adds a requirement step to a requirement", "tags": ["Requirement Step"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "requirement_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "existing_requirement_step_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "creator_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "existing_requirement_step_id", "in": "query", "schema": {"type": "string"} }, { "name": "creator_id", "in": "query", "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteRequirementStep"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteRequirementStep"} } } } } }, "put": { "operationId": "Requirement_UpdateStep", "summary": "Updates an existing requirement step", "tags": ["Requirement Step"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "requirement_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteRequirementStep"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/requirements/{requirement_id}/steps/{requirement_step_id}": { "get": { "operationId": "Requirement_RetrieveStepById", "summary": "Retrieves a single requirement step by its ID", "tags": ["Requirement Step"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "requirement_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "requirement_step_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteRequirementStep"} } } } } }, "delete": { "operationId": "Requirement_DeleteStep", "summary": "Deletes a requirement step in the list", "tags": ["Requirement Step"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "requirement_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "requirement_step_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/requirements/{requirement_id}/steps/{source_requirement_step_id}/move": { "post": { "operationId": "Requirement_MoveStep", "summary": "Moves a requirement step in the list", "tags": ["Requirement Step"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "requirement_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "source_requirement_step_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "destination_requirement_step_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "destination_requirement_step_id", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/requirements/{requirement_id}/test-cases": { "get": { "operationId": "Requirement_RetrieveTestCoverage", "summary": "Retrieves the test coverage for a specific requirement", "tags": ["Requirement Test Coverage"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "requirement_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteRequirementTestCaseMapping"} } } } } } } }, "/projects/{project_id}/requirements/{requirement_id}/test-steps": { "get": { "operationId": "Requirement_RetrieveTestStepCoverage", "summary": "Retrieves the list of test steps associated with a requirement", "tags": ["Requirement Test Step Coverage"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "requirement_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteRequirementTestStepMapping"} } } } } } } }, "/projects/{project_id}/requirements/count": { "get": { "operationId": "Requirement_Count1", "summary": "Returns the number of requirements that match the filter.", "tags": ["Requirement"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/Int64"} } } } } }, "post": { "operationId": "Requirement_Count2", "summary": "Returns the number of requirements that match the filter.", "tags": ["Requirement"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "own_parents_only", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "own_parents_only", "in": "query", "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteFilter"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/Int64"} } } } } } }, "/projects/{project_id}/requirements/indent/{indent_position}": { "post": { "operationId": "Requirement_Create2", "summary": "Creates a new requirement record in the current project using the position offset method. In the body, the only required field is Name.", "description": "Use this call when you want to specify the relative indentation level", "tags": ["Requirement"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "indent_position", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteRequirement"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteRequirement"} } } } } } }, "/projects/{project_id}/requirements/parent/{parent_requirement_id}": { "post": { "operationId": "Requirement_Create3", "summary": "Creates a new requirement in the system. The only required field is Name.", "description": "This version is use when you want to specify the location by parent requirement", "tags": ["Requirement"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "parent_requirement_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteRequirement"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteRequirement"} } } } } } }, "/projects/{project_id}/requirements/search": { "post": { "operationId": "Requirement_Retrieve1", "summary": "Retrieves a list of requirements in the system that match the provided filter", "tags": ["Requirement"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "starting_row", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "starting_row", "in": "query", "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "query", "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteFilter"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteRequirement"} } } } } } } }, "/projects/{project_id}/requirements/test-cases": { "post": { "operationId": "Requirement_AddTestCoverage", "summary": "Maps a requirement to a test case, so that the test case 'covers' the requirement", "description": "If the coverage record already exists no error is raised", "tags": ["Requirement Test Coverage"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteRequirementTestCaseMapping"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "delete": { "operationId": "Requirement_RemoveTestCoverage", "summary": "Removes a coverage mapping entry for a specific requirement and test case", "tags": ["Requirement Test Coverage"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteRequirementTestCaseMapping"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/requirements/test-steps": { "post": { "operationId": "Requirement_AddTestStepCoverage", "summary": "Adds a test step to a requirement", "tags": ["Requirement Test Step Coverage"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteRequirementTestStepMapping"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "delete": { "operationId": "Requirement_RemoveTestStepCoverage", "summary": "Removes a test step from a requirement", "tags": ["Requirement Test Step Coverage"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteRequirementTestStepMapping"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/requirements/types/{requirement_type_id}/workflow/transitions": { "get": { "operationId": "Requirement_RetrieveWorkflowTransitionsForUser", "summary": "Will retrieve available transitions for the specied status ID for the currently logged-on user.", "tags": ["Requirement Type"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "requirement_type_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "requirement_status_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "is_creator", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "is_owner", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "is_creator", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowTransition"} } } } } } } }, "/projects/{project_id}/risks": { "post": { "operationId": "Risk_Create", "summary": "Creates a new risk in the system", "tags": ["Risk"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteRisk"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteRisk"} } } } } }, "put": { "operationId": "Risk_Update", "summary": "Updates a risk in the system", "tags": ["Risk"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteRisk"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/risks/{risk_id}": { "get": { "operationId": "Risk_RetrieveById", "summary": "Retrieves a single risk in the system", "tags": ["Risk"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "risk_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteRisk"} } } } } }, "delete": { "operationId": "Risk_Delete", "summary": "Deletes a risk in the system", "tags": ["Risk"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "risk_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/risks/{risk_id}/comments": { "get": { "operationId": "Risk_RetrieveComments", "summary": "Retrieves comments for a specified risk.", "tags": ["Risk Comment"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "risk_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteComment"} } } } } } }, "post": { "operationId": "Risk_CreateComment", "summary": "Creates a new comment for a risk.", "tags": ["Risk Comment"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "risk_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteComment"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteComment"} } } } } } }, "/projects/{project_id}/risks/{risk_id}/mitigations": { "get": { "operationId": "Risk_RetrieveMitigations", "summary": "Retrieves a list of risk mitigations", "tags": ["Risk Mitigation"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "risk_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteRiskMitigation"} } } } } } }, "post": { "operationId": "Risk_AddMitigation", "summary": "Adds a risk mitigation to a risk", "tags": ["Risk Mitigation"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "risk_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "existing_risk_mitigation_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "creator_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "existing_risk_mitigation_id", "in": "query", "schema": {"type": "string"} }, { "name": "creator_id", "in": "query", "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteRiskMitigation"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteRiskMitigation"} } } } } }, "put": { "operationId": "Risk_UpdateMitigation", "summary": "Updates an existing risk mitigation", "tags": ["Risk Mitigation"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "risk_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteRiskMitigation"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/risks/{risk_id}/mitigations/{risk_mitigation_id}": { "get": { "operationId": "Risk_RetrieveMitigationById", "summary": "Retrieves a single risk mitigation by its ID", "tags": ["Risk Mitigation"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "risk_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "risk_mitigation_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteRiskMitigation"} } } } } }, "delete": { "operationId": "Risk_DeleteMitigation", "summary": "Deletes a risk mitigation in the list", "tags": ["Risk Mitigation"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "risk_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "risk_mitigation_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/risks/count": { "get": { "operationId": "Risk_Count1", "summary": "Returns the number of risks in the project.", "tags": ["Risk"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/Int64"} } } } } }, "post": { "operationId": "Risk_Count2", "summary": "Returns the number of risks that match the filter.", "tags": ["Risk"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteFilter"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/Int64"} } } } } } }, "/projects/{project_id}/risks/search": { "post": { "operationId": "Risk_RetrieveSearch", "summary": "Retrieves a list of risks in the system that match the provided filter/sort", "tags": ["Risk"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "starting_row", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_field", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_direction", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "starting_row", "in": "query", "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "query", "schema": {"type": "string"} }, { "name": "sort_field", "in": "query", "schema": {"type": "string"} }, { "name": "sort_direction", "in": "query", "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteFilter"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteRisk"} } } } } } } }, "/projects/{project_id}/risks/types/{Risk_type_id}/workflow/transitions": { "get": { "operationId": "Risk_RetrieveWorkflowTransitionsForUser", "summary": "Will retrieve available transitions for the specied status ID for the currently logged-on user.", "tags": ["Risk Type"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "Risk_type_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "Risk_status_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "is_creator", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "is_owner", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "is_creator", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowTransition"} } } } } } } }, "/projects/{project_id}/source-code": { "get": { "operationId": "SourceCode_RetrieveBranches", "summary": "Retrieves a list of source code branches in the project", "tags": ["Source Code"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteSourceCodeBranch"} } } } } } } }, "/projects/{project_id}/source-code/{branch_id}/files": { "get": { "operationId": "SourceCode_RetrieveFilesForArtifact", "summary": "Retrieves a list of files associated with a specific artifact", "tags": ["Source Code File"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "branch_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "artifact_type_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "artifact_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "artifact_type_id", "in": "query", "schema": {"type": "string"} }, { "name": "artifact_id", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteSourceCodeFile"} } } } } } } }, "/projects/{project_id}/source-code/{branch_id}/files/{file_id}": { "get": { "operationId": "SourceCode_RetrieveFileById", "summary": "Retrieves a specific file by its ID", "tags": ["Source Code File"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "branch_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "file_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteSourceCodeFile"} } } } } } }, "/projects/{project_id}/source-code/{branch_id}/files/{file_id}/open": { "get": { "operationId": "SourceCode_OpenFileById", "summary": "Returns the physical contents of a file in a linked source code repository", "tags": ["Source Code File"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "branch_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "file_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "revision_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "revision_id", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/Byte"} } } } } } } }, "/projects/{project_id}/source-code/{branch_id}/files/{file_id}/revisions": { "get": { "operationId": "SourceCode_RetrieveRevisionsForFile", "summary": "Retrieves a list of revisions for a specific file", "tags": ["Source Code Revision"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "branch_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "file_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteSourceCodeRevision"} } } } } } } }, "/projects/{project_id}/source-code/{branch_id}/folders": { "get": { "operationId": "SourceCode_RetrieveFoldersByParent", "summary": "Retrieves a list of folders by their parent (unless root)", "tags": ["Source Code Folder"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "branch_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "parent_folder_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "parent_folder_id", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteSourceCodeFolder"} } } } } } } }, "/projects/{project_id}/source-code/{branch_id}/folders/{folder_id}/files": { "get": { "operationId": "SourceCode_RetrieveFilesByFolder", "summary": "Retrieves a list of files in a specific folder", "tags": ["Source Code File"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "branch_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "folder_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteSourceCodeFile"} } } } } } } }, "/projects/{project_id}/source-code/{branch_id}/revisions": { "post": { "operationId": "SourceCode_RetrieveRevisions", "summary": "Retrieves a sorted, filtered, paginated list of revisions in the repository", "tags": ["Source Code Revision"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "branch_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "start_Row", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "number_rows", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_property", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_direction", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "start_Row", "in": "query", "schema": {"type": "string"} }, { "name": "number_rows", "in": "query", "schema": {"type": "string"} }, { "name": "sort_property", "in": "query", "schema": {"type": "string"} }, { "name": "sort_direction", "in": "query", "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteFilter"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteSourceCodeRevision"} } } } } } }, "get": { "operationId": "SourceCode_RetrieveRevisionsForArtifact", "summary": "Retrieves a list of revisions associated with a specific artifact", "tags": ["Source Code Revision"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "branch_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "artifact_type_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "artifact_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "artifact_type_id", "in": "query", "schema": {"type": "string"} }, { "name": "artifact_id", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteSourceCodeRevision"} } } } } } } }, "/projects/{project_id}/source-code/{branch_id}/revisions/{revision_id}": { "get": { "operationId": "SourceCode_RetrieveRevisionById", "summary": "Retrieves a revision by its ID", "tags": ["Source Code Revision"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "branch_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "revision_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteSourceCodeRevision"} } } } } } }, "/projects/{project_id}/source-code/{branch_id}/revisions/{revision_id}/associations": { "get": { "operationId": "SourceCode_RetrieveArtifactsForRevision", "summary": "Retrieves a list of artifacts associated with a specific revision", "tags": ["Source Code Revision"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "branch_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "revision_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteLinkedArtifact"} } } } } } } }, "/projects/{project_id}/source-code/{branch_id}/revisions/{revision_id}/files": { "get": { "operationId": "SourceCode_RetrieveFilesByRevision", "summary": "Retrieves a list of files contained in a specific revision", "tags": ["Source Code File"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "branch_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "revision_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteSourceCodeFile"} } } } } } } }, "/projects/{project_id}/source-code/{branch_id}/revisions/count": { "get": { "operationId": "SourceCodeRevisions_Count", "summary": "Returns the total number of Revisions/Commits in a specific branch", "tags": ["Source Code Revision"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "branch_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/Int64"} } } } } } }, "/projects/{project_id}/source-code/connection": { "get": { "operationId": "SourceCode_RetrieveConnectionInformation", "summary": "Returns the source code information for a specific product in Spira", "tags": ["Source Code"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteSourceCodeConnection"} } } } } } }, "/projects/{project_id}/source-code/providers": { "get": { "operationId": "SourceCode_RetrieveProductProviderConfig", "summary": "Retrieves the currently active provider configuration for a particular product.", "tags": ["Source Code Provider Products"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteProductSourceCodeProvider"} } } } } }, "post": { "operationId": "SourceCode_AddProductProviderConfig", "summary": "Adds a source code provider to a product with any desired product level configuration. Leave fields blank to use system configured defaults without exposing to product admins. System admins only.", "tags": ["Source Code Provider Products"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteProductSourceCodeProvider"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteProductSourceCodeProvider"} } } } } }, "put": { "operationId": "SourceCode_UpdateProductProviderConfig", "summary": "Overwrites a provider's configuration for a given product - even for fields which are omitted, except for VersionControlSystemId and ProjectId. This endpoint will only modify the currently active configuration.", "tags": ["Source Code Provider Products"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteProductSourceCodeProvider"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "delete": { "operationId": "SourceCode_RemoveProductConfiguration", "summary": "Removes any source code configuration for the specified product", "tags": ["Source Code Provider Products"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/source-code/providers/test": { "get": { "operationId": "SourceCode_TestProductProviderConfiguration", "summary": "Tests whether the credentials configured for the specified product can make a successful connection / see the configured repository\n This will use any system level configuration which does not exist at the product level - ex. if ConnectionInfo is not set at the product level, then it will use the system level ConnectionInfo", "tags": ["Source Code Provider Products"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/Boolean"} } } } } } }, "/projects/{project_id}/task-folders": { "get": { "operationId": "Task_RetrieveFolders", "summary": "Retrieves all of the task folders in the project with their hierarchy", "tags": ["Task Folder"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteTaskFolder"} } } } } } }, "post": { "operationId": "Task_CreateFolder", "summary": "Creates a new task folder in the system", "tags": ["Task Folder"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTaskFolder"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTaskFolder"} } } } } }, "put": { "operationId": "Task_UpdateFolder", "summary": "Updates a test folder in the system", "tags": ["Task Folder"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTaskFolder"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/task-folders/{parent_task_folder_id}/children": { "get": { "operationId": "Task_RetrieveFoldersByParent", "summary": "Retrieves a list of folders by the parent folder", "tags": ["Task Folder"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "parent_task_folder_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteTaskFolder"} } } } } } } }, "/projects/{project_id}/task-folders/{task_folder_id}": { "get": { "operationId": "Task_RetrieveFolderById", "summary": "Retrieves a single test folder in the system", "tags": ["Task Folder"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "task_folder_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTaskFolder"} } } } } }, "delete": { "operationId": "Task_DeleteFolder", "summary": "Deletes a task folder in the system", "tags": ["Task Folder"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "task_folder_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/tasks": { "post": { "operationId": "Task_Create", "summary": "Creates a new task in the system", "tags": ["Task"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTask"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTask"} } } } } }, "put": { "operationId": "Task_Update", "summary": "Updates a task in the system", "tags": ["Task"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTask"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/tasks/{task_id}": { "get": { "operationId": "Task_RetrieveById", "summary": "Retrieves a single task in the system", "tags": ["Task"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "task_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTask"} } } } } }, "delete": { "operationId": "Task_Delete", "summary": "Deletes a task in the system", "tags": ["Task"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "task_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/tasks/{task_id}/comments": { "get": { "operationId": "Task_RetrieveComments", "summary": "Retrieves comments for a specified task.", "tags": ["Task Comment"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "task_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteComment"} } } } } } }, "post": { "operationId": "Task_CreateComment", "summary": "Creates a new comment for a task.", "tags": ["Task Comment"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "task_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteComment"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteComment"} } } } } } }, "/projects/{project_id}/tasks/count": { "get": { "operationId": "Task_Count1", "summary": "Returns the number of tasks in the project.", "tags": ["Task"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/Int64"} } } } } }, "post": { "operationId": "Task_Count2", "summary": "Returns the number of tasks that match the filter.", "tags": ["Task"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteFilter"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/Int64"} } } } } } }, "/projects/{project_id}/tasks/new": { "get": { "operationId": "Task_RetrieveNew", "summary": "Retrieves all new tasks added in the system since the date specified", "tags": ["Task"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "creation_date", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "start_row", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "creation_date", "in": "query", "schema": {"type": "string"} }, { "name": "start_row", "in": "query", "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteTask"} } } } } } } }, "/projects/{project_id}/tasks/search": { "post": { "operationId": "Task_RetrieveSearch", "summary": "Retrieves a list of tasks in the system that match the provided filter/sort", "tags": ["Task"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "starting_row", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_field", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_direction", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "starting_row", "in": "query", "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "query", "schema": {"type": "string"} }, { "name": "sort_field", "in": "query", "schema": {"type": "string"} }, { "name": "sort_direction", "in": "query", "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteFilter"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteTask"} } } } } } } }, "/projects/{project_id}/tasks/types/{task_type_id}/workflow/transitions": { "get": { "operationId": "Task_RetrieveWorkflowTransitionsForUser", "summary": "Will retrieve available transitions for the specied status ID for the currently logged-on user.", "tags": ["Task Type"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "task_type_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "task_status_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "is_creator", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "is_owner", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "is_creator", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowTransition"} } } } } } } }, "/projects/{project_id}/test-cases": { "post": { "operationId": "TestCase_Create", "summary": "Creates a new test case in the system. Name, TestCaseStatusId, and TestCaseTypeId are required fields.", "tags": ["Test Case"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTestCase"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTestCase"} } } } } }, "put": { "operationId": "TestCase_Update", "summary": "Updates a test case in the system together with its test steps (if populated)", "description": "Does not currently update test step custom properties", "tags": ["Test Case"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTestCase"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "get": { "operationId": "TestCase_Retrieve1", "summary": "Retrieves a list of testCases in the project", "tags": ["Test Case"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "starting_row", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_field", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_direction", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "starting_row", "in": "query", "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "query", "schema": {"type": "string"} }, { "name": "sort_field", "in": "query", "schema": {"type": "string"} }, { "name": "sort_direction", "in": "query", "schema": {"type": "string"} }, { "name": "release_id", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteTestCase"} } } } } } } }, "/projects/{project_id}/test-cases/{test_case_id}": { "get": { "operationId": "TestCase_RetrieveById", "summary": "Retrieves a single test case in the system", "description": "This also populates the test steps collection if you have the appropriate permissions", "tags": ["Test Case"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_case_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTestCase"} } } } } }, "delete": { "operationId": "TestCase_Delete", "summary": "Deletes a test case in the system", "description": "Also deletes any child test steps", "tags": ["Test Case"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_case_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/test-cases/{test_case_id}/add-update-automation-script": { "post": { "operationId": "TestCase_AddUpdateAutomationScript", "summary": "Adds or updates the automation test script associated with a test case", "tags": ["Test Case"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_case_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "automation_engine_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "url_or_filename", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "description", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "version", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "project_attachment_type_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "project_attachment_folder_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "automation_engine_id", "in": "query", "schema": {"type": "string"} }, { "name": "url_or_filename", "in": "query", "schema": {"type": "string"} }, { "name": "description", "in": "query", "schema": {"type": "string"} }, { "name": "version", "in": "query", "schema": {"type": "string"} }, { "name": "project_attachment_type_id", "in": "query", "schema": {"type": "string"} }, { "name": "project_attachment_folder_id", "in": "query", "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/Byte"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/test-cases/{test_case_id}/comments": { "get": { "operationId": "TestCase_RetrieveComments", "summary": "Retrieves comments for a specified test case.", "tags": ["Test Case Comment"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_case_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteComment"} } } } } } }, "post": { "operationId": "TestCase_CreateComment", "summary": "Creates a new comment for a test case.", "tags": ["Test Case Comment"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_case_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteComment"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteComment"} } } } } } }, "/projects/{project_id}/test-cases/{test_case_id}/move": { "post": { "operationId": "TestCase_Move", "summary": "Moves a test case to another location in the hierarchy", "tags": ["Test Case"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_case_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_case_folder_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_case_folder_id", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/test-cases/{test_case_id}/parameters": { "get": { "operationId": "TestCase_RetrieveParameters", "summary": "Retrieves the list of defined parameters for a test case along with the associated default value", "tags": ["Test Case Parameter"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_case_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteTestCaseParameter"} } } } } } } }, "/projects/{project_id}/test-cases/{test_case_id}/requirements": { "get": { "operationId": "TestCase_RetrieveRequirementCoverage", "summary": "Retrieves the list of requirements associated with a test case", "tags": ["Test Case Requirement Coverage"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_case_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteRequirementTestCaseMapping"} } } } } } } }, "/projects/{project_id}/test-cases/{test_case_id}/test-links/{linked_test_case_id}": { "post": { "operationId": "TestCase_AddLink", "summary": "Adds a new test step that is actually a link to a test case", "tags": ["Test Case Link"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_case_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "linked_test_case_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "position", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "position", "in": "query", "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteTestStepParameter"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/Int32"} } } } } } }, "/projects/{project_id}/test-cases/{test_case_id}/test-runs/search": { "post": { "operationId": "TestRun_RetrieveByTestCaseId", "summary": "Retrieves a list of test runs for a specific test case", "description": "Doesn't include the test run steps", "tags": ["Test Run"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_case_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "starting_row", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_field", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_direction", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "starting_row", "in": "query", "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "query", "schema": {"type": "string"} }, { "name": "sort_field", "in": "query", "schema": {"type": "string"} }, { "name": "sort_direction", "in": "query", "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteFilter"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteTestRun"} } } } } } } }, "/projects/{project_id}/test-cases/{test_case_id}/test-steps": { "post": { "operationId": "TestCase_AddStep", "summary": "Adds a new test step to the specified test case", "tags": ["Test Step"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_case_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTestStep"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTestStep"} } } } } }, "get": { "operationId": "TestCase_RetrieveSteps", "summary": "Retrieves the list of test steps for a test case", "tags": ["Test Step"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_case_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteTestStep"} } } } } } }, "put": { "operationId": "TestCase_UpdateStep", "summary": "Updates a single test step in the system", "tags": ["Test Step"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_case_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTestStep"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/test-cases/{test_case_id}/test-steps/{source_test_step_id}/move": { "post": { "operationId": "TestCase_MoveStep", "summary": "Moves a test step to a different position in the test case", "tags": ["Test Step"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_case_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "source_test_step_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "destination_test_step_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "destination_test_step_id", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/test-cases/{test_case_id}/test-steps/{test_step_id}": { "delete": { "operationId": "TestCase_DeleteStep", "summary": "Deletes a test step in the system", "description": "Doesn't throw an exception if the step no longer exists", "tags": ["Test Step"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_case_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_step_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "get": { "operationId": "TestCase_RetrieveStepById", "summary": "Retrieves a single test step by its ID", "tags": ["Test Step"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_case_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_step_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTestStep"} } } } } } }, "/projects/{project_id}/test-cases/{test_case_id}/test-steps/{test_step_id}/parameters": { "get": { "operationId": "TestCase_RetrieveStepParameters", "summary": "Retrieves the list of parameters and provided values for a test link step", "tags": ["Test Step Parameter"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_case_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_step_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteTestStepParameter"} } } } } } }, "post": { "operationId": "TestCase_AddStepParameters", "summary": "Adds new parameters with provided names and values for a test link step", "tags": ["Test Step Parameter"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_case_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_step_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteTestStepParameter"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "put": { "operationId": "TestCase_UpdateStepParameters", "summary": "Updates existing parameters with provided names and values for a test link step", "tags": ["Test Step Parameter"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_case_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_step_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteTestStepParameter"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "delete": { "operationId": "TestCase_DeleteStepParameters", "summary": "Deletes existing parameters with provided names and values for a test link step", "tags": ["Test Step Parameter"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_case_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_step_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteTestStepParameter"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/test-cases/{test_case_id}/test-steps/multiple": { "post": { "operationId": "TestCase_AddTestSteps", "summary": "This method adds a collection of test steps, up to 30 at a time\n \n Errors will return for each failed test step giving the error for that specific step with a 1 based index number to identify the problematic test step", "tags": ["Test Step"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_case_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteTestStep"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteTestStep"} } } } } } } }, "/projects/{project_id}/test-cases/count": { "get": { "operationId": "TestCase_Count1", "summary": "Returns the number of test cases in the project", "tags": ["Test Case"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/Int64"} } } } } }, "post": { "operationId": "TestCase_Count2", "summary": "Returns the number of test cases that match the filter.", "tags": ["Test Case"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "query", "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteFilter"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/Int64"} } } } } } }, "/projects/{project_id}/test-cases/parameters": { "post": { "operationId": "TestCase_AddParameter", "summary": "Adds a new parameter for a test case", "description": "The parameter name is always made lower case", "tags": ["Test Case Parameter"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTestCaseParameter"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTestCaseParameter"} } } } } }, "put": { "operationId": "TestCase_UpdateParameter", "summary": "Updates an existing parameter for a test case", "tags": ["Test Case Parameter"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTestCaseParameter"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "delete": { "operationId": "TestCase_DeleteParameter", "summary": "Deletes an existing parameter for a test case", "tags": ["Test Case Parameter"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTestCaseParameter"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/test-cases/parameters/create-token": { "post": { "operationId": "TestCase_CreateParameterToken", "summary": "Returns the full token of a test case parameter from its name", "description": "We use the same parameter format as Ant/NAnt", "tags": ["Test Case Parameter"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "parameter_name", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "parameter_name", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/String"} } } } } } }, "/projects/{project_id}/test-cases/search": { "post": { "operationId": "TestCase_Retrieve2", "summary": "Retrieves a list of testCases in the system that match the provided filter", "tags": ["Test Case"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "starting_row", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_field", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_direction", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "starting_row", "in": "query", "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "query", "schema": {"type": "string"} }, { "name": "sort_field", "in": "query", "schema": {"type": "string"} }, { "name": "sort_direction", "in": "query", "schema": {"type": "string"} }, { "name": "release_id", "in": "query", "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteFilter"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteTestCase"} } } } } } } }, "/projects/{project_id}/test-cases/types/{TestCase_type_id}/workflow/transitions": { "get": { "operationId": "TestCase_RetrieveWorkflowTransitionsForUser", "summary": "Will retrieve available transitions for the specied status ID for the currently logged-on user.", "tags": ["Test Case Type"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "TestCase_type_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "testcase_status_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "is_creator", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "is_owner", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "is_creator", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowTransition"} } } } } } } }, "/projects/{project_id}/test-configuration-sets": { "get": { "operationId": "TestConfiguration_RetrieveSets", "summary": "Retrieves the list of test configuration sets in the current project (without the detailed entries)", "tags": ["Test Configuration Set"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteTestConfigurationSet"} } } } } } }, "post": { "operationId": "TestConfiguration_CreateSet", "summary": "Creates a new test configuration set in the specified project", "tags": ["Test Configuration Set"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTestConfigurationSet"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTestConfigurationSet"} } } } } } }, "/projects/{project_id}/test-configuration-sets/{test_configuration_set_id}": { "get": { "operationId": "TestConfiguration_RetrieveSetById", "summary": "Retrieves the test configuration set by its id", "tags": ["Test Configuration Set"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_configuration_set_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTestConfigurationSet"} } } } } }, "put": { "operationId": "TestConfiguration_UpdateSet", "summary": "Updates an existing test configuration set in the specified project", "tags": ["Test Configuration Set"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_configuration_set_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTestConfigurationSet"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "delete": { "operationId": "TestConfiguration_DeleteSet", "summary": "Deletes (soft-delete) a test configuration set in the specified project", "tags": ["Test Configuration Set"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_configuration_set_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/test-configuration-sets/{test_configuration_set_id}/populate": { "post": { "operationId": "TestConfiguration_PopulateSet", "summary": "Populates a test configuration set with entries generated from test case parameters and custom lists", "tags": ["Test Configuration Set"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_configuration_set_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteTestConfigurationSetParameter"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/test-folders": { "post": { "operationId": "TestCase_CreateFolder", "summary": "Creates a new test case folder in the system", "tags": ["Test Case Folder"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTestCaseFolder"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTestCaseFolder"} } } } } }, "put": { "operationId": "TestCase_UpdateFolder", "summary": "Updates a test folder in the system", "tags": ["Test Case Folder"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTestCaseFolder"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "get": { "operationId": "TestCase_RetrieveFolders", "summary": "Retrieves all of the test case folders in the project with their hierarchy", "tags": ["Test Case Folder"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteTestCaseFolder"} } } } } } } }, "/projects/{project_id}/test-folders/{parent_test_case_folder_id}/children": { "get": { "operationId": "TestCase_RetrieveFoldersByParent", "summary": "Retrieves a list of folders by the parent folder", "tags": ["Test Case Folder"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "parent_test_case_folder_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteTestCaseFolder"} } } } } } } }, "/projects/{project_id}/test-folders/{test_case_folder_id}": { "get": { "operationId": "TestCase_RetrieveFolderById", "summary": "Retrieves a single test folder in the system", "tags": ["Test Case Folder"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_case_folder_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTestCaseFolder"} } } } } }, "delete": { "operationId": "TestCase_DeleteFolder", "summary": "Deletes a test case folder in the system", "tags": ["Test Case Folder"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_case_folder_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/test-folders/{test_case_folder_id}/test-cases": { "get": { "operationId": "TestCase_RetrieveByFolder1", "summary": "Retrieves a list of test cases in the specified test case folder", "tags": ["Test Case Folder Test Cases"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_case_folder_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "starting_row", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_field", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_direction", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "starting_row", "in": "query", "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "query", "schema": {"type": "string"} }, { "name": "sort_field", "in": "query", "schema": {"type": "string"} }, { "name": "sort_direction", "in": "query", "schema": {"type": "string"} }, { "name": "release_id", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteTestCase"} } } } } } } }, "/projects/{project_id}/test-folders/{test_case_folder_id}/test-cases/search": { "post": { "operationId": "TestCase_RetrieveByFolder2", "summary": "Retrieves a list of testCases in the system that match the provided filter", "tags": ["Test Case Folder Test Cases"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_case_folder_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "starting_row", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_field", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_direction", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "starting_row", "in": "query", "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "query", "schema": {"type": "string"} }, { "name": "sort_field", "in": "query", "schema": {"type": "string"} }, { "name": "sort_direction", "in": "query", "schema": {"type": "string"} }, { "name": "release_id", "in": "query", "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteFilter"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteTestCase"} } } } } } } }, "/projects/{project_id}/test-folders/{test_folder_id}/count": { "get": { "operationId": "TestCase_CountForFolder1", "summary": "Gives a count of items within the given folder", "tags": ["Test Case Folder Test Cases"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_folder_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/Int64"} } } } } }, "post": { "operationId": "TestCase_CountForFolder2", "summary": "Gives a count of items within the given folder that match the filters.", "tags": ["Test Case Folder Test Cases"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_folder_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "query", "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteFilter"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/Int64"} } } } } } }, "/projects/{project_id}/test-runs": { "put": { "operationId": "TestRun_Save", "summary": "Saves set of test runs, each containing test run steps", "tags": ["Manual Test Run"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "end_date", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "end_date", "in": "query", "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteManualTestRun"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteManualTestRun"} } } } } } }, "get": { "operationId": "TestRun_Retrieve1", "summary": "Retrieves a list of test runs in the project", "description": "Doesn't include the test run steps", "tags": ["Test Run"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "starting_row", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_field", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_direction", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "starting_row", "in": "query", "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "query", "schema": {"type": "string"} }, { "name": "sort_field", "in": "query", "schema": {"type": "string"} }, { "name": "sort_direction", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteTestRun"} } } } } } } }, "/projects/{project_id}/test-runs/{test_run_id}": { "get": { "operationId": "TestRun_RetrieveById", "summary": "Retrieves a single test run in the system. Only returns the generic information\n that is applicable for both automated and manual tests. Consider using\n TestRun_RetrieveAutomatedById or TestRun_RetrieveManualById if you need\n the automation/manual specific data for the test run", "tags": ["Test Run"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_run_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTestRun"} } } } } }, "delete": { "operationId": "TestRun_Delete", "summary": "Deletes a test run from the system", "tags": ["Test Run"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_run_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/test-runs/{test_run_id}/automated": { "get": { "operationId": "TestRun_RetrieveAutomatedById", "summary": "Retrieves a single automated test run in the system including the automation-specific information", "tags": ["Automated Test Run"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_run_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteAutomatedTestRun"} } } } } } }, "/projects/{project_id}/test-runs/{test_run_id}/manual": { "get": { "operationId": "TestRun_RetrieveManualById", "summary": "Retrieves a single manual test run in the system including any associated steps", "tags": ["Manual Test Run"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_run_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteManualTestRun"} } } } } } }, "/projects/{project_id}/test-runs/automated": { "get": { "operationId": "TestRun_RetrieveAutomated1", "summary": "Retrieves a list of automated test runs in the project", "description": "Doesn't include the test run steps", "tags": ["Automated Test Run"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "starting_row", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_field", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_direction", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "starting_row", "in": "query", "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "query", "schema": {"type": "string"} }, { "name": "sort_field", "in": "query", "schema": {"type": "string"} }, { "name": "sort_direction", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteAutomatedTestRun"} } } } } } } }, "/projects/{project_id}/test-runs/count": { "post": { "operationId": "TestRun_Count2", "summary": "Returns the number of test runs that match the filter.", "tags": ["Test Run"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteFilter"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/Int64"} } } } } }, "get": { "operationId": "TestRun_Count1", "summary": "Returns the number of test runs in the project.", "tags": ["Test Run"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/Int64"} } } } } } }, "/projects/{project_id}/test-runs/create": { "post": { "operationId": "TestRun_CreateFromTestCases", "summary": "Creates a new test run shell from the provided test case(s)", "tags": ["Manual Test Run"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "query", "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/Int32"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteManualTestRun"} } } } } } } }, "/projects/{project_id}/test-runs/create/automation_host/{automation_host_token}": { "post": { "operationId": "TestRun_CreateForAutomationHost", "summary": "Creates a shell set of test runs for an external automated test runner based on the provided automation host token\n and the specified date range", "tags": ["Automated Test Run"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "automation_host_token", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/DateRange"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteAutomatedTestRun"} } } } } } } }, "/projects/{project_id}/test-runs/create/test_set/{test_set_id}": { "post": { "operationId": "TestRun_CreateFromTestSet", "summary": "Creates a new test run shell from the provided test set", "tags": ["Manual Test Run"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_set_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteManualTestRun"} } } } } } } }, "/projects/{project_id}/test-runs/create/test_set/{test_set_id}/automation_host/{automation_host_token}": { "post": { "operationId": "TestRun_CreateForAutomatedTestSet", "summary": "Creates a shell set of test runs for an external automated test runner based on the provided test set id", "description": "For this method the test set doesn't need an automated host to be set", "tags": ["Automated Test Run"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_set_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "automation_host_token", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteAutomatedTestRun"} } } } } } } }, "/projects/{project_id}/test-runs/manual": { "get": { "operationId": "TestRun_RetrieveManual1", "summary": "Retrieves a list of manual test runs in the project", "description": "Does include the test run steps", "tags": ["Manual Test Run"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "starting_row", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_field", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_direction", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "starting_row", "in": "query", "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "query", "schema": {"type": "string"} }, { "name": "sort_field", "in": "query", "schema": {"type": "string"} }, { "name": "sort_direction", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteManualTestRun"} } } } } } } }, "/projects/{project_id}/test-runs/record": { "post": { "operationId": "TestRun_RecordAutomated1", "summary": "Records the results of executing an automated test", "description": "You need to use this overload when you want to be able to set Test Run custom properties", "tags": ["Automated Test Run"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteAutomatedTestRun"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteAutomatedTestRun"} } } } } } }, "/projects/{project_id}/test-runs/record-multiple": { "post": { "operationId": "TestRun_RecordAutomated2", "summary": "Records the results of executing multiple automated tests", "description": "You need to use this overload when you want to be able to execute a large batch of test runs.\n It's faster than TestRun_RecordAutomated1 for large numbers of test runs.\n *However* it does not refresh any of the other items in the project (test cases, requirements, test sets)\n that also have summarized forms of this data. So once you're done loading data, you *must*\n call the Project_RefreshProgressExecutionStatusCaches() command once.", "tags": ["Automated Test Run"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteAutomatedTestRun"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteAutomatedTestRun"} } } } } } } }, "/projects/{project_id}/test-runs/search": { "post": { "operationId": "TestRun_Retrieve2", "summary": "Retrieves a list of test runs in the system that match the provided filter/sort", "description": "Doesn't include the test run steps", "tags": ["Test Run"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "starting_row", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_field", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_direction", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "starting_row", "in": "query", "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "query", "schema": {"type": "string"} }, { "name": "sort_field", "in": "query", "schema": {"type": "string"} }, { "name": "sort_direction", "in": "query", "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteFilter"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteTestRun"} } } } } } } }, "/projects/{project_id}/test-runs/search/automated": { "post": { "operationId": "TestRun_RetrieveAutomated2", "summary": "Retrieves a list of automated test runs in the system that match the provided filter/sort", "description": "Doesn't include the test run steps", "tags": ["Automated Test Run"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "starting_row", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_field", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_direction", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "starting_row", "in": "query", "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "query", "schema": {"type": "string"} }, { "name": "sort_field", "in": "query", "schema": {"type": "string"} }, { "name": "sort_direction", "in": "query", "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteFilter"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteAutomatedTestRun"} } } } } } } }, "/projects/{project_id}/test-runs/search/manual": { "post": { "operationId": "TestRun_RetrieveManual2", "summary": "Retrieves a list of manual test runs in the system that match the provided filter/sort", "description": "Does include the test run steps", "tags": ["Manual Test Run"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "starting_row", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_field", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_direction", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "starting_row", "in": "query", "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "query", "schema": {"type": "string"} }, { "name": "sort_field", "in": "query", "schema": {"type": "string"} }, { "name": "sort_direction", "in": "query", "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteFilter"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteManualTestRun"} } } } } } } }, "/projects/{project_id}/test-set-folders": { "get": { "operationId": "TestSet_RetrieveFolders", "summary": "Retrieves all of the test set folders in the project with their hierarchy", "tags": ["Test Set Folder"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteTestSetFolder"} } } } } } }, "post": { "operationId": "TestSet_CreateFolder", "summary": "Creates a new test set folder in the system", "tags": ["Test Set Folder"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTestSetFolder"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTestSetFolder"} } } } } }, "put": { "operationId": "TestSet_UpdateFolder", "summary": "Updates a test folder in the system", "tags": ["Test Set Folder"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTestSetFolder"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/test-set-folders/{parent_test_set_folder_id}/children": { "get": { "operationId": "TestSet_RetrieveFoldersByParent", "summary": "Retrieves a list of folders by the parent folder", "tags": ["Test Set Folder"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "parent_test_set_folder_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteTestSetFolder"} } } } } } } }, "/projects/{project_id}/test-set-folders/{test_folder_id}/count": { "get": { "operationId": "TestSet_CountForFolder1", "summary": "Gives a count of items within the given folder", "tags": ["Test Set Folder Test Sets"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_folder_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/Int64"} } } } } }, "post": { "operationId": "TestSet_CountForFolder2", "summary": "Gives a count of items within the given folder that match the filters.", "tags": ["Test Set Folder Test Sets"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_folder_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "query", "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteFilter"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/Int64"} } } } } } }, "/projects/{project_id}/test-set-folders/{test_set_folder_id}": { "get": { "operationId": "TestSet_RetrieveFolderById", "summary": "Retrieves a single test folder in the system", "tags": ["Test Set Folder"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_set_folder_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTestSetFolder"} } } } } }, "delete": { "operationId": "TestSet_DeleteFolder", "summary": "Deletes a test set folder in the system", "tags": ["Test Set Folder"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_set_folder_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/test-set-folders/{test_set_folder_id}/test-sets": { "get": { "operationId": "TestSet_RetrieveByFolder1", "summary": "Retrieves a list of testSets in the project", "tags": ["Test Set Folder Test Sets"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_set_folder_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "starting_row", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_field", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_direction", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "starting_row", "in": "query", "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "query", "schema": {"type": "string"} }, { "name": "sort_field", "in": "query", "schema": {"type": "string"} }, { "name": "sort_direction", "in": "query", "schema": {"type": "string"} }, { "name": "release_id", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteTestSet"} } } } } } } }, "/projects/{project_id}/test-set-folders/{test_set_folder_id}/test-sets/search": { "post": { "operationId": "TestSet_RetrieveByFolder2", "summary": "Retrieves a list of testSets in the system that match the provided filter", "tags": ["Test Set Folder Test Sets"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_set_folder_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "starting_row", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_field", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_direction", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "starting_row", "in": "query", "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "query", "schema": {"type": "string"} }, { "name": "sort_field", "in": "query", "schema": {"type": "string"} }, { "name": "sort_direction", "in": "query", "schema": {"type": "string"} }, { "name": "release_id", "in": "query", "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteFilter"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteTestSet"} } } } } } } }, "/projects/{project_id}/test-sets": { "post": { "operationId": "TestSet_Create", "summary": "Creates a new test set in the system. You must send at least the \"Name\" (string), \"Description\" (string), \"TestSetStatusId\" (integer between 1 and 5), and \"TestRunTypeId\" (integer between 1 and 2) fields in the body", "tags": ["Test Set"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTestSet"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTestSet"} } } } } }, "put": { "operationId": "TestSet_Update", "summary": "Updates a test set in the system", "tags": ["Test Set"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTestSet"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "get": { "operationId": "TestSet_Retrieve1", "summary": "Retrieves a list of testSets in the project", "tags": ["Test Set"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "starting_row", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_field", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_direction", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "starting_row", "in": "query", "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "query", "schema": {"type": "string"} }, { "name": "sort_field", "in": "query", "schema": {"type": "string"} }, { "name": "sort_direction", "in": "query", "schema": {"type": "string"} }, { "name": "release_id", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteTestSet"} } } } } } } }, "/projects/{project_id}/test-sets/{test_set_id}": { "get": { "operationId": "TestSet_RetrieveById", "summary": "Retrieves a single test set in the system", "tags": ["Test Set"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_set_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTestSet"} } } } } }, "delete": { "operationId": "TestSet_Delete", "summary": "Deletes a test set in the system", "tags": ["Test Set"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_set_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/test-sets/{test_set_id}/comments": { "get": { "operationId": "TestSet_RetrieveComments", "summary": "Retrieves comments for a specified test set.", "tags": ["Test Set Comment"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_set_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteComment"} } } } } } }, "post": { "operationId": "TestSet_CreateComment", "summary": "Creates a new comment for a test set.", "tags": ["Test Set Comment"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_set_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteComment"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteComment"} } } } } } }, "/projects/{project_id}/test-sets/{test_set_id}/move": { "post": { "operationId": "TestSet_Move", "summary": "Moves a test set to another location in the hierarchy", "tags": ["Test Set"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_set_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_set_folder_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_set_folder_id", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/test-sets/{test_set_id}/parameters": { "get": { "operationId": "TestSet_RetrieveParameters", "summary": "Retrieves a list of test parameter values specified by a specific test set", "description": "Does not include any parameters set at the test set test case level", "tags": ["Test Set Parameter"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_set_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteTestSetParameter"} } } } } } } }, "/projects/{project_id}/test-sets/{test_set_id}/test-case-mapping": { "get": { "operationId": "TestSet_RetrieveTestCaseMapping", "summary": "Retrieves mappings of all the test cases that are part of a test set", "tags": ["Test Set Test Case"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_set_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteTestSetTestCaseMapping"} } } } } } }, "put": { "operationId": "TestSet_UpdateTestCaseMapping", "summary": "Updates a test set test case mapping's properties (not the mapping itself)", "description": "If Position is set to a value that is already in use by other test cases, the position will not be updated", "tags": ["Test Set Test Case"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_set_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTestSetTestCaseMapping"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/test-sets/{test_set_id}/test-case-mapping/{test_case_id}": { "post": { "operationId": "TestSet_AddTestMapping", "summary": "Maps a test set to a test case, so that the test case is part of the test set. User must be able to modify test cases and test sets.", "description": "You can only pass in a test case id not a test case folder id. Position cannot be set in this method. If a custom order is desired, you must use the PUT method after creation to achieve it.", "tags": ["Test Set Test Case"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_set_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_case_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "owner_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "existing_test_set_test_case_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "planned_date", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_case_id", "in": "query", "schema": {"type": "string"} }, { "name": "owner_id", "in": "query", "schema": {"type": "string"} }, { "name": "existing_test_set_test_case_id", "in": "query", "schema": {"type": "string"} }, { "name": "planned_date", "in": "query", "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteTestSetTestCaseParameter"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteTestSetTestCaseMapping"} } } } } } } }, "/projects/{project_id}/test-sets/{test_set_id}/test-cases": { "get": { "operationId": "TestCase_RetrieveByTestSetId", "summary": "Retrieves all the test cases that are part of a test set", "tags": ["Test Set Test Case"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_set_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteTestCase"} } } } } } } }, "/projects/{project_id}/test-sets/{test_set_id}/test-cases/{test_set_test_case_id}": { "delete": { "operationId": "TestSet_RemoveTestMapping", "summary": "Removes a test case from a test set", "tags": ["Test Set Test Case"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_set_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_set_test_case_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/test-sets/{test_set_id}/test-cases/{test_set_test_case_id}/in-use": { "put": { "operationId": "TestSet_SetInUseStatus", "summary": "Marks a specific test case in a test set as being either in use or available for automated execution", "description": "Used by RemoteLaunch when in load-balanced execution mode (to avoid being executed simultenously on two hosts)", "tags": ["Test Set Test Case"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_set_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_set_test_case_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/String"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "get": { "operationId": "TestSet_CheckInUseStatus", "summary": "Checks to see if a specific test case in a test set is either in use or available for automated execution", "description": "Used by RemoteLaunch when in load-balanced execution mode (to avoid being executed simultenously on two hosts)", "tags": ["Test Set Test Case"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_set_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_set_test_case_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/Boolean"} } } } } } }, "/projects/{project_id}/test-sets/{test_set_id}/test-cases/{test_set_test_case_id}/parameters": { "get": { "operationId": "TestSet_RetrieveTestCaseParameters", "summary": "Retrieves a list of test parameter values specified by a specific test set's test case instance", "tags": ["Test Set Test Case Parameter"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_set_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_set_test_case_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteTestSetTestCaseParameter"} } } } } } } }, "/projects/{project_id}/test-sets/{test_set_id}/test-cases/parameters": { "post": { "operationId": "TestSet_AddTestCaseParameter", "summary": "Adds a new test parameter specified by a specific test set's test case (the paramater is only added if it is not already set)", "tags": ["Test Set Test Case Parameter"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_set_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTestSetTestCaseParameter"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "put": { "operationId": "TestSet_UpdateTestCaseParameter", "summary": "Updates an existing test parameter specified by a specific test set's test case", "tags": ["Test Set Test Case Parameter"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_set_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTestSetTestCaseParameter"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "delete": { "operationId": "TestSet_DeleteTestCaseParameter", "summary": "Deletes an existing test parameter specified by a specific test set's test case", "tags": ["Test Set Test Case Parameter"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_set_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTestSetTestCaseParameter"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/test-sets/{test_set_id}/test-configuration-sets": { "get": { "operationId": "TestConfiguration_RetrieveForTestSet", "summary": "Retrieves the test configuration set associated with the given test set, or NULL if none associated", "tags": ["Test Set"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_set_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTestConfigurationSet"} } } } } } }, "/projects/{project_id}/test-sets/count": { "get": { "operationId": "TestSet_Count1", "summary": "Returns the number of test sets in the project", "tags": ["Test Set"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/Int64"} } } } } }, "post": { "operationId": "TestSet_Count2", "summary": "Returns the number of test sets that match the filter.", "tags": ["Test Set"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "query", "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteFilter"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/Int64"} } } } } } }, "/projects/{project_id}/test-sets/parameters": { "post": { "operationId": "TestSet_AddParameter", "summary": "Adds a new parameter for a test set", "tags": ["Test Set Parameter"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTestSetParameter"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "put": { "operationId": "TestSet_UpdateParameter", "summary": "Updates an existing parameter for a test set (only the parameter's value is updated)", "tags": ["Test Set Parameter"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTestSetParameter"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "delete": { "operationId": "TestSet_DeleteParameter", "summary": "Deletes an existing parameter for a test set", "tags": ["Test Set Parameter"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTestSetParameter"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/test-sets/search": { "post": { "operationId": "TestSet_Retrieve2", "summary": "Retrieves a list of testSets in the system that match the provided filter", "tags": ["Test Set"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "starting_row", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_field", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_direction", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "starting_row", "in": "query", "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "query", "schema": {"type": "string"} }, { "name": "release_id", "in": "query", "schema": {"type": "string"} }, { "name": "sort_field", "in": "query", "schema": {"type": "string"} }, { "name": "sort_direction", "in": "query", "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteFilter"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteTestSet"} } } } } } } }, "/projects/{project_id}/test-sets/test-case/{test_case_id}": { "get": { "operationId": "TestSet_RetrieveByTestCaseId", "summary": "Retrieves all (up to 500) test sets which contain the test case with the provided test case id", "tags": ["Test Set"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_case_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteTestSet"} } } } } } } }, "/projects/{project_id}/test-steps/{test_step_id}/requirements": { "get": { "operationId": "TestStep_RetrieveRequirementCoverage", "summary": "Retrieves a list of the requirement ids mapped against a specific test step", "tags": ["Test Step Requirements Coverage"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_step_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteRequirementTestStepMapping"} } } } } } } }, "/projects/{project_id}/users": { "get": { "operationId": "Project_RetrieveUserMembership", "summary": "Retrieves the list of active users that are members of the current project", "tags": ["Project User"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteProjectUser"} } } } } } }, "post": { "operationId": "Project_AddUserMembership", "summary": "Adds users to a project with a specific role", "tags": ["Project User"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteProjectUser"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "put": { "operationId": "Project_UpdateUserMembership", "summary": "Updates the user's role on a specific project", "tags": ["Project User"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteProjectUser"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/projects/{project_id}/users/{user_id}": { "delete": { "operationId": "Project_RemoveUserMembership", "summary": "Removes users from a project", "tags": ["Project User"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "user_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/project-templates": { "get": { "operationId": "ProjectTemplate_Retrieve", "summary": "Retrieves the list of project templates", "tags": ["Project Template"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteProjectTemplate"} } } } } } }, "post": { "operationId": "ProjectTemplate_Create", "summary": "Creates a new project template", "tags": ["Project Template"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "existing_project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "existing_project_template_id", "in": "query", "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteProjectTemplate"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteProjectTemplate"} } } } } } }, "/project-templates/{project_template_id}": { "delete": { "operationId": "ProjectTemplate_Delete", "summary": "Deletes an existing project template", "tags": ["Project Template"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "put": { "operationId": "ProjectTemplate_Update", "summary": "Updates an existing project template", "tags": ["Project Template"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteProjectTemplate"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "get": { "operationId": "ProjectTemplate_RetrieveById", "summary": "Retrieves a single project template", "tags": ["Project Template"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteProjectTemplate"} } } } } } }, "/project-templates/{project_template_id}/custom-lists": { "post": { "operationId": "CustomProperty_AddCustomList", "summary": "Adds a new custom list into the project template", "description": "Also adds any custom list values if they are provided", "tags": ["Custom List"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteCustomList"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteCustomList"} } } } } }, "get": { "operationId": "CustomProperty_RetrieveCustomLists", "summary": "Retrieves all the custom lists in the current project template", "description": "Does not return the actual custom list values", "tags": ["Custom List"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteCustomList"} } } } } } } }, "/project-templates/{project_template_id}/custom-lists/{custom_list_id}": { "get": { "operationId": "CustomProperty_RetrieveCustomListById", "summary": "Retrieves a custom list by its ID, including any custom list values", "tags": ["Custom List"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "custom_list_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteCustomList"} } } } } }, "put": { "operationId": "CustomProperty_UpdateCustomList", "summary": "Updates a custom list and any associated values in the system", "description": "This will not add any new custom values, for that you need to use the AddCustomListValue() function", "tags": ["Custom List"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "custom_list_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteCustomList"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/project-templates/{project_template_id}/custom-lists/{custom_list_id}/values": { "post": { "operationId": "CustomProperty_AddCustomListValue", "summary": "Adds a new custom property list value into the system", "tags": ["Custom List Value"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "custom_list_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteCustomListValue"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteCustomListValue"} } } } } } }, "/project-templates/{project_template_id}/custom-properties": { "post": { "operationId": "CustomProperty_AddDefinition", "summary": "Adds a new custom property definition to the project template for the specified artifact type", "description": "The return body object must at least include the fields: ProjectTemplateId, ArtifactTypeId, CustomPropertyTypeId, and Name", "tags": ["Custom Property"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "custom_list_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "custom_list_id", "in": "query", "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteCustomProperty"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteCustomProperty"} } } } } } }, "/project-templates/{project_template_id}/custom-properties/{artifact_type_name}": { "get": { "operationId": "CustomProperty_RetrieveForArtifactType", "summary": "Retrieves the list of custom properties configured for the current project template and the specified artifact type", "description": "1) Includes the custom list and custom list value child objects\n 2) The custom list values objects will include both active and inactive values, so need to check the flag before displaying", "tags": ["Custom Property"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "artifact_type_name", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteCustomProperty"} } } } } } } }, "/project-templates/{project_template_id}/custom-properties/{custom_property_id}": { "put": { "operationId": "CustomProperty_UpdateDefinition", "summary": "Updates a custom property definition, including any associated options", "description": "This method updates the custom property Name, IsDeleted flag, and custom property options, but does not update the list values or other fields.\n To change the list values, you need to use: CustomProperty_UpdateCustomList(...)", "tags": ["Custom Property"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "custom_property_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteCustomProperty"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "delete": { "operationId": "CustomProperty_DeleteDefinition", "summary": "Deletes a custom property definition from the system, including any associated options", "description": "Does a hard delete", "tags": ["Custom Property"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "custom_property_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/project-templates/{project_template_id}/documents/types/{document_type_id}/workflow/custom-properties": { "get": { "operationId": "Document_RetrieveWorkflowCustomPropertiesByType", "summary": "Retrieves the list of document custom properties and their workflow state for a given type and status/step.", "tags": ["Document Type"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "document_type_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "document_status_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowCustomProperty"} } } } } } } }, "/project-templates/{project_template_id}/documents/types/{document_type_id}/workflow/fields": { "get": { "operationId": "Document_RetrieveWorkflowFieldsByType", "summary": "Retrieves the list of fields and their workflow status for a given type and status/step.", "tags": ["Document Type"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "document_type_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "document_status_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowField"} } } } } } } }, "/project-templates/{project_template_id}/documents/workflows": { "get": { "operationId": "Document_RetrieveWorkflows", "summary": "Retrieves all workflows for tasks in a given project template", "tags": ["Document Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflow"} } } } } } }, "post": { "operationId": "Document_CreateWorkflow", "summary": "Creates a new blank workflow for documents in the specified project template", "tags": ["Document Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteWorkflow"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteWorkflow"} } } } } } }, "/project-templates/{project_template_id}/documents/workflows/{workflow_id}": { "get": { "operationId": "Document_RetrieveWorkflowById", "summary": "Retrieves a single workflow object by its ID", "tags": ["Document Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteWorkflow"} } } } } }, "put": { "operationId": "Document_UpdateWorkflow", "summary": "Updates a single workflow object", "tags": ["Document Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteWorkflow"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "delete": { "operationId": "Document_DeleteWorkflow", "summary": "Deletes a workflow from a project template", "tags": ["Document Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/project-templates/{project_template_id}/documents/workflows/{workflow_id}/custom-properties/{document_status_id}": { "get": { "operationId": "Document_RetrieveWorkflowCustomProperties", "summary": "Retrieves workflow custom property states for a given artifact status", "tags": ["Document Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "document_status_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowCustomProperty"} } } } } } }, "put": { "operationId": "Document_UpdateWorkflowCustomProperties", "summary": "Updates workflow custom property states for a given artifact status + workflow", "description": "FieldStateId determines the state of a given field. Here are the potential values\n 0 = Default (No workflow restrictions)\n 1 = Disabled\n 2 = Required\n 3 = Hidden", "tags": ["Document Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "document_status_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowCustomProperty"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/project-templates/{project_template_id}/documents/workflows/{workflow_id}/fields/{document_status_id}": { "put": { "operationId": "Document_UpdateWorkflowFields", "summary": "Updates a batch of workflow fields for a given status to fit the desired workflow state for all fields", "description": "FieldStateId determines the state of a given field. Here are the potential values\n 0 = Default (No workflow restrictions)\n 1 = Disabled\n 2 = Required\n 3 = Hidden", "tags": ["Document Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "document_status_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowField"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "get": { "operationId": "Document_RetrieveWorkflowFields", "summary": "Retrieves the list of fields and their workflow status for a given workflow and status.", "tags": ["Document Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "document_status_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowField"} } } } } } } }, "/project-templates/{project_template_id}/documents/workflows/{workflow_id}/transitions": { "post": { "operationId": "Document_CreateWorkflowTransition", "summary": "Creates a new workflow transition for a document workflow. Does not support NotificationSubject.", "tags": ["Document Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteWorkflowTransition"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteWorkflowTransition"} } } } } } }, "/project-templates/{project_template_id}/documents/workflows/{workflow_id}/transitions/{document_status_id}": { "get": { "operationId": "Document_RetrieveWorkflowTransitions", "summary": "Retrieves all transitions from a given document status in a specified workflow", "tags": ["Document Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "document_status_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowTransition"} } } } } } } }, "/project-templates/{project_template_id}/documents/workflows/{workflow_id}/transitions/{workflow_transition_id}": { "put": { "operationId": "Document_UpdateWorkflowTransition", "summary": "Updates a workflow transition in the same ways you can in the UI.", "tags": ["Document Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_transition_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteWorkflowTransition"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "delete": { "operationId": "Document_DeleteWorkflowTransition", "summary": "Deletes a workflow transition", "tags": ["Document Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_transition_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/project-templates/{project_template_id}/document-statuses": { "get": { "operationId": "Document_RetrieveStatuses", "summary": "Retrieves a list of all the document statuses in the current project", "tags": ["Document Status"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteDocumentStatus"} } } } } } }, "post": { "operationId": "Document_AddStatus", "summary": "Adds a new document status to the current project template", "description": "Only the Name field is required, but to make the new type active you should also include \"Active\": true", "tags": ["Document Status"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteDocumentStatus"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteDocumentStatus"} } } } } }, "put": { "operationId": "Document_UpdateStatus", "summary": "Updates a document status in the system", "tags": ["Document Status"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteDocumentStatus"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/project-templates/{project_template_id}/document-types": { "get": { "operationId": "Document_RetrieveTypes", "summary": "Retrieves a list of all the document types in the current project", "tags": ["Document Type"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "active_only", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "active_only", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteDocumentType"} } } } } } }, "post": { "operationId": "Document_AddType", "summary": "Adds a new document type to the current project template", "description": "Only the Name field is required, but to make the new type active you should also include \"Active\": true", "tags": ["Document Type"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteDocumentType"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteDocumentType"} } } } } }, "put": { "operationId": "Document_UpdateType", "summary": "Updates an existing document type to the current project template", "tags": ["Document Type"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteDocumentType"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/project-templates/{project_template_id}/document-types/default": { "get": { "operationId": "Document_RetrieveDefaultType", "summary": "Retrieves the default document type for the current project template", "tags": ["Document Type"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteDocumentType"} } } } } } }, "/project-templates/{project_template_id}/incidents/priorities": { "get": { "operationId": "Incident_RetrievePriorities", "summary": "Retrieves a list of the active incident priorities for the current project template", "tags": ["Incident Priority"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteIncidentPriority"} } } } } } }, "post": { "operationId": "Incident_AddPriority", "summary": "Creates a new incident priority in the specified project template in the system", "description": "The color should be provide in RRGGBB hex format", "tags": ["Incident Priority"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteIncidentPriority"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteIncidentPriority"} } } } } }, "put": { "operationId": "Incident_UpdatePriority", "summary": "Updates an existing incident priority in the specified project template in the system", "tags": ["Incident Priority"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteIncidentPriority"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/project-templates/{project_template_id}/incidents/severities": { "get": { "operationId": "Incident_RetrieveSeverities", "summary": "Retrieves a list of the active incident severities for the current project template", "tags": ["Incident Severity"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteIncidentSeverity"} } } } } } }, "post": { "operationId": "Incident_AddSeverity", "summary": "Creates a new incident severity in the specified project template in the system", "tags": ["Incident Severity"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteIncidentSeverity"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteIncidentSeverity"} } } } } }, "put": { "operationId": "Incident_UpdateSeverity", "summary": "Updates an existing incident severity in the specified project template in the system", "tags": ["Incident Severity"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteIncidentSeverity"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/project-templates/{project_template_id}/incidents/statuses": { "get": { "operationId": "Incident_RetrieveStatuses", "summary": "Retrieves a list of the active incident statuses for the current project template", "tags": ["Incident Status"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteIncidentStatus"} } } } } } }, "post": { "operationId": "Incident_AddStatus", "summary": "Creates a new incident status in the specified project template in the system", "tags": ["Incident Status"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteIncidentStatus"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteIncidentStatus"} } } } } }, "put": { "operationId": "Incident_UpdateStatus", "summary": "Updates an existing incident status in the specified project template in the system", "tags": ["Incident Status"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteIncidentStatus"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/project-templates/{project_template_id}/incidents/statuses/default": { "get": { "operationId": "Incident_RetrieveDefaultStatus", "summary": "Retrieves the default incident status for the current project template", "tags": ["Incident Status"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteIncidentStatus"} } } } } } }, "/project-templates/{project_template_id}/incidents/types": { "get": { "operationId": "Incident_RetrieveTypes", "summary": "Retrieves a list of the active incident types for the current project template", "tags": ["Incident Type"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteIncidentType"} } } } } } }, "post": { "operationId": "Incident_AddType", "summary": "Creates a new incident type in the specified project template in the system", "tags": ["Incident Type"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteIncidentType"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteIncidentType"} } } } } }, "put": { "operationId": "Incident_UpdateType", "summary": "Updates an existing incident type in the specified project template in the system", "tags": ["Incident Type"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteIncidentType"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/project-templates/{project_template_id}/incidents/types/{incident_type_id}/workflow/custom-properties": { "get": { "operationId": "Incident_RetrieveWorkflowCustomPropertiesByType", "summary": "Retrieves the list of incident custom properties and their workflow state for a given type and status/step.", "tags": ["Incident Type"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "incident_type_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "incident_status_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowCustomProperty"} } } } } } } }, "/project-templates/{project_template_id}/incidents/types/{incident_type_id}/workflow/fields": { "get": { "operationId": "Incident_RetrieveWorkflowFieldsByType", "summary": "Retrieves the list of fields and their workflow status for a given type and status/step.", "tags": ["Incident Type"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "incident_type_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "incident_status_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowField"} } } } } } } }, "/project-templates/{project_template_id}/incidents/types/default": { "get": { "operationId": "Incident_RetrieveDefaultType", "summary": "Retrieves the default incident type for the current project template", "tags": ["Incident Type"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteIncidentType"} } } } } } }, "/project-templates/{project_template_id}/incidents/workflows": { "get": { "operationId": "Incident_RetrieveWorkflows", "summary": "Retrieves all workflows for tasks in a given project template", "tags": ["Incident Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflow"} } } } } } }, "post": { "operationId": "Incident_CreateWorkflow", "summary": "Creates a new blank workflow for incidents in the specified project template", "tags": ["Incident Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteWorkflow"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteWorkflow"} } } } } } }, "/project-templates/{project_template_id}/incidents/workflows/{workflow_id}": { "get": { "operationId": "Incident_RetrieveWorkflowById", "summary": "Retrieves a single workflow object by its ID", "tags": ["Incident Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteWorkflow"} } } } } }, "put": { "operationId": "Incident_UpdateWorkflow", "summary": "Updates a single workflow object", "tags": ["Incident Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteWorkflow"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "delete": { "operationId": "Incident_DeleteWorkflow", "summary": "Deletes a workflow from a project template", "tags": ["Incident Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/project-templates/{project_template_id}/incidents/workflows/{workflow_id}/custom-properties/{incident_status_id}": { "get": { "operationId": "Incident_RetrieveWorkflowCustomProperties", "summary": "Retrieves workflow custom property states for a given artifact status", "tags": ["Incident Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "incident_status_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowCustomProperty"} } } } } } }, "put": { "operationId": "Incident_UpdateWorkflowCustomProperties", "summary": "Updates workflow custom property states for a given artifact status + workflow", "description": "FieldStateId determines the state of a given field. Here are the potential values\n 0 = Default (No workflow restrictions)\n 1 = Disabled\n 2 = Required\n 3 = Hidden", "tags": ["Incident Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "incident_status_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowCustomProperty"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/project-templates/{project_template_id}/incidents/workflows/{workflow_id}/fields/{incident_status_id}": { "get": { "operationId": "Incident_RetrieveWorkflowFields", "summary": "Retrieves the list of fields and their workflow status for a given workflow and status.", "tags": ["Incident Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "incident_status_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowField"} } } } } } }, "put": { "operationId": "Incident_UpdateWorkflowFields", "summary": "Updates a batch of workflow fields for a given status to fit the desired workflow state for all fields", "description": "FieldStateId determines the state of a given field. Here are the potential values\n 0 = Default (No workflow restrictions)\n 1 = Disabled\n 2 = Required\n 3 = Hidden", "tags": ["Incident Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "incident_status_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowField"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/project-templates/{project_template_id}/incidents/workflows/{workflow_id}/transitions": { "post": { "operationId": "Incident_CreateWorkflowTransition", "summary": "Creates a new workflow transition for a incident workflow.", "tags": ["Incident Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteWorkflowTransition"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteWorkflowTransition"} } } } } } }, "/project-templates/{project_template_id}/incidents/workflows/{workflow_id}/transitions/{incident_status_id}": { "get": { "operationId": "Incident_RetrieveWorkflowTransitions", "summary": "Retrieves all transitions from a given incident status in a specified workflow", "tags": ["Incident Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "incident_status_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowTransition"} } } } } } } }, "/project-templates/{project_template_id}/incidents/workflows/{workflow_id}/transitions/{workflow_transition_id}": { "put": { "operationId": "Incident_UpdateWorkflowTransition", "summary": "Updates a workflow transition in the same ways you can in the UI.", "tags": ["Incident Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_transition_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteWorkflowTransition"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "delete": { "operationId": "Incident_DeleteWorkflowTransition", "summary": "Deletes a workflow transition", "tags": ["Incident Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_transition_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/project-templates/{project_template_id}/releases/statuses": { "get": { "operationId": "Release_RetrieveStatuses", "summary": "Retrieves the list of release statuses in the system", "tags": ["Release Status"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteReleaseStatus"} } } } } } } }, "/project-templates/{project_template_id}/releases/types": { "get": { "operationId": "Release_RetrieveTypes", "summary": "Retrieves the list of release types in the system", "tags": ["Release Type"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteReleaseType"} } } } } } }, "put": { "operationId": "Release_UpdateType", "summary": "Updates a given release type. \n \n Currently only the WorkflowId can be edited for a release type.", "tags": ["Release Type"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteReleaseType"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/project-templates/{project_template_id}/releases/types/{release_type_id}/workflow/custom-properties": { "get": { "operationId": "Release_RetrieveWorkflowCustomPropertiesByType", "summary": "Retrieves the list of release custom properties and their workflow state for a given type and status/step.", "tags": ["Release Type"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_type_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_status_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowCustomProperty"} } } } } } } }, "/project-templates/{project_template_id}/releases/types/{release_type_id}/workflow/fields": { "get": { "operationId": "Release_RetrieveWorkflowFieldsByType", "summary": "Retrieves the list of fields and their workflow status for a given type and status/step.", "tags": ["Release Type"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_type_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_status_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowField"} } } } } } } }, "/project-templates/{project_template_id}/releases/workflows": { "get": { "operationId": "Release_RetrieveWorkflows", "summary": "Retrieves all workflows for tasks in a given project template", "tags": ["Release Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflow"} } } } } } }, "post": { "operationId": "Release_CreateWorkflow", "summary": "Creates a new blank workflow for releases in the specified project template", "tags": ["Release Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteWorkflow"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteWorkflow"} } } } } } }, "/project-templates/{project_template_id}/releases/workflows/{workflow_id}": { "get": { "operationId": "Release_RetrieveWorkflowById", "summary": "Retrieves a single workflow object by its ID", "tags": ["Release Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteWorkflow"} } } } } }, "put": { "operationId": "Release_UpdateWorkflow", "summary": "Updates a single workflow object", "tags": ["Release Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteWorkflow"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "delete": { "operationId": "Release_DeleteWorkflow", "summary": "Deletes a workflow from a project template", "tags": ["Release Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/project-templates/{project_template_id}/releases/workflows/{workflow_id}/custom-properties/{release_status_id}": { "get": { "operationId": "Release_RetrieveWorkflowCustomProperties", "summary": "Retrieves workflow custom property states for a given artifact status", "tags": ["Release Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_status_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowCustomProperty"} } } } } } }, "put": { "operationId": "Release_UpdateWorkflowCustomProperties", "summary": "Updates workflow custom property states for a given artifact status + workflow", "description": "FieldStateId determines the state of a given field. Here are the potential values\n 0 = Default (No workflow restrictions)\n 1 = Disabled\n 2 = Required\n 3 = Hidden", "tags": ["Release Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_status_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowCustomProperty"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/project-templates/{project_template_id}/releases/workflows/{workflow_id}/fields/{release_status_id}": { "get": { "operationId": "Release_RetrieveWorkflowFields", "summary": "Retrieves the list of fields and their workflow status for a given workflow and status.", "tags": ["Release Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_status_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowField"} } } } } } }, "put": { "operationId": "Release_UpdateWorkflowFields", "summary": "Updates a batch of workflow fields for a given status to fit the desired workflow state for all fields", "description": "FieldStateId determines the state of a given field. Here are the potential values\n 0 = Default (No workflow restrictions)\n 1 = Disabled\n 2 = Required\n 3 = Hidden", "tags": ["Release Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "release_status_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowField"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/project-templates/{project_template_id}/releases/workflows/{workflow_id}/transitions": { "post": { "operationId": "Release_CreateWorkflowTransition", "summary": "Creates a new workflow transition for a release workflow. Does not support NotificationSubject.", "tags": ["Release Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteWorkflowTransition"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteWorkflowTransition"} } } } } } }, "/project-templates/{project_template_id}/releases/workflows/{workflow_id}/transitions/{Release_status_id}": { "get": { "operationId": "Release_RetrieveWorkflowTransitions", "summary": "Retrieves all transitions from a given release status in a specified workflow", "tags": ["Release Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "Release_status_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowTransition"} } } } } } } }, "/project-templates/{project_template_id}/releases/workflows/{workflow_id}/transitions/{workflow_transition_id}": { "put": { "operationId": "Release_UpdateWorkflowTransition", "summary": "Updates a workflow transition in the same ways you can in the UI.", "tags": ["Release Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_transition_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteWorkflowTransition"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "delete": { "operationId": "Release_DeleteWorkflowTransition", "summary": "Deletes a workflow transition", "tags": ["Release Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_transition_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/project-templates/{project_template_id}/requirements/importances": { "get": { "operationId": "Requirement_RetrieveImportances", "summary": "Retrieves the list of requirement importances in the project template", "tags": ["Requirement Importance"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteRequirementImportance"} } } } } } }, "post": { "operationId": "Requirement_AddImportance", "summary": "Adds a new requirement importance to the project template", "tags": ["Requirement Importance"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteRequirementImportance"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteRequirementImportance"} } } } } }, "put": { "operationId": "Requirement_UpdateImportance", "summary": "Updates a requirement importance in the system", "tags": ["Requirement Importance"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteRequirementImportance"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/project-templates/{project_template_id}/requirements/statuses": { "get": { "operationId": "Requirement_RetrieveStatuses", "summary": "Retrieves the list of active requirement statuses in the system", "tags": ["Requirement Status"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteRequirementStatus"} } } } } } } }, "/project-templates/{project_template_id}/requirements/types": { "get": { "operationId": "Requirement_RetrieveTypes", "summary": "Retrieves the list of requirement types in the project template", "tags": ["Requirement Type"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteRequirementType"} } } } } } }, "post": { "operationId": "Requirement_AddType", "summary": "Adds a new requirement type to the project template", "tags": ["Requirement Type"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteRequirementType"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteRequirementType"} } } } } }, "put": { "operationId": "Requirement_UpdateType", "summary": "Updates a requirement type in the system", "tags": ["Requirement Type"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteRequirementType"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/project-templates/{project_template_id}/requirements/types/{requirement_type_id}/workflow/custom-properties": { "get": { "operationId": "Requirement_RetrieveWorkflowCustomPropertiesByType", "summary": "Retrieves the list of requirement custom properties and their workflow state for a given type and status/step.", "tags": ["Requirement Type"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "requirement_type_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "requirement_status_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowCustomProperty"} } } } } } } }, "/project-templates/{project_template_id}/requirements/types/{requirement_type_id}/workflow/fields": { "get": { "operationId": "Requirement_RetrieveWorkflowFieldsByType", "summary": "Retrieves the list of requirement fields and their workflow status for a given type and status/step.", "tags": ["Requirement Type"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "requirement_type_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "requirement_status_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowField"} } } } } } } }, "/project-templates/{project_template_id}/requirements/workflows": { "get": { "operationId": "Requirement_RetrieveWorkflows", "summary": "Retrieves all workflows for requirements in a given project template", "tags": ["Requirement Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflow"} } } } } } }, "post": { "operationId": "Requirement_CreateWorkflow", "summary": "Creates a new blank workflow for requirements in the specified project template", "tags": ["Requirement Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteWorkflow"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteWorkflow"} } } } } } }, "/project-templates/{project_template_id}/requirements/workflows/{workflow_id}": { "get": { "operationId": "Requirement_RetrieveWorkflowById", "summary": "Retrieves a single workflow object by its ID", "tags": ["Requirement Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteWorkflow"} } } } } }, "put": { "operationId": "Requirement_UpdateWorkflow", "summary": "Updates a single workflow object", "tags": ["Requirement Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteWorkflow"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "delete": { "operationId": "Requirement_DeleteWorkflow", "summary": "Deletes a workflow from a project template", "tags": ["Requirement Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/project-templates/{project_template_id}/requirements/workflows/{workflow_id}/custom-properties/{requirement_status_id}": { "get": { "operationId": "Requirement_RetrieveWorkflowCustomProperties", "summary": "Retrieves workflow custom property states for a given artifact status", "tags": ["Requirement Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "requirement_status_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowCustomProperty"} } } } } } }, "put": { "operationId": "Requirement_UpdateWorkflowCustomProperties", "summary": "Updates workflow custom property states for a given artifact status + workflow", "description": "FieldStateId determines the state of a given field. Here are the potential values\n 0 = Default (No workflow restrictions)\n 1 = Disabled\n 2 = Required\n 3 = Hidden", "tags": ["Requirement Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "requirement_status_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowCustomProperty"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/project-templates/{project_template_id}/requirements/workflows/{workflow_id}/fields/{requirement_status_id}": { "get": { "operationId": "Requirement_RetrieveWorkflowFields", "summary": "Retrieves the list of requirement fields and their workflow status for a given workflow and status.", "tags": ["Requirement Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "requirement_status_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowField"} } } } } } }, "put": { "operationId": "Requirement_UpdateWorkflowFields", "summary": "Updates a batch of workflow fields for a given status to fit the desired workflow state for all fields", "description": "FieldStateId determines the state of a given field. Here are the potential values\n 0 = Default (No workflow restrictions)\n 1 = Disabled\n 2 = Required\n 3 = Hidden", "tags": ["Requirement Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "requirement_status_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowField"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/project-templates/{project_template_id}/requirements/workflows/{workflow_id}/transitions": { "post": { "operationId": "Requirement_CreateWorkflowTransition", "summary": "Creates a new workflow transition for a requirement workflow. Does not support NotificationSubject.", "tags": ["Requirement Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteWorkflowTransition"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteWorkflowTransition"} } } } } } }, "/project-templates/{project_template_id}/requirements/workflows/{workflow_id}/transitions/{current_status_id}": { "get": { "operationId": "Requirement_RetrieveWorkflowTransitions", "summary": "Retrieves all transitions from a given requirement status in a specified workflow", "tags": ["Requirement Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "current_status_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowTransition"} } } } } } } }, "/project-templates/{project_template_id}/requirements/workflows/{workflow_id}/transitions/{workflow_transition_id}": { "put": { "operationId": "Requirement_UpdateWorkflowTransition", "summary": "Updates a workflow transition in the same ways you can in the UI.", "tags": ["Requirement Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_transition_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteWorkflowTransition"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "delete": { "operationId": "Requirement_DeleteWorkflowTransition", "summary": "Deletes a workflow transition", "tags": ["Requirement Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_transition_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/project-templates/{project_template_id}/risks/impacts": { "get": { "operationId": "Risk_RetrieveImpacts", "summary": "Retrieves the list of risk probabilities in the project template", "tags": ["Risk Impact"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteRiskImpact"} } } } } } }, "post": { "operationId": "Risk_AddImpact", "summary": "Adds a new risk impact to the project template", "tags": ["Risk Impact"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteRiskImpact"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteRiskImpact"} } } } } }, "put": { "operationId": "Risk_UpdateImpact", "summary": "Updates a risk impact in the system", "tags": ["Risk Impact"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteRiskImpact"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/project-templates/{project_template_id}/risks/probabilities": { "get": { "operationId": "Risk_RetrieveProbabilities", "summary": "Retrieves the list of risk probabilities in the project template", "tags": ["Risk Probability"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteRiskProbability"} } } } } } }, "post": { "operationId": "Risk_AddProbability", "summary": "Adds a new risk probability to the project template", "tags": ["Risk Probability"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteRiskProbability"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteRiskProbability"} } } } } }, "put": { "operationId": "Risk_UpdateProbability", "summary": "Updates a risk probability in the system", "tags": ["Risk Probability"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteRiskProbability"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/project-templates/{project_template_id}/risks/statuses": { "get": { "operationId": "Risk_RetrieveStatuses", "summary": "Retrieves the list of risk statuses in the system", "tags": ["Risk Status"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteRiskStatus"} } } } } } }, "post": { "operationId": "Risk_AddStatus", "summary": "Adds a new risk status to the project template", "description": "You cannot set the is open or the default flags with this method", "tags": ["Risk Status"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteRiskStatus"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteRiskStatus"} } } } } }, "put": { "operationId": "Risk_UpdateStatus", "summary": "Updates a risk status in the system", "tags": ["Risk Status"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteRiskStatus"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/project-templates/{project_template_id}/risks/types": { "get": { "operationId": "Risk_RetrieveTypes", "summary": "Retrieves the list of risk types in the project template", "tags": ["Risk Type"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteRiskType"} } } } } } }, "post": { "operationId": "Risk_AddType", "summary": "Adds a new risk type to the project template", "tags": ["Risk Type"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteRiskType"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteRiskType"} } } } } }, "put": { "operationId": "Risk_UpdateType", "summary": "Updates a risk type in the system", "tags": ["Risk Type"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteRiskType"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/project-templates/{project_template_id}/risks/types/{risk_type_id}/workflow/custom-properties": { "get": { "operationId": "Risk_RetrieveWorkflowCustomPropertiesByType", "summary": "Retrieves the list of risk custom properties and their workflow state for a given type and status/step.", "tags": ["Risk Type"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "risk_type_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "risk_status_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowCustomProperty"} } } } } } } }, "/project-templates/{project_template_id}/risks/types/{risk_type_id}/workflow/fields": { "get": { "operationId": "Risk_RetrieveWorkflowFieldsByType", "summary": "Retrieves the list of fields and their workflow status for a given type and status/step.", "tags": ["Risk Type"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "risk_type_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "risk_status_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowField"} } } } } } } }, "/project-templates/{project_template_id}/risks/workflows": { "get": { "operationId": "Risk_RetrieveWorkflows", "summary": "Retrieves all workflows for tasks in a given project template", "tags": ["Risk Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflow"} } } } } } }, "post": { "operationId": "Risk_CreateWorkflow", "summary": "Creates a new blank workflow for risks in the specified project template", "tags": ["Risk Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteWorkflow"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteWorkflow"} } } } } } }, "/project-templates/{project_template_id}/risks/workflows/{workflow_id}": { "get": { "operationId": "Risk_RetrieveWorkflowById", "summary": "Retrieves a single workflow object by its ID", "tags": ["Risk Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteWorkflow"} } } } } }, "put": { "operationId": "Risk_UpdateWorkflow", "summary": "Updates a single workflow object", "tags": ["Risk Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteWorkflow"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "delete": { "operationId": "Risk_DeleteWorkflow", "summary": "Deletes a workflow from a project template", "tags": ["Risk Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/project-templates/{project_template_id}/risks/workflows/{workflow_id}/custom-properties/{risk_status_id}": { "get": { "operationId": "Risk_RetrieveWorkflowCustomProperties", "summary": "Retrieves workflow custom property states for a given artifact status", "tags": ["Risk Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "risk_status_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowCustomProperty"} } } } } } }, "put": { "operationId": "Risk_UpdateWorkflowCustomProperties", "summary": "Updates workflow custom property states for a given artifact status + workflow", "description": "FieldStateId determines the state of a given field. Here are the potential values\n 0 = Default (No workflow restrictions)\n 1 = Disabled\n 2 = Required\n 3 = Hidden", "tags": ["Risk Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "risk_status_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowCustomProperty"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/project-templates/{project_template_id}/risks/workflows/{workflow_id}/fields/{risk_status_id}": { "get": { "operationId": "Risk_RetrieveWorkflowFields", "summary": "Retrieves the list of fields and their workflow status for a given workflow and status.", "tags": ["Risk Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "risk_status_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowField"} } } } } } }, "put": { "operationId": "Risk_UpdateWorkflowFields", "summary": "Updates a batch of workflow fields for a given status to fit the desired workflow state for all fields", "description": "FieldStateId determines the state of a given field. Here are the potential values\n 0 = Default (No workflow restrictions)\n 1 = Disabled\n 2 = Required\n 3 = Hidden", "tags": ["Risk Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "risk_status_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowField"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/project-templates/{project_template_id}/risks/workflows/{workflow_id}/transitions": { "post": { "operationId": "Risk_CreateWorkflowTransition", "summary": "Creates a new workflow transition for a risk workflow. Does not support NotificationSubject.", "tags": ["Risk Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteWorkflowTransition"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteWorkflowTransition"} } } } } } }, "/project-templates/{project_template_id}/risks/workflows/{workflow_id}/transitions/{risk_status_id}": { "get": { "operationId": "Risk_RetrieveWorkflowTransitions", "summary": "Retrieves all transitions from a given risk status in a specified workflow", "tags": ["Risk Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "risk_status_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowTransition"} } } } } } } }, "/project-templates/{project_template_id}/risks/workflows/{workflow_id}/transitions/{workflow_transition_id}": { "put": { "operationId": "Risk_UpdateWorkflowTransition", "summary": "Updates a workflow transition in the same ways you can in the UI.", "tags": ["Risk Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_transition_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteWorkflowTransition"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "delete": { "operationId": "Risk_DeleteWorkflowTransition", "summary": "Deletes a workflow transition", "tags": ["Risk Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_transition_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/project-templates/{project_template_id}/tasks/priorities": { "get": { "operationId": "Task_RetrievePriorities", "summary": "Retrieves the list of task priorities in the project template", "tags": ["Task Priority"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteTaskPriority"} } } } } } }, "post": { "operationId": "Task_AddPriority", "summary": "Adds a new task priority to the project template", "tags": ["Task Priority"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTaskPriority"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTaskPriority"} } } } } }, "put": { "operationId": "Task_UpdatePriority", "summary": "Updates a task priority in the system", "tags": ["Task Priority"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTaskPriority"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/project-templates/{project_template_id}/tasks/statuses": { "get": { "operationId": "Task_RetrieveStatuses", "summary": "Retrieves the list of task statuses in the system", "tags": ["Task Status"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteTaskStatus"} } } } } } } }, "/project-templates/{project_template_id}/tasks/types": { "get": { "operationId": "Task_RetrieveTypes", "summary": "Retrieves the list of task types in the project template", "tags": ["Task Type"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteTaskType"} } } } } } }, "post": { "operationId": "Task_AddType", "summary": "Adds a new task type to the project template", "tags": ["Task Type"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTaskType"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTaskType"} } } } } }, "put": { "operationId": "Task_UpdateType", "summary": "Updates a task type in the system", "tags": ["Task Type"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTaskType"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/project-templates/{project_template_id}/tasks/types/{task_type_id}/workflow/custom-properties": { "get": { "operationId": "Task_RetrieveWorkflowCustomPropertiesByType", "summary": "Retrieves the list of requirement custom properties and their workflow state for a given type and status/step.", "tags": ["Task Type"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "task_type_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "task_status_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowCustomProperty"} } } } } } } }, "/project-templates/{project_template_id}/tasks/types/{task_type_id}/workflow/fields": { "get": { "operationId": "Task_RetrieveWorkflowFieldsByType", "summary": "Retrieves the list of fields and their workflow status for a given type and status/step.", "tags": ["Task Type"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "task_type_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "task_status_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowField"} } } } } } } }, "/project-templates/{project_template_id}/tasks/workflows": { "get": { "operationId": "Task_RetrieveWorkflows", "summary": "Retrieves all workflows for tasks in a given project template", "tags": ["Task Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflow"} } } } } } }, "post": { "operationId": "Task_CreateWorkflow", "summary": "Creates a new blank workflow for tasks in the specified project template", "tags": ["Task Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteWorkflow"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteWorkflow"} } } } } } }, "/project-templates/{project_template_id}/tasks/workflows/{workflow_id}": { "get": { "operationId": "Task_RetrieveWorkflowById", "summary": "Retrieves a single workflow object by its ID", "tags": ["Task Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteWorkflow"} } } } } }, "put": { "operationId": "Task_UpdateWorkflow", "summary": "Updates a single workflow object", "tags": ["Task Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteWorkflow"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "delete": { "operationId": "Task_DeleteWorkflow", "summary": "Deletes a workflow from a project template", "tags": ["Task Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/project-templates/{project_template_id}/tasks/workflows/{workflow_id}/custom-properties/{task_status_id}": { "get": { "operationId": "Task_RetrieveWorkflowCustomProperties", "summary": "Retrieves workflow custom property states for a given artifact status", "tags": ["Task Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "task_status_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowCustomProperty"} } } } } } }, "put": { "operationId": "Task_UpdateWorkflowCustomProperties", "summary": "Updates workflow custom property states for a given artifact status + workflow", "description": "FieldStateId determines the state of a given field. Here are the potential values\n 0 = Default (No workflow restrictions)\n 1 = Disabled\n 2 = Required\n 3 = Hidden", "tags": ["Task Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "task_status_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowCustomProperty"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/project-templates/{project_template_id}/tasks/workflows/{workflow_id}/fields/{task_status_id}": { "get": { "operationId": "Task_RetrieveWorkflowFields", "summary": "Retrieves the list of fields and their workflow status for a given workflow and status.", "tags": ["Task Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "task_status_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowField"} } } } } } }, "put": { "operationId": "Task_UpdateWorkflowFields", "summary": "Updates a batch of workflow fields for a given status to fit the desired workflow state for all fields", "description": "FieldStateId determines the state of a given field. Here are the potential values\n 0 = Default (No workflow restrictions)\n 1 = Disabled\n 2 = Required\n 3 = Hidden", "tags": ["Task Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "task_status_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowField"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/project-templates/{project_template_id}/tasks/workflows/{workflow_id}/transitions": { "post": { "operationId": "Task_CreateWorkflowTransition", "summary": "Creates a new workflow transition for a task workflow. Does not support NotificationSubject.", "tags": ["Task Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteWorkflowTransition"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteWorkflowTransition"} } } } } } }, "/project-templates/{project_template_id}/tasks/workflows/{workflow_id}/transitions/{task_status_id}": { "get": { "operationId": "Task_RetrieveWorkflowTransitions", "summary": "Retrieves all transitions from a given task status in a specified workflow", "tags": ["Task Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "task_status_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowTransition"} } } } } } } }, "/project-templates/{project_template_id}/tasks/workflows/{workflow_id}/transitions/{workflow_transition_id}": { "put": { "operationId": "Task_UpdateWorkflowTransition", "summary": "Updates a workflow transition in the same ways you can in the UI.", "tags": ["Task Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_transition_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteWorkflowTransition"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "delete": { "operationId": "Task_DeleteWorkflowTransition", "summary": "Deletes a workflow transition", "tags": ["Task Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_transition_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/project-templates/{project_template_id}/test-cases/priorities": { "get": { "operationId": "TestCase_RetrievePriorities", "summary": "Retrieves the list of testCase priorities in the project template", "tags": ["Test Case Priority"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteTestCasePriority"} } } } } } }, "post": { "operationId": "TestCase_AddPriority", "summary": "Adds a new test case priority to the project template", "tags": ["Test Case Priority"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTestCasePriority"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTestCasePriority"} } } } } }, "put": { "operationId": "TestCase_UpdatePriority", "summary": "Updates a test case priority in the system", "tags": ["Test Case Priority"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTestCasePriority"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/project-templates/{project_template_id}/test-cases/statuses": { "get": { "operationId": "TestCase_RetrieveStatuses", "summary": "Retrieves the list of testCase statuses in the system", "tags": ["Test Case Status"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteTestCaseStatus"} } } } } } } }, "/project-templates/{project_template_id}/test-cases/types": { "get": { "operationId": "TestCase_RetrieveTypes", "summary": "Retrieves the list of testCase types in the project template", "tags": ["Test Case Type"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteTestCaseType"} } } } } } }, "post": { "operationId": "TestCase_AddType", "summary": "Adds a new test case type to the project template", "tags": ["Test Case Type"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTestCaseType"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTestCaseType"} } } } } }, "put": { "operationId": "TestCase_UpdateType", "summary": "Updates a test case type in the system", "tags": ["Test Case Type"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTestCaseType"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/project-templates/{project_template_id}/test-cases/types/{test_case_type_id}/workflow/custom-properties": { "get": { "operationId": "TestCase_RetrieveWorkflowCustomPropertiesByType", "summary": "Retrieves the list of testCase custom properties and their workflow state for a given type and status/step.", "tags": ["Test Case Type"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_case_type_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_case_status_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowCustomProperty"} } } } } } } }, "/project-templates/{project_template_id}/test-cases/types/{test_case_type_id}/workflow/fields": { "get": { "operationId": "TestCase_RetrieveWorkflowFieldsByType", "summary": "Retrieves the list of fields and their workflow status for a given type and status/step.", "tags": ["Test Case Type"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_case_type_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_case_status_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowField"} } } } } } } }, "/project-templates/{project_template_id}/test-cases/workflows": { "get": { "operationId": "TestCase_RetrieveWorkflows", "summary": "Retrieves all workflows for tasks in a given project template", "tags": ["Test Case Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflow"} } } } } } }, "post": { "operationId": "TestCase_CreateWorkflow", "summary": "Creates a new blank workflow for testCases in the specified project template", "tags": ["Test Case Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteWorkflow"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteWorkflow"} } } } } } }, "/project-templates/{project_template_id}/test-cases/workflows/{workflow_id}": { "get": { "operationId": "TestCase_RetrieveWorkflowById", "summary": "Retrieves a single workflow object by its ID", "tags": ["Test Case Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteWorkflow"} } } } } }, "put": { "operationId": "TestCase_UpdateWorkflow", "summary": "Updates a single workflow object", "tags": ["Test Case Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteWorkflow"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "delete": { "operationId": "TestCase_DeleteWorkflow", "summary": "Deletes a workflow from a project template", "tags": ["Test Case Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/project-templates/{project_template_id}/test-cases/workflows/{workflow_id}/custom-properties/{test_case_status_id}": { "get": { "operationId": "TestCase_RetrieveWorkflowCustomProperties", "summary": "Retrieves workflow custom property states for a given artifact status", "tags": ["Test Case Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_case_status_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowCustomProperty"} } } } } } }, "put": { "operationId": "TestCase_UpdateWorkflowCustomProperties", "summary": "Updates workflow custom property states for a given artifact status + workflow", "description": "FieldStateId determines the state of a given field. Here are the potential values\n 0 = Default (No workflow restrictions)\n 1 = Disabled\n 2 = Required\n 3 = Hidden", "tags": ["Test Case Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_case_status_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowCustomProperty"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/project-templates/{project_template_id}/test-cases/workflows/{workflow_id}/fields/{test_case_status_id}": { "get": { "operationId": "TestCase_RetrieveWorkflowFields", "summary": "Retrieves the list of fields and their workflow status for a given workflow and status.", "tags": ["Test Case Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_case_status_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowField"} } } } } } }, "put": { "operationId": "TestCase_UpdateWorkflowFields", "summary": "Updates a batch of workflow fields for a given status to fit the desired workflow state for all fields", "description": "FieldStateId determines the state of a given field. Here are the potential values\n 0 = Default (No workflow restrictions)\n 1 = Disabled\n 2 = Required\n 3 = Hidden", "tags": ["Test Case Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "test_case_status_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowField"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/project-templates/{project_template_id}/test-cases/workflows/{workflow_id}/transitions": { "post": { "operationId": "TestCase_CreateWorkflowTransition", "summary": "Creates a new workflow transition for a testCase workflow. Does not support NotificationSubject.", "tags": ["Test Case Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteWorkflowTransition"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteWorkflowTransition"} } } } } } }, "/project-templates/{project_template_id}/test-cases/workflows/{workflow_id}/transitions/{testcase_status_id}": { "get": { "operationId": "TestCase_RetrieveWorkflowTransitions", "summary": "Retrieves all transitions from a given testCase status in a specified workflow", "tags": ["Test Case Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "testcase_status_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteWorkflowTransition"} } } } } } } }, "/project-templates/{project_template_id}/test-cases/workflows/{workflow_id}/transitions/{workflow_transition_id}": { "put": { "operationId": "TestCase_UpdateWorkflowTransition", "summary": "Updates a workflow transition in the same ways you can in the UI.", "tags": ["Test Case Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_transition_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteWorkflowTransition"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "delete": { "operationId": "TestCase_DeleteWorkflowTransition", "summary": "Deletes a workflow transition", "tags": ["Test Case Workflow"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "project_template_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "workflow_transition_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/project-templates/blank": { "post": { "operationId": "ProjectTemplate_CreateBlank", "summary": "Creates a blank project template (This template will not be functional without admin configuration of at least types, statuses and workflows for all artifacts.)", "tags": ["Project Template"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteProjectTemplate"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteProjectTemplate"} } } } } } }, "/query": { "post": { "operationId": "Reports_RetrieveESQLQueryData", "summary": "Returns the grid of data from a specific custom graph created by an administrator", "description": "You need to be a system administrator to be able to call this API method\n (for safety since query can be across all artifacts, projects and programs).", "tags": ["Custom Query"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/String"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTableData"} } } } } } }, "/requirements": { "get": { "operationId": "Requirement_RetrieveForOwner", "summary": "Retrieves all requirements owned by the currently authenticated user", "tags": ["Requirement"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteRequirement"} } } } } } } }, "/risks": { "get": { "operationId": "Risk_RetrieveForOwner", "summary": "Retrieves all risks owned by the currently authenticated user", "tags": ["Risk"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteRisk"} } } } } } } }, "/saved-filters": { "get": { "operationId": "SavedFilter_RetrieveForUser", "summary": "Retrieves the list of saved filters for the current user", "tags": ["Saved Filters"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteSavedFilter"} } } } } } }, "put": { "operationId": "SavedFilter_Update", "summary": "Updates a list page saved filter which is owned by the modifying user. Only the Name, IsShared, and Entries properties can be updated. Use a int value of -999 for (none) option. \n \n This API endpoint will let you create invalid saved filters, and this will throw an error on artifact list pages when applied or always return empty results. \n It is recommended to primarily use this endpoint to update existing filtered fields (Such as updating a ReleaseId within a saved filter to a new release at the beginning of a sprint)\n \n In order to influence which columns are viewable and their order, you should modify filters with property names formatted as \"_{FieldName}\", and set the StringValue to \"Y_0\" or \"N_0\" to declare Yes or No for displaying that property. \n The 0 should be replaced with numbers which convey the order of displayable fields. The UI uses 1 through X where X is the total number of fields, but it is arbitrary. A lower number makes the column closer to the left on the list page.\n \n This can be done alongside a filtered field with a property name formatted as \"{FieldName}\" for the same field, and the one without the underscore (_) should contain the filter value instead of the display order information. \n Do not try to put both the \"Y_0\" and the actual filter value in the same RemoteFilter object (the objects in \"Filters\") as that will not work.", "tags": ["Saved Filters"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteSavedFilter"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/source-code/providers": { "get": { "operationId": "SourceCode_RetrieveProviders", "summary": "Retrieves all source code provider system level configurations", "tags": ["Source Code Providers"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteSystemSourceCodeProvider"} } } } } } }, "post": { "operationId": "SourceCode_CreateProvider", "summary": "Creates a new system level source code provider configuration - needs to have at least Name, ConnectionInfo, Login, and Password populated", "tags": ["Source Code Providers"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteSystemSourceCodeProvider"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteSystemSourceCodeProvider"} } } } } }, "put": { "operationId": "SourceCode_UpdateProvider", "summary": "Overwrites a system level provider which already exists - needs to have at least Name, ConnectionInfo, Login, and Password populated. Will overwrite every field, even if left blank or omitted.", "tags": ["Source Code Providers"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteSystemSourceCodeProvider"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/source-code/providers/{version_control_system_id}": { "get": { "operationId": "SourceCode_RetrieveProviderById", "summary": "Retrieves a source code system configuration by it's VersionControlSystemId", "tags": ["Source Code Providers"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "version_control_system_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteSystemSourceCodeProvider"} } } } } }, "delete": { "operationId": "SourceCode_DeleteProvider", "summary": "Completely deletes a source code provider from the system. This will hard delete all system and product configurations for this particular provider.", "tags": ["Source Code Providers"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "version_control_system_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/source-code/providers/{version_control_system_id}/projects": { "get": { "operationId": "SourceCode_RetrieveProductProviderConfigsBySystemId", "summary": "Retrieves the list of product configurations for a given provider.", "tags": ["Source Code Provider Products"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "version_control_system_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteProductSourceCodeProvider"} } } } } } } }, "/source-code/providers/{version_control_system_id}/test": { "get": { "operationId": "SourceCode_TestSystemProviderConfiguration", "summary": "Tests whether the credentials configured for the specified source code provider can make a successful connection / see the configured repository", "tags": ["Source Code Providers"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "version_control_system_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/Boolean"} } } } } } }, "/subscriptions": { "get": { "operationId": "Subscription_RetrieveForUser", "summary": "Retrieves a list of all the items the current user is subscribed to (all projects)", "tags": ["Subscriptions"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteArtifactSubscription"} } } } } } } }, "/system/artifact-types/{artifact_type_id}/{artifact_id}/project-id": { "get": { "operationId": "System_GetProjectIdForArtifact", "summary": "Returns the project ID number that the queried artifact exists in.", "tags": ["System"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "artifact_type_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "artifact_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/Int32"} } } } } } }, "/system/artifact-types/{navigation_link_id}/project/{project_id}/artifact/{artifact_id}": { "get": { "operationId": "System_GetArtifactUrl", "summary": "Returns the application-relative URL to a particular artifact in the system", "tags": ["System"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "navigation_link_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "artifact_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "tab_name", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "tab_name", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/String"} } } } } } }, "/system/custom-lists": { "get": { "operationId": "SystemCustomProperty_RetrieveCustomLists", "summary": "Retrieves all the custom lists in the current project template", "description": "Does not return the actual custom list values", "tags": ["System Custom List"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteSystemCustomList"} } } } } } }, "post": { "operationId": "SystemCustomProperty_CreateCustomList", "summary": "Creates a new system level custom list. Does not handle creating the custom list values, that has a separate endpoint.", "tags": ["System Custom List"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteSystemCustomList"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteSystemCustomList"} } } } } }, "put": { "operationId": "SystemCustomProperty_UpdateCustomList", "summary": "Updates a system custom list's name, active status, and/or sort option (SortedOnValue = true sorts alphabetically, SortedOnValue = false sorts by ID)", "tags": ["System Custom List"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteSystemCustomList"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/system/custom-lists/{custom_list_id}": { "get": { "operationId": "SystemCustomProperty_RetrieveCustomListById", "summary": "Retrieves a custom list by its ID, including any custom list values", "tags": ["System Custom List"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "custom_list_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteSystemCustomList"} } } } } }, "delete": { "operationId": "SystemCustomProperty_DeleteCustomList", "summary": "Deletes a system custom list from the database", "tags": ["System Custom List"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "custom_list_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/system/custom-lists/{custom_list_id}/values": { "post": { "operationId": "SystemCustomProperty_AddCustomListValues", "summary": "Adds a custom list value to a specified custom list", "tags": ["System Custom List"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "custom_list_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteSystemCustomListValue"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteSystemCustomListValue"} } } } } } } }, "/system/custom-lists/{custom_list_value_id}/values": { "delete": { "operationId": "SystemCustomProperty_RemoveCustomListValue", "summary": "Deletes a system custom list value", "tags": ["System Custom List"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "custom_list_value_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/system/custom-properties/{artifact_type_name}": { "get": { "operationId": "SystemCustomProperty_RetrieveForArtifactType", "summary": "Retrieves the list of custom properties configured for the current project template and the specified artifact type", "description": "1) Includes the custom list and custom list value child objects\n 2) The custom list values objects will include both active and inactive values, so need to check the flag before displaying", "tags": ["System Custom Property"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "artifact_type_name", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteSystemCustomProperty"} } } } } } }, "post": { "operationId": "SystemCustomProperty_Create", "summary": "Creates a new system custom property", "description": "'Project', 'ProgramMilestone', and 'Capability' are examples how the artifact names are expected to be formatted.", "tags": ["System Custom Property"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "artifact_type_name", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "custom_list_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "custom_list_id", "in": "query", "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteSystemCustomProperty"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteSystemCustomProperty"} } } } } }, "put": { "operationId": "SystemCustomProperty_Update", "summary": "Creates a new system custom property", "description": "'Project', 'ProgramMilestone', 'Capability' are some examples of how the artifact name is expected to be formatted.", "tags": ["System Custom Property"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "artifact_type_name", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteSystemCustomProperty"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/system/custom-properties/{artifact_type_name}/{property_number}": { "delete": { "operationId": "SystemCustomProperty_Delete", "summary": "Deletes a custom property definition from a system artifact", "tags": ["System Custom Property"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "artifact_type_name", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "property_number", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/system/events/search": { "post": { "operationId": "System_RetrieveEvents", "summary": "Retrieves a filtered list of event logs from across the system", "description": "Filter on EVENT TYPE: use the following ints: Error = 1, Warning = 2, Information = 4, SuccessAudit = 8, FailureAudit = 16\n (example: [{ \"PropertyName\": \"EventTypeId\", \"IntValue\": 2 }]). \n Filter on DATE TIME: specify a datetime - this works with just the date (recommended).\n (example: [{\"PropertyName\": \"EventTimeUtc\", \"StringValue\": \"2021-03-03\"}]).\n Filter on CATEGORY example: [{ \"PropertyName\": \"EventCategory\", \"StringValue\": \"Application\" }].\n Filter on CODE example: [{ \"PropertyName\": \"EventCode\", \"IntValue\": 0 }].\n Filter on MESSAGE example: [{ \"PropertyName\": \"Message\", \"StringValue\": \"Database violation\" }].\n Filter on DETAILS example: [{ \"PropertyName\": \"Details\", \"StringValue\": \"System.Net\" }].", "tags": ["System"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "starting_row", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_field", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_direction", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "starting_row", "in": "query", "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "query", "schema": {"type": "string"} }, { "name": "sort_field", "in": "query", "schema": {"type": "string"} }, { "name": "sort_direction", "in": "query", "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteFilter"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteEvent2"} } } } } } } }, "/system/notifications": { "post": { "operationId": "System_ProcessNotifications", "summary": "Executes any scheduled notification events", "tags": ["System"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/system/product-version": { "get": { "operationId": "System_GetProductVersion", "summary": "Retrieves the version number of the current installation.", "tags": ["System"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteVersion"} } } } } } }, "/system/settings": { "get": { "operationId": "System_GetSettings", "summary": "Returns the current configuration settings for the installation.", "description": "The user counts are returned even if not authenticated, since needed by the hosting monitoring service", "tags": ["System"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteSetting"} } } } } } }, "put": { "operationId": "System_UpdateSettings", "summary": "Forces Spira to reload any potentially changed system settings.", "tags": ["System"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/system/settings/product-name": { "get": { "operationId": "System_GetProductName", "summary": "Gets the brand name of the product installed", "tags": ["System"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/String"} } } } } } }, "/system/settings/server-date-time": { "get": { "operationId": "System_GetServerDateTime", "summary": "Retrieves the current date-time on the server converted into UTC", "tags": ["System"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/DateTime"} } } } } } }, "/system/settings/web-server-url": { "get": { "operationId": "System_GetWebServerUrl", "summary": "Gets the base URL of the website that the system is running under. Used for notifications and exported artifacts", "tags": ["System"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/String"} } } } } } }, "/tasks": { "get": { "operationId": "Task_RetrieveForOwner", "summary": "Retrieves all tasks owned by the currently authenticated user", "tags": ["Task"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteTask"} } } } } } } }, "/test-cases": { "get": { "operationId": "TestCase_RetrieveForOwner", "summary": "Retrieves all testCases owned by the currently authenticated user", "tags": ["Test Case"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteTestCase"} } } } } } } }, "/test-sets": { "get": { "operationId": "TestSet_RetrieveForOwner", "summary": "Retrieves all testSets owned by the currently authenticated user", "tags": ["Test Set"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteTestSet"} } } } } } } }, "/timesheets": { "post": { "operationId": "Timesheet_Retrieve", "summary": "Retrieves a list of timesheets in the system that match the provided filter/sort. \n \n If a user lacks permissions to view other users timesheets, a filter of the authenticated user ID will be applied.\n \n This does not apply timezone offsets to filters, so all times are expected in UTC. This is to support filtering by start/end date being more straightforward.", "tags": ["Timesheets"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "starting_row", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_field", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_direction", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "starting_row", "in": "query", "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "query", "schema": {"type": "string"} }, { "name": "sort_field", "in": "query", "schema": {"type": "string"} }, { "name": "sort_direction", "in": "query", "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteFilter"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteTimesheet"} } } } } } }, "get": { "operationId": "Timesheet_RetrieveForOwner", "summary": "Retrieves all timesheets owned by the currently authenticated user", "tags": ["Timesheets"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteTimesheet"} } } } } } }, "put": { "operationId": "Timesheet_Update", "summary": "Updates a timesheet in the system", "tags": ["Timesheets"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTimesheet"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/timesheets/{timesheet_id}": { "get": { "operationId": "Timesheet_RetrieveById", "summary": "Retrieves a single timesheet in the system", "tags": ["Timesheets"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "timesheet_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTimesheet"} } } } } }, "delete": { "operationId": "Timesheet_Delete", "summary": "Deletes a timesheet in the system", "tags": ["Timesheets"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "timesheet_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/timesheets/{timesheet_id}/entries": { "get": { "operationId": "TimesheetEntry_RetrieveByTimesheet", "summary": "Retrieves a list of timesheet entries which belong to a given timesheet ID", "tags": ["Timesheet Entries"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "timesheet_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteTimesheetEntry"} } } } } } } }, "/timesheets/entries": { "post": { "operationId": "TimesheetEntry_Create", "summary": "Creates a new timesheet entry in the system", "tags": ["Timesheet Entries"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTimesheetEntry"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTimesheetEntry"} } } } } }, "put": { "operationId": "TimesheetEntry_Update", "summary": "Updates a timesheet entry in the system", "tags": ["Timesheet Entries"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTimesheetEntry"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/timesheets/entries/{timesheet_entry_id}": { "get": { "operationId": "TimesheetEntry_RetrieveById", "summary": "Retrieves a single timesheet entry in the system", "tags": ["Timesheet Entries"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "timesheet_entry_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTimesheetEntry"} } } } } }, "delete": { "operationId": "TimesheetEntry_Delete", "summary": "Deletes a timesheet entry in the system", "tags": ["Timesheet Entries"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "timesheet_entry_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/timesheets/entries/search": { "post": { "operationId": "TimesheetEntry_RetrieveSearch", "summary": "Retrieves a list of timesheet entries in the system that match the provided filter/sort", "tags": ["Timesheet Entries"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "starting_row", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_field", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "sort_direction", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "starting_row", "in": "query", "schema": {"type": "string"} }, { "name": "number_of_rows", "in": "query", "schema": {"type": "string"} }, { "name": "sort_field", "in": "query", "schema": {"type": "string"} }, { "name": "sort_direction", "in": "query", "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteFilter"} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteTimesheetEntry"} } } } } } } }, "/timesheets/new": { "post": { "operationId": "Timesheet_Create", "summary": "Creates a new timesheet in the system", "tags": ["Timesheets"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "timesheet_date", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "timesheet_date", "in": "query", "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTimesheet"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteTimesheet"} } } } } } }, "/timesheets/statuses": { "get": { "operationId": "TimesheetStatus_Retrieve", "summary": "Retrieves a list of timesheet statuses in the system", "tags": ["Timesheet Status"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "active_only", "in": "path", "required": true, "schema": {"type": "boolean"} }, { "name": "active_only", "in": "query", "schema": {"type": "boolean"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteTimesheetStatus"} } } } } } } }, "/users": { "post": { "operationId": "User_Create", "summary": "Creates a new user in the system and adds them to the current project as the specified role.\n If a user by the same UserName already exists, the ID of that existing user will be returned.", "tags": ["User"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "password", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "password_question", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "password_answer", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "project_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "project_role_id", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "password", "in": "query", "schema": {"type": "string"} }, { "name": "password_question", "in": "query", "schema": {"type": "string"} }, { "name": "password_answer", "in": "query", "schema": {"type": "string"} }, { "name": "project_id", "in": "query", "schema": {"type": "string"} }, { "name": "project_role_id", "in": "query", "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteUser"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteUser"} } } } } }, "get": { "operationId": "User_Retrieve", "summary": "Retrieves the details of the current, authenticated user", "tags": ["User"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteUser"} } } } } } }, "/users/{user_id}": { "get": { "operationId": "User_RetrieveById", "summary": "Retrieves a single user in the system", "tags": ["User"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteUser"} } } } } }, "delete": { "operationId": "User_Delete", "summary": "Tries to delete the specified user ID. Note that this function will fail if any other foreign keys (fields) in other tables are assigned to the user that is specified.) Must be connected to the API as the root Administrator.", "tags": ["User"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "put": { "operationId": "User_Update", "summary": "Updates an existing user in the system", "tags": ["User"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "requestBody": { "required": true, "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteUser"} } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/users/all": { "get": { "operationId": "User_RetrieveAll", "summary": "Retrieves a list of users in the system", "description": "Returns users across all projects, active and inactive users, approved and not approved users", "tags": ["User"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "include_inactive", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "start_row", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "number_rows", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "include_inactive", "in": "query", "schema": {"type": "string"} }, { "name": "start_row", "in": "query", "schema": {"type": "string"} }, { "name": "number_rows", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteUser"} } } } } } } }, "/users/contacts": { "get": { "operationId": "User_RetrieveContacts", "summary": "Retrieves the list of contacts for the current user", "tags": ["User Contact"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/RemoteUser"} } } } } } } }, "/users/contacts/{user_id}": { "post": { "operationId": "User_AddContact", "summary": "Adds a user as a contact", "tags": ["User Contact"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } }, "delete": { "operationId": "User_RemoveContact", "summary": "Removes a user as a contact", "tags": ["User Contact"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"type": "object"} } } } } } }, "/users/usernames/{user_name}": { "get": { "operationId": "User_RetrieveByUserName", "summary": "Retrieves a single user in the system by user-name", "tags": ["User"], "security": [{"basicAuth": []}, {"apiKeyHeader": []}], "parameters": [ { "name": "user_name", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "include_inactive", "in": "path", "required": true, "schema": {"type": "string"} }, { "name": "include_inactive", "in": "query", "schema": {"type": "string"} } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/RemoteUser"} } } } } } } } }