Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateBacklogTask

Creates a new backlog task in the specified agent space

Request Syntax


POST /backlog/agent-space/agentSpaceId/tasks HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "description": "string",
   "priority": "string",
   "reference": { 
      "associationId": "string",
      "referenceId": "string",
      "referenceUrl": "string",
      "system": "string",
      "title": "string"
   },
   "taskType": "string",
   "title": "string"
}

URI Request Parameters

The request uses the following URI parameters.

agentSpaceId

The unique identifier for the agent space where the task will be created

Pattern: [a-zA-Z0-9-]{1,64}

Required: Yes

Request Body

The request accepts the following data in JSON format.

clientToken

Client-provided token for idempotent operations

Type: String

Required: No

description

Optional detailed description of the task

Type: String

Length Constraints: Minimum length of 0. Maximum length of 10000.

Required: No

priority

The priority level of the task

Type: String

Valid Values: CRITICAL | HIGH | MEDIUM | LOW | MINIMAL

Required: Yes

reference

Optional reference information for the task

Type: ReferenceInput object

Required: No

taskType

The type of task being created

Type: String

Valid Values: INVESTIGATION | EVALUATION

Required: Yes

title

The title of the backlog task

Type: String

Length Constraints: Minimum length of 1. Maximum length of 400.

Required: Yes

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "task": { 
      "agentSpaceId": "string",
      "createdAt": "string",
      "description": "string",
      "executionId": "string",
      "hasLinkedTasks": boolean,
      "metadata": JSON value,
      "primaryTaskId": "string",
      "priority": "string",
      "reference": { 
         "associationId": "string",
         "referenceId": "string",
         "referenceUrl": "string",
         "system": "string",
         "title": "string"
      },
      "status": "string",
      "statusReason": "string",
      "supportMetadata": JSON value,
      "taskId": "string",
      "taskType": "string",
      "title": "string",
      "updatedAt": "string",
      "version": number
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

task

The newly created task object

Type: Task object

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

Access to the requested resource is denied due to insufficient permissions.

message: Detailed error message describing why access was denied.

HTTP Status Code: 403

ConflictException

The request conflicts with the current state of the resource.

message: Detailed error message describing the conflict.

HTTP Status Code: 409

ContentSizeExceededException

This exception is thrown when the content size exceeds the allowed limit.

HTTP Status Code: 413

InternalServerException

This exception is thrown when an unexpected error occurs in the processing of a request.

HTTP Status Code: 500

InvalidParameterException

One or more parameters provided in the request are invalid.

message: Detailed error message describing which parameter is invalid and why.

HTTP Status Code: 400

ResourceNotFoundException

The requested resource could not be found.

message: Detailed error message describing which resource was not found.

HTTP Status Code: 404

ServiceQuotaExceededException

The request would exceed the service quota limit.

message: Detailed error message describing which quota was exceeded.

HTTP Status Code: 402

ThrottlingException

The request was throttled due to too many requests. Please slow down and try again.

message: Detailed error message describing the throttling condition.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by the service.

fieldList: A list of specific failures encountered while validating the input. A member can appear in this list more than once if it failed to satisfy multiple constraints.
message: A summary of the validation failure.

HTTP Status Code: 400