Resource: Custom Field ( /api/customfield/{name} )

Custom field resource

Methods

GET

Retrieves a custom field by its identifier.

Status Codes

These are the expected status codes returned by the service - in addition, some other status codes may be returned if either an internal error occurs or there is an authentication issue (such as an expired OAuth token).

StatusDescription
200 - OKReturned if the request was completed successfully.
404 - NotFoundReturned if the custom field type does not exist.

Example - GET

Example of retrieving a custom field by its name.

Request Headers

KeyValueDescription
Acceptapplication/json

Request Parameters

KeyValueDescription
{name}IsRegressionThe name of the custom field to retrieve.

Response Headers

KeyValueDescription
Content-Typeapplication/json; charset=utf-8

Response Body

{
  "Id": "4b4329a0-44a3-4e3c-a527-6973bb2b063b",
  "Name": "IsRegression",
  "CustomFieldTypeName": "Checkbox",
  "Label": "Is Regression?",
  "Description": null,
  "Required": false,
  "Entities": [
    "TestScript",
    "Requirement",
    "Incident"
  ],
  "Scopes": [
    {
      "Type": "Project",
      "Id": "d17289f6-8f43-4074-88d0-3841f9830b19",
      "Name": "Test Project"
    }
  ],
  "Expands": [
    "Configuration",
    "Options",
    "Type"
  ],
  "Self": "http://localhost/api/customfield/IsRegression",
  "Links": [
    {
      "Href": "http://localhost/api/customfieldtype/checkbox",
      "Rel": "CustomFieldType"
    }
  ]
}

Status Code

200 - OK

  • No labels