/r/{repoId}/objectmanagement/datasets/{id}
GET
Retrieving a dataset
In the response, you receive the detailed information about the specified dataset.
Parameters
repoId/string/required
The unique ID of the repository.
id/string/required
The unique ID of the dataset.
Responses
200
The dataset was determined successfully.
Content
Media type: application/json
{
"dataType": {
"minLength": 1,
"type": "string",
"description": "The data type of the dataset.\r\nSTRING: Text\r\nCURRENCY: Currency\r\nNUMERIC: Number\r\nDATE: Date\r\nURI: Dynamic",
"example": "STRING | CURRENCY | NUMERIC | DATE | URI"
},
"id": {
"type": "string",
"description": "The unique ID of the dataset.",
"nullable": true,
"readOnly": true,
"example": "00000000-0000-0000-0000-000000000000 | USERS | EXISTING_VALUES"
},
"name": {
"minLength": 1,
"type": "string",
"description": "The internal name of the dataset.",
"example": "supplier names"
},
"readOnly": {
"type": "boolean",
"description": "A read-only property indicating whether a dataset has been predefined by the system and cannot be changed.",
"default": false,
"readOnly": true
},
"values": {
"type": "array",
"items": {},
"description": "The values available for selection by the DMS user. Is specified as an array of values that depend on the data type of the dataset.",
"nullable": true,
"example": [
1,
2,
3
]
}
}
Media type: application/hal+json
{
"dataType": {
"minLength": 1,
"type": "string",
"description": "The data type of the dataset.\r\nSTRING: Text\r\nCURRENCY: Currency\r\nNUMERIC: Number\r\nDATE: Date\r\nURI: Dynamic",
"example": "STRING | CURRENCY | NUMERIC | DATE | URI"
},
"id": {
"type": "string",
"description": "The unique ID of the dataset.",
"nullable": true,
"readOnly": true,
"example": "00000000-0000-0000-0000-000000000000 | USERS | EXISTING_VALUES"
},
"name": {
"minLength": 1,
"type": "string",
"description": "The internal name of the dataset.",
"example": "supplier names"
},
"readOnly": {
"type": "boolean",
"description": "A read-only property indicating whether a dataset has been predefined by the system and cannot be changed.",
"default": false,
"readOnly": true
},
"values": {
"type": "array",
"items": {},
"description": "The values available for selection by the DMS user. Is specified as an array of values that depend on the data type of the dataset.",
"nullable": true,
"example": [
1,
2,
3
]
}
}
404
The dataset with the specified ID could not be determined.
Content
Media type: application/json
{
"code": {
"type": "integer",
"format": "int32",
"example": 240100
},
"reason": {
"type": "string",
"nullable": true,
"example": "Reason why the request failed."
}
}
Media type: application/hal+json
{
"code": {
"type": "integer",
"format": "int32",
"example": 240100
},
"reason": {
"type": "string",
"nullable": true,
"example": "Reason why the request failed."
}
}
Show operation