In this article
Get Org Object for an OrgId (Deprecated)
Returns the org object for that specific OrgId.
URL
https://{{HOST}}/timeseries/org/{orgId}
Method
GET
Required IMS Scopes
- Read
- Write
Versions Supported
v = 2.0, 2.1
URL Path Parameters
| Name | Description | Example | Type |
|---|---|---|---|
| orgId required |
The OrgId to get timeseries Ids for | jci.com | string |
URL Query Parameters
| Name | Description | Example | Type |
|---|---|---|---|
| $query optional |
Query to get specific results | /endpoint/?$query | None |
| v optional |
Version of the API to use | v=2.0 | string |
Request Header Parameters
| Type | Value | Description |
|---|---|---|
| Authentication | Bearer {access_token} required |
Retrieve access token |
| Content-Type | application/json required |
Description |
Request Body Parameters
| Name | Description | Type |
|---|---|---|
| Object Name required |
Description | object definition |
Example
Request
Curl Example Request
Response
{
"id": "org2",
"orgId": "org2",
"timeseriesIdList": [
"org2.ts11",
"org2.ts22"
]
}
Errors
| Error | Description |
|---|---|
| Error Name | Description of Error |
Response Body Parameters
| Name | Description | Schema |
|---|---|---|
| Object Name | Description | object definition |
| id | Description | object definition |
| orgId | Description | object definition |
| timeseriesIdList | Description | object definition |