Command
GET /ver2/CommandService.svc/commands/{commandId}
Returns information about a previously submitted command (any API which is asynchronous).
Security: All users.
SDK API (create): envianceSdk.commands.getCommand (commandId, onsuccess, onerror)
GET /ver2/CommandService.svc/commands/08fc5438-a0d8-4bf9-9141-12dd98e7ce80/ HTTP/1.1
//RESPONSE
{
"id": "08fc5438-a0d8-4bf9-9141-12dd98e7ce80",
"description": "Data batch processed.",
"issued": "2012-12-01T08:00:00",
"startedProcessing": "2012-12-01T08:01:00",
"finishedProcessing": "2012-12-01T08:02:00",
"status": "Succeeded",
"objects": ["/Facility A/Unit X/Parameter Z"],
"user": "JSmith",
"errorInfo": {
"error": "Requirement with Tag 'GZB_AVG_SORTED' could not be found in the system.",
"details": [
{ "key": "Tag", "value": "GZB_AVG_SORTED" },
{ "key": "Complete Date", "value": "2012-02-08T09:50:00" },
{ "key": "Value", "value": "18.00803565979" }
]
}
}
envianceSdk.commands.getCommand
[
"eccd2310-9b5f-440b-bf0d-91f9803d036b",
"onsuccess",
"onerror"
]
Request
- Base URLhttps://api.enviance.com (the document declares no server; this is the origin it was published from)
- Authnone declared
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
commandIdstring required
Headers
EnvApi-Systemidstring
Specify specific system to run instead of Home
EnvApi-Packageidstring
(optional) Clients application/package ID
EnvApi-Udf-DateTime-Iso-In-CustomFieldsstring
Udfs of DateTime should use Iso
EnvApi-Udf-DateTime-ReadInUserTzstring
(obsolete) Udfs of DateTime type whould be in ReadInUserTz
EnvApi-Udf-Value-Invariantstring
(optional) Udfs - Force Non-Localized (invariant) values
EnvApi-Localization-Allstring
(optional) Extend objects with User-given Localizations
x-client-request-idstring
(optional) Client ID for double submit prevention
Response
not available
Changes
No recorded changes to this operation across all 1 revision of this API.