Go to OI Website Request Access to Demo Site

Admin

PreviousAccount NextAnalysis Cycletime

get

Authorizations

Responses

200

200 OK

application/json

400

Bad Request - The server could not process the request due to invalid input, missing required parameters, or malformed syntax.

application/json

401

Unauthorized - Authentication is missing or invalid. Ensure you provide a valid token or credentials to access this resource.

application/json

403

Forbidden - You are authenticated but do not have permission to perform this action. Contact the administrator if you believe this is an error.

application/json

409

Conflict - The request could not be completed due to a conflict with the current state of the resource, such as a duplicate record or a versioning issue.

application/json

500

Internal Server Error - An unexpected error occurred on the server. Please try again later or contact support if the issue persists.

application/json

get

GET /api/admin/config HTTP/1.1
Host: qa.eu-west-2-2.busroot.opind.co
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "isSuccess": true,
  "results": [
    {
      "key": "text",
      "value": "text",
      "required": true,
      "type": "text"
    }
  ]
}

get

Authorizations

Responses

200

200 OK

application/json

400

Bad Request - The server could not process the request due to invalid input, missing required parameters, or malformed syntax.

application/json

401

Unauthorized - Authentication is missing or invalid. Ensure you provide a valid token or credentials to access this resource.

application/json

403

Forbidden - You are authenticated but do not have permission to perform this action. Contact the administrator if you believe this is an error.

application/json

409

Conflict - The request could not be completed due to a conflict with the current state of the resource, such as a duplicate record or a versioning issue.

application/json

500

Internal Server Error - An unexpected error occurred on the server. Please try again later or contact support if the issue persists.

application/json

get

GET /api/admin/access-code HTTP/1.1
Host: qa.eu-west-2-2.busroot.opind.co
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "isSuccess": true,
  "results": [
    {
      "code": "text",
      "accountId": "text",
      "email": "text",
      "createdAt": "text",
      "updatedAt": "text"
    }
  ]
}

post

Authorizations

Responses

200

200 OK

application/json

400

Bad Request - The server could not process the request due to invalid input, missing required parameters, or malformed syntax.

application/json

401

Unauthorized - Authentication is missing or invalid. Ensure you provide a valid token or credentials to access this resource.

application/json

403

Forbidden - You are authenticated but do not have permission to perform this action. Contact the administrator if you believe this is an error.

application/json

409

Conflict - The request could not be completed due to a conflict with the current state of the resource, such as a duplicate record or a versioning issue.

application/json

500

Internal Server Error - An unexpected error occurred on the server. Please try again later or contact support if the issue persists.

application/json

post

POST /api/admin/access-code HTTP/1.1
Host: qa.eu-west-2-2.busroot.opind.co
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "isSuccess": true,
  "result": {
    "code": "text"
  }
}

post

Authorizations

Responses

200

200 OK

application/json

400

Bad Request - The server could not process the request due to invalid input, missing required parameters, or malformed syntax.

application/json

401

Unauthorized - Authentication is missing or invalid. Ensure you provide a valid token or credentials to access this resource.

application/json

403

Forbidden - You are authenticated but do not have permission to perform this action. Contact the administrator if you believe this is an error.

application/json

409

Conflict - The request could not be completed due to a conflict with the current state of the resource, such as a duplicate record or a versioning issue.

application/json

500

Internal Server Error - An unexpected error occurred on the server. Please try again later or contact support if the issue persists.

application/json

post

POST /api/admin/seedrun HTTP/1.1
Host: qa.eu-west-2-2.busroot.opind.co
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "isSuccess": true
}

post

Authorizations

Responses

200

200 OK

application/json

400

Bad Request - The server could not process the request due to invalid input, missing required parameters, or malformed syntax.

application/json

401

Unauthorized - Authentication is missing or invalid. Ensure you provide a valid token or credentials to access this resource.

application/json

403

Forbidden - You are authenticated but do not have permission to perform this action. Contact the administrator if you believe this is an error.

application/json

409

Conflict - The request could not be completed due to a conflict with the current state of the resource, such as a duplicate record or a versioning issue.

application/json

500

Internal Server Error - An unexpected error occurred on the server. Please try again later or contact support if the issue persists.

application/json

post

POST /api/admin/seedrun/demo HTTP/1.1
Host: qa.eu-west-2-2.busroot.opind.co
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "isSuccess": true
}

get

Authorizations

Responses

200

200 OK

application/json

400

Bad Request - The server could not process the request due to invalid input, missing required parameters, or malformed syntax.

application/json

401

Unauthorized - Authentication is missing or invalid. Ensure you provide a valid token or credentials to access this resource.

application/json

403

Forbidden - You are authenticated but do not have permission to perform this action. Contact the administrator if you believe this is an error.

application/json

409

Conflict - The request could not be completed due to a conflict with the current state of the resource, such as a duplicate record or a versioning issue.

application/json

500

Internal Server Error - An unexpected error occurred on the server. Please try again later or contact support if the issue persists.

application/json

get

GET /api/notification-preference HTTP/1.1
Host: qa.eu-west-2-2.busroot.opind.co
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "isSuccess": true,
  "results": [
    {
      "preference": [
        "none"
      ],
      "stationGroupCode": "text",
      "stationGroupName": "text",
      "userId": 1,
      "userEmail": "text"
    }
  ]
}

post

Authorizations

Body

stationGroupCodestring · min: 1 · max: 32RequiredPattern: ^([a-zA-Z0-9-_]+)$

Responses

200

200 OK

application/json

400

Bad Request - The server could not process the request due to invalid input, missing required parameters, or malformed syntax.

application/json

401

Unauthorized - Authentication is missing or invalid. Ensure you provide a valid token or credentials to access this resource.

application/json

403

Forbidden - You are authenticated but do not have permission to perform this action. Contact the administrator if you believe this is an error.

application/json

409

Conflict - The request could not be completed due to a conflict with the current state of the resource, such as a duplicate record or a versioning issue.

application/json

500

Internal Server Error - An unexpected error occurred on the server. Please try again later or contact support if the issue persists.

application/json

post

POST /api/notification-preference HTTP/1.1
Host: qa.eu-west-2-2.busroot.opind.co
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 51

[
  {
    "stationGroupCode": "text",
    "preference": [
      "none"
    ]
  }
]

{
  "isSuccess": true,
  "results": [
    {
      "preference": [
        "none"
      ],
      "stationGroupCode": "text",
      "stationGroupName": "text",
      "userId": 1,
      "userEmail": "text"
    }
  ]
}

post

Authorizations

Body

Responses

200

200 OK

application/json

400

Bad Request - The server could not process the request due to invalid input, missing required parameters, or malformed syntax.

application/json

401

Unauthorized - Authentication is missing or invalid. Ensure you provide a valid token or credentials to access this resource.

application/json

403

Forbidden - You are authenticated but do not have permission to perform this action. Contact the administrator if you believe this is an error.

application/json

409

Conflict - The request could not be completed due to a conflict with the current state of the resource, such as a duplicate record or a versioning issue.

application/json

500

Internal Server Error - An unexpected error occurred on the server. Please try again later or contact support if the issue persists.

application/json

post

POST /api/admin/config HTTP/1.1
Host: qa.eu-west-2-2.busroot.opind.co
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "isSuccess": true,
  "results": [
    [
      {
        "key": "text",
        "message": "text"
      }
    ]
  ]
}

post

Authorizations

Body

domainstring · min: 1Required

plantNamestring · min: 1Required

accountIdstring · min: 1Optional

Responses

200

200 OK

application/json

400

Bad Request - The server could not process the request due to invalid input, missing required parameters, or malformed syntax.

application/json

401

Unauthorized - Authentication is missing or invalid. Ensure you provide a valid token or credentials to access this resource.

application/json

403

Forbidden - You are authenticated but do not have permission to perform this action. Contact the administrator if you believe this is an error.

application/json

409

Conflict - The request could not be completed due to a conflict with the current state of the resource, such as a duplicate record or a versioning issue.

application/json

500

Internal Server Error - An unexpected error occurred on the server. Please try again later or contact support if the issue persists.

application/json

post

POST /api/admin/newaccount HTTP/1.1
Host: qa.eu-west-2-2.busroot.opind.co
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "domain": "text",
  "plantName": "text",
  "accountId": "text"
}

{
  "isSuccess": true
}