About API: Get type

Method

GET

Path

/qrs/about/api/default/[type]?listentries={listentries}

Description

Get an entity, initialized with default values, of a specific [type]. Optionally, select if the objects that are referenced by the entities are to be initialized by default or set to null.

Body

-

Return value

When {listentries} is set to true, the initialized objects are included. The following is an example of what the stream type would look like:

{
  "id": "00000000-0000-0000-0000-000000000000",
  "createdDate": "1753-01-01T00:00:00Z",
  "modifiedDate": "1753-01-01T00:00:00Z",
  "modifiedByUserName": "",
  "owner": {
    "id": "00000000-0000-0000-0000-000000000000",
    "userId": "",
    "userDirectory": "",
    "name": "",
    "privileges": null
  },
  "customProperties": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "createdDate": "1753-01-01T00:00:00Z",
      "modifiedDate": "1753-01-01T00:00:00Z",
      "modifiedByUserName": "",
      "value": "",
      "definition": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "",
        "valueType": "Text",
        "choiceValues": [],
        "privileges": null
      },
      "schemaPath": "CustomPropertyValue"
    }
  ],
  "name": "",
  "tags": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "",
      "privileges": null
   }
  ],
  "privileges": null,
  "schemaPath": "Stream"
}

When {listentries} is set to false, the initialized objects are excluded. The following is an example of what the stream type would look like:

{
  "id": "00000000-0000-0000-0000-000000000000",
  "createdDate": "1753-01-01T00:00:00Z",
  "modifiedDate": "1753-01-01T00:00:00Z",
  "modifiedByUserName": "",
  "owner": null,
  "customProperties": [],
  "name": "",
  "tags": [],
  "privileges": null,
  "schemaPath": "Stream"
}

Optional parameters

• {listentries}: See List entries.