GET/desk/api/v2/meta/resources/:name

Get one resource's manifest entry, by its plural name (tickets, tags).

A .json suffix is accepted and ignored, so that the entry for a resource can be fetched by the same name its listing endpoint is spelled with.

Responses

Code
200
Type
object
Schema
Description
200 OK
ManifestResource is one registered resource's entry.
Code
404
Type
object
Schema
Description
404 Not Found
Error represents an occurrence of an error in the API.

Examples

200 OK

ManifestResource

{
  "examples": {
    "aggregate": [
      "string"
    ],
    "fields": [
      "string"
    ],
    "filter": [
      "string"
    ],
    "groupBy": [
      "string"
    ],
    "having": [
      "string"
    ],
    "orderBy": [
      "string"
    ],
    "request": "string"
  },
  "fields": [
    {
      "column": "string",
      "computed": true,
      "enum": [
        "string"
      ],
      "in": "string",
      "indexed": true,
      "name": "string",
      "notes": "string",
      "nullable": true,
      "queryOnly": true,
      "readonly": true,
      "relatedTo": "string",
      "type": "string"
    }
  ],
  "idField": "string",
  "includeSections": {
    "additionalProp": "string"
  },
  "includes": [
    "string"
  ],
  "indexes": {
    "tuples": [
      [
        "string"
      ]
    ]
  },
  "name": "string",
  "parameters": {
    "aggregate": {
      "notes": "string",
      "syntax": "string"
    },
    "fields": {
      "notes": "string",
      "syntax": "string"
    },
    "filter": {
      "notes": "string",
      "syntax": "string"
    },
    "groupBy": {
      "notes": "string",
      "syntax": "string"
    },
    "having": {
      "notes": "string",
      "syntax": "string"
    },
    "id": {
      "notes": "string",
      "syntax": "string"
    },
    "ids": {
      "notes": "string",
      "syntax": "string"
    },
    "includes": {
      "notes": "string",
      "syntax": "string"
    },
    "notes": "string",
    "orderBy": {
      "notes": "string",
      "syntax": "string"
    },
    "orderMode": {
      "notes": "string",
      "syntax": "string"
    },
    "page": {
      "notes": "string",
      "syntax": "string"
    },
    "pageOffset": {
      "notes": "string",
      "syntax": "string"
    },
    "pageSize": {
      "notes": "string",
      "syntax": "string"
    },
    "skipAggregation": {
      "notes": "string",
      "syntax": "string"
    }
  },
  "path": "string",
  "sortOnly": [
    "string"
  ],
  "vocabulary": {
    "addressable": "string",
    "aggregations": [
      "string"
    ],
    "column": "string",
    "examples": "string",
    "grouping": {
      "aliases": "string",
      "buckets": [
        "string"
      ],
      "dates": "string",
      "having": {
        "notes": "string",
        "operators": [
          "string"
        ]
      },
      "maxGroups": 0,
      "maxKeys": 0,
      "maxMeasures": 0,
      "response": "string"
    },
    "indexes": "string",
    "multiValue": "string",
    "operatorNotes": {
      "additionalProp": "string"
    },
    "operators": [
      "string"
    ],
    "selectable": "string"
  }
}

Download Swagger