External Reference Types

Creates an external reference type

Changed on

Creates a type for use in external_references. If the organization already has a type with this slug, it is returned unchanged with 200; otherwise it is created and returned with 201. Reserved names are rejected.

post/external-reference-types

Request

Request body

slugstring required

The type value used in external_references. No whitespace; case-sensitive.

namestring required

Label shown in Rillet. At least 3 characters.

Example request

{
  "slug": "xyzSystemId",
  "name": "XYZ System ID"
}

Response

Already existed; returned unchanged

idstring uuid required
slugstring required

The type value used in external_references.

namestring required

Label shown in Rillet.

Example response

{
  "id": "0199e21a-14c2-7abc-9d3e-112233445566",
  "slug": "xyzSystemId",
  "name": "XYZ System ID"
}

Changes