Work Item Models API Documentation

Overview

This document provides an overview of the Work Item Models API, including endpoint details, request/response formats, and examples.

Authentication

All API requests require authentication via a Bearer token. Include the following header in your requests:

Authorization: Bearer <token>

Endpoints

List Work Item Models

Endpoint: /workitemmodels/list

Method: POST

Description: Lists all work item models.

Request Headers:

• Authorization: Bearer <token>

Request Body:

{
  "filter": {
    "status": "active"
  }
}

Response:

{
  "items": [
    {
      "id": "12345",
      "name": "Model A",
      "status": "active"
    }
  ]
}

Response Codes:

• 200 OK: Success

• 401 Unauthorized: Invalid or missing token

• 500 Internal Server Error: Server encountered an error

Models

WorkItemModel

Properties:

• id (string): Unique identifier of the work item model.

• name (string): Name of the work item model.

• status (string): Status of the work item model (e.g., active, inactive).

Examples

Example Request

POST /workitemmodels/list HTTP/1.1
Host: api.example.com
Authorization: Bearer <token>
Content-Type: application/json

{
  "filter": {
    "status": "active"
  }
}

Example Response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "items": [
    {
      "id": "12345",
      "name": "Model A",
      "status": "active"
    }
  ]
}

Error Handling

Common Errors

• 401 Unauthorized: The request requires user authentication.

• 500 Internal Server Error: An error occurred on the server.