Attribute Spaces¶
/api/repositories/{repository}/entities/{entity}/attributes/{attribute}/values/spaces
Parameter | Type | Purpose |
---|---|---|
repository | string | The repository name |
entity | int | The entity ID |
attribute | int | The attribute ID |
-
GET
/api/repositories/
(string: repository)/entities/
(int: entityID)/attributes/
(int: attributeID)/values/spaces
¶ Gets a complete list of data rows where the value for an attribute is 1 or more spaces.
GET /api/repositories/jupiter/entities/1/attributes/3/values/spaces HTTP/1.1
Accept: application/json
The list of rows may be quite long; if so, the list can be paged:
-
POST
/api/repositories/
(string: repository)/entities/
(int: entityID)/attributes/
(int: attributeID)/values/spaces
¶ Get a page of rows where the value for an attribute is 1 or more spaces
POST /api/repositories/jupiter/entities/1/attributes/3/vakues/spaces HTTP/1.1
Content-Type: application/json
{
"command": "get",
"options": {
"pageStart": 1,
"pageSize": 32
}
}
The response will be a Standard Response, with a list of records in the corresponding Entity with a null value for the attribute.
The columns
array will contain the list of columns for each dataRow
.
rows
will contain the list of records of the corresponding Entity. If there are no records in the Entity, rows
will be an empty string.
Export¶
Some or all of the rows may be exported as a scheduled task.
POST /api/repositories/jupiter/entities/1/attributes/3/values/spaces HTTP/1.1
Content-Type: application/json
{
"command": "export",
"data": {
"filename": "filename.csv",
"filetype": "csv",
"encoding": "utf-8"
},
"options": {
"where": "Row = 21"
}
}
Response Code | Reason |
---|---|
200 | No error |
400 | Invalid data passed with request |
500 | Server error |
The request packet must contain the command
and data
elements. The options
element is not required, but may specify the columns to export, and/or the rows to filter.
The following table shows which fields are required in the data
element:
Field | Required |
---|---|
filename | Y |
filetype | N |
encoding | N |
If filetype
is not specified, it defaults to csv. If encoding
is not specified, it defaults to the server native encoding.
The response will contain the URL of the scheduled task and the link to download the exported file.
{
"job": "/api/repositories/jupiter/scheduler/1",
"file": "/api/repositories/jupiter/download/filename.csv"
}