Get operation

GET 
/workspaces/:workspace_id/operations/:resource_id

This endpoint returns the operation data with the given ID.

Request

Path Parameters

workspace_id stringrequired

Workspace ID

resource_id stringrequired

Operation ID

Query Parameters

start date-timerequired

Start date of the data range

end date-timerequired

End date of the data range

s string

Shift ID

Responses

200

OK response.

application/json

Schema

Schema

assets

object[]

Assets worked in the operation

Array [

alarm boolean

Alarm status of the asset

alarm_time int64

Total seconds in alarm for the asset

asset_type string

Type of the asset

avg_cycle_cost doublerequired

Average cycle energy cost of the asset

avg_cycle_time doublerequired

Average cycle time of the asset in seconds

bad_cycles int64required

Total bad cycles produced by the asset

consumption doublerequired

Total consumption in kWh for the asset

cost doublerequired

Total energy cost for the asset

device_id string

Device ID of the asset

efficiency doublerequired

Efficiency percentage of the asset

good_cycles int64required

Total good cycles produced by the asset

h_cycles

object[]

Historical cycles produced for the asset

Array [

bad int64required

Bad items produced

good int64required

Good items produced

ts stringrequired

Date of the data

]

h_efficiency

object[]

Historical efficiency percentage of the asset

Array [

ts stringrequired

Date of the data

value doublerequired

Value of the data

]

h_status

object[]

Historical status of the asset

Array [

idle doublerequired

Value of the idle data

offline doublerequired

Value of the offline data

ts stringrequired

Date of the data

working doublerequired

Value of the working data

]

id stringrequired

ID of the asset

ideal_cycle_time doublerequired

Ideal cycle time of the asset in seconds

last_data_ts stringrequired

Last data timestamp

last_operation stringrequired

Code of the last operation read by the asset

missing_ideal_cycle_time booleanrequired

True if the asset is missing ideal cycle time for the operation

name string

Name of the asset

performance doublerequired

Performance percentage of the asset

quality doublerequired

Quality percentage of the asset

run_time doublerequired

Total run time in seconds for the asset

status string

Status of the asset

total_cycles int64required

Total cycles produced by the asset

]

avg_cycle_cost double

Average cycle energy cost of the operation

avg_cycle_time double

Average cycle time of the operation in seconds

bad_cycles int64

Total bad cycles produced by the operation

code stringrequired

Code of the operation

consumption double

Total consumption in kWh for the operation

cost double

Total energy cost for the operation

efficiency double

Efficiency percentage of the operation

good_cycles int64

Total good cycles produced by the operation

h_avg_cycle_cost

object[]

Historical average cycle energy cost of the operation

Array [

ts stringrequired

Date of the data

value doublerequired

Value of the data

]

h_avg_cycle_time

object[]

Historical average cycle time of the operation in seconds

Array [

ts stringrequired

Date of the data

value doublerequired

Value of the data

]

h_cycles

object[]

Historical cycles produced for the operation

Array [

bad int64required

Bad items produced

good int64required

Good items produced

ts stringrequired

Date of the data

]

h_efficiency

object[]

Historical efficiency percentage of the operation

Array [

ts stringrequired

Date of the data

value doublerequired

Value of the data

]

id stringrequired

ID of the operation

missing_ideal_cycle_time booleanrequired

True if the operation is missing ideal cycle time for one or more assets

name string

Name of the operation

performance double

Performance percentage of the operation

quality double

Quality percentage of the operation

run_time double

Total run time in seconds for the operation

total_cycles int64

Total cycles produced by the operation

Example (from schema)

{
  "assets": [
    {
      "alarm": true,
      "alarm_time": 0,
      "asset_type": "string",
      "avg_cycle_cost": 0,
      "avg_cycle_time": 0,
      "bad_cycles": 0,
      "consumption": 0,
      "cost": 0,
      "device_id": "string",
      "efficiency": 0,
      "good_cycles": 0,
      "h_cycles": [
        {
          "bad": 0,
          "good": 0,
          "ts": "string"
        }
      ],
      "h_efficiency": [
        {
          "ts": "string",
          "value": 0
        }
      ],
      "h_status": [
        {
          "idle": 0,
          "offline": 0,
          "ts": "string",
          "working": 0
        }
      ],
      "id": "string",
      "ideal_cycle_time": 0,
      "last_data_ts": "string",
      "last_operation": "string",
      "missing_ideal_cycle_time": true,
      "name": "string",
      "performance": 0,
      "quality": 0,
      "run_time": 0,
      "status": "string",
      "total_cycles": 0
    }
  ],
  "avg_cycle_cost": 0,
  "avg_cycle_time": 0,
  "bad_cycles": 0,
  "code": "string",
  "consumption": 0,
  "cost": 0,
  "efficiency": 0,
  "good_cycles": 0,
  "h_avg_cycle_cost": [
    {
      "ts": "string",
      "value": 0
    }
  ],
  "h_avg_cycle_time": [
    {
      "ts": "string",
      "value": 0
    }
  ],
  "h_cycles": [
    {
      "bad": 0,
      "good": 0,
      "ts": "string"
    }
  ],
  "h_efficiency": [
    {
      "ts": "string",
      "value": 0
    }
  ],
  "id": "string",
  "missing_ideal_cycle_time": true,
  "name": "string",
  "performance": 0,
  "quality": 0,
  "run_time": 0,
  "total_cycles": 0
}

400

bad_request: Invalid request

application/json

Schema

Schema

message stringrequired

Message of error

Example (from schema)

{
  "message": "invalid request"
}

500

internal_error: Internal server error

application/json

Schema

Schema

message stringrequired

Message of error

Example (from schema)

{
  "message": "invalid request"
}

Loading...