Get All Datagroups
GET/api/3.1/datagroups
all_datagroups()
Implementation Notes
Get information about all datagroups.
Response Class
array
Parameters
None
Response Messages
| HTTP Status Code | Reason | Response Model |
|---|---|---|
| 400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
| 404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Get Datagroup
GET/api/3.1/datagroups/{datagroup_id}
datagroup(datagroup_id)
Implementation Notes
Get information about a datagroup.
Response Class
Datagroup {
can (object, read-only): Operations the current user is able to perform on this object,
created_at (long, read-only): UNIX timestamp at which this entry was created.,
id (long, read-only): Unique ID of the datagroup,
model_name (string, read-only): Name of the model containing the datagroup. Unique when combined with name.,
name (string, read-only): Name of the datagroup. Unique when combined with model_name.,
stale_before (long): UNIX timestamp before which cache entries are considered stale. Cannot be in the future.,
trigger_check_at (long, read-only): UNIX timestamp at which this entry trigger was last checked.,
trigger_error (string, read-only): The message returned with the error of the last trigger check.,
trigger_value (string, read-only): The value of the trigger when last checked.,
triggered_at (long): UNIX timestamp at which this entry became triggered. Cannot be in the future.
}
Parameters
| Parameter | Required? | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| datagroup_id | true | ID of datagroup. | string | string |
Response Messages
| HTTP Status Code | Reason | Response Model |
|---|---|---|
| 400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
| 404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Update Datagroup
PATCH/api/3.1/datagroups/{datagroup_id}
update_datagroup(datagroup_id, body)
Implementation Notes
Update a datagroup using the specified params.
Response Class
Datagroup {
can (object, read-only): Operations the current user is able to perform on this object,
created_at (long, read-only): UNIX timestamp at which this entry was created.,
id (long, read-only): Unique ID of the datagroup,
model_name (string, read-only): Name of the model containing the datagroup. Unique when combined with name.,
name (string, read-only): Name of the datagroup. Unique when combined with model_name.,
stale_before (long): UNIX timestamp before which cache entries are considered stale. Cannot be in the future.,
trigger_check_at (long, read-only): UNIX timestamp at which this entry trigger was last checked.,
trigger_error (string, read-only): The message returned with the error of the last trigger check.,
trigger_value (string, read-only): The value of the trigger when last checked.,
triggered_at (long): UNIX timestamp at which this entry became triggered. Cannot be in the future.
}
Parameters
| Parameter | Required? | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| datagroup_id | true | ID of datagroup. | string | string |
| body | true | Datagroup | body |
Datagroup {
can (object, read-only): Operations the current user is able to perform on this object, created_at (long, read-only): UNIX timestamp at which this entry was created., id (long, read-only): Unique ID of the datagroup, model_name (string, read-only): Name of the model containing the datagroup. Unique when combined with name., name (string, read-only): Name of the datagroup. Unique when combined with model_name., stale_before (long): UNIX timestamp before which cache entries are considered stale. Cannot be in the future., trigger_check_at (long, read-only): UNIX timestamp at which this entry trigger was last checked., trigger_error (string, read-only): The message returned with the error of the last trigger check., trigger_value (string, read-only): The value of the trigger when last checked., triggered_at (long): UNIX timestamp at which this entry became triggered. Cannot be in the future. }
|
Response Messages
| HTTP Status Code | Reason | Response Model |
|---|---|---|
| 400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
| 404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
| 422 | Validation Error |
ValidationError {
message (string, read-only, required): Error details, errors (Array[ValidationErrorDetail], read-only): Error detail array, documentation_url (string, read-only, required): Documentation link }ValidationErrorDetail { field (string, read-only): Field with error, code (string, read-only): Error code, message (string, read-only): Error info message, documentation_url (string, read-only, required): Documentation link }
|
| 429 | Too Many Requests |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
| 409 | Resource Already Exists |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|