Update Tenant Machine (v2.3)

POST /v2.3/api/tenants/:tenant_id/clients/:client_id/machines/:machine_id/reallocate

Reallocate a specific machine from one client tenant to another, where both client tenants are clients of the same MSP.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

client_id stringrequired

The client ID.

machine_id stringrequired

The device ID.

application/json

Body

connected boolean

The device is connected. True or False.

console_conf_passphrase string

The console password.

em_element_id string

The element ID.

esp_tenant_id string

The MSP tenant ID.

hw_id string

The hardware ID.

id string

image_version string

The image version.

inventory_op InventoryOperation (string)

Possible values: [claim, return, revoke, reuse, retire, recover, remanufacture, default, invalid, esp_allocate, esp_received_stock, esp_return, esp_revoke, esp_reuse]

The inventory lifecycle values.

machine_state MachineState (string)

Possible values: [manufactured, manufactured_qa_pending, manufactured_qa_ok, manufactured_qa_not_ok, manufactured_battery_test_pending, manufactured_battery_test_start, manufactured_battery_test_passed, manufactured_battery_test_failed, manufactured_mic_issue_pending, manufactured_mic_issued, manufactured_mic_failed, manufactured_mic_operational, manufactured_cic_issue_pending, manufactured_cic_issued, manufactured_cic_revoked, manufactured_cic_operational, manufactured_mic_signing_pending, manufactured_cic_signing_pending, allocated, allocated_to_esp, claim_pending, initializing, initialization_failed, assigned, claim_pending, claimed, claim_failed, to_be_returned, returned, revoked, machine_element_delete_pending, return_failed, received_stock, remanufactured, retired, recover, decommissioned, machine_claim_valid, machine_claim_invalid, machine_cic_renew_initial, machine_cic_renew_issue_pending, machine_cic_renew_issued, machine_cic_renew_signing_pending, machine_cic_renew_failed, machine_cic_renewed]

The various device states.

manufacture_id string

The manufacture ID.

model_name string

The model name of the device.

ordering_info string

The order information.

owner_tenant_id string

The owner tenant ID.

pki_op CAStoreOperation

ca_list string[]

Ca List

operation string

Possible values: [UPDATE_CASTORE]

Operation

renew_state MachineState (string)

The device renew states.

sales_order_number string

The sales order number.

ship_state MachineShipState (string)

Possible values: [machine_shipped, machine_shipped_correct_address, machine_shipped_wrong_address, machine_not_shipped]

The shipping status.

sl_no string

tenant_id string

The tenant ID.

token string

A valid token. Value = ^[a-zA-Z0-9_-]{1,1000}$.

Responses

Successful Operation

application/json

Schema
Example (from schema)

Schema

connected boolean

The device is connected. True or False.

console_conf_passphrase string

The console password.

em_element_id string

The element ID.

esp_tenant_id string

The MSP tenant ID.

hw_id stringrequired

The hardware ID.

id string

image_version stringrequired

The image version.

inventory_op string

Possible values: [CLAIM, RETURN, REVOKE, REUSE, RETIRE, RECOVER, REMANUFACTURE, DEFAULT, INVALID, ALLOCATE, RECEIVED_STOCK, ESP_ALLOCATE, ESP_RECEIVED_STOCK, ESP_RETURN, ESP_REVOKE, ESP_REUSE]

The inventory lifecycle values.

machine_state stringrequired

Possible values: [MANUFACTURED, MANUFACTURED_QA_PENDING, MANUFACTURED_QA_OK, MANUFACTURED_QA_NOK, MANUFACTURED_BATTERY_TEST_PENDING, MANUFACTURED_BATTERY_TEST_START, MANUFACTURED_BATTERY_TEST_PASS, MANUFACTURED_BATTERY_TEST_FAILED, MANUFACTURED_MIC_ISSUE_PENDING, MANUFACTURED_MIC_ISSUED, MANUFACTURED_MIC_FAILED, MANUFACTURED_MIC_OPERATIONAL, MANUFACTURED_CIC_ISSUE_PENDING, MANUFACTURED_CIC_ISSUED, MANUFACTURED_CIC_REVOKED, MANUFACTURED_CIC_OPERATIONAL, MANUFACTURED_MIC_SIGNING_PENDING, MANUFACTURED_CIC_SIGNING_PENDING, MACHINE_ALLOCATED, MACHINE_ALLOCATED_TO_ESP, MACHINE_ELEMENT_ID_PENDING, MACHINE_INIT, MACHINE_INIT_FAILED, MACHINE_ASSIGNED, MACHINE_CLAIM_PENDING, MACHINE_CLAIMED, MACHINE_CLAIM_FAILED, MACHINE_TO_BE_RETURNED, MACHINE_RETURNED, MACHINE_REVOKED, MACHINE_ELEMENT_DELETE_PENDING, MACHINE_RETURN_FAILED, MACHINE_RECEIVED_STOCK, REMANUFACTURED, MACHINE_RETIRED, MACHINE_RECOVER, MACHINE_DECOMMISSIONED, MACHINE_CLAIM_VALID, MACHINE_CLAIM_INVALID, MACHINE_CIC_RENEW_INITIAL, MACHINE_CIC_RENEW_ISSUE_PENDING, MACHINE_CIC_RENEW_ISSUED, MACHINE_CIC_RENEW_SIGNING_PENDING, MACHINE_CIC_RENEW_FAILED, MACHINE_CIC_RENEWED, MACHINE_SUSPEND_INIT, MACHINE_SUSPEND_IN_PROGRESS, MACHINE_SUSPENDED_MIC_OPERATIONAL, MACHINE_SUSPENDED_CIC_OPERATIONAL, MACHINE_SUSPEND_FAILED, MACHINE_SUSPENDED_EMPTY_TOKEN, MACHINE_SUSPENDED_INVALID_TOKEN, MACHINE_SUSPENDED_TOKEN_EXPIRED, MACHINE_SUSPENDED, MACHINE_SUSPEND_FAILED_TIMEOUT, MACHINE_ALLOCATION_TO_SHELL_IN_PROGRESS, MACHINE_ALLOCATED_TO_SHELL]

The various device states.

manufacture_id stringrequired

The manufacture ID.

model_name stringrequired

The model name of the device.

ordering_info string

The order information.

owner_tenant_id string

The owner tenant ID.

pki_op CAStoreOperation

Pki Op

ca_list string[]

Ca List

operation string

Possible values: [UPDATE_CASTORE]

Operation

renew_state stringrequired

The device renew states.

sales_order_number string

The sales order number.

ship_state stringrequired

Possible values: [MACHINE_SHIPPED, MACHINE_SHIPPED_CORRECT_ADDRESS, MACHINE_SHIPPED_WRONG_ADDRESS, MACHINE_NOT_SHIPPED]

The shipping status.

sl_no stringrequired

The serial number.

suspend_state stringrequired

The suspend state.

tenant_id stringrequired

The tenant ID.

token string

A valid token. Value = ^[a-zA-Z0-9_-]{1,1000}$.

{
  "connected": true,
  "console_conf_passphrase": "string",
  "em_element_id": "string",
  "esp_tenant_id": "string",
  "hw_id": "string",
  "id": "string",
  "image_version": "string",
  "inventory_op": "CLAIM",
  "machine_state": "MANUFACTURED",
  "manufacture_id": "string",
  "model_name": "string",
  "ordering_info": "string",
  "owner_tenant_id": "string",
  "pki_op": {
    "ca_list": [
      "string"
    ],
    "operation": "UPDATE_CASTORE"
  },
  "renew_state": "MANUFACTURED",
  "sales_order_number": "string",
  "ship_state": "MACHINE_SHIPPED",
  "sl_no": "string",
  "suspend_state": "MANUFACTURED",
  "tenant_id": "string",
  "token": "string"
}

Bad Request

application/json

Schema
Example (from schema)
Example

Schema

_error ErrorResponse[]

Array [

code string

The error code.

message string

The error message.

]

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

{
  "value": {
    "_error": [
      {
        "code": "INVALID_ESP_CLIENT"
      },
      {
        "code": "TENANT_REGION_ASSOCIATION_NOT_FOUND"
      },
      {
        "code": "MACHINE_UNKNOWN"
      },
      {
        "code": "OPERATION_NOT_ALLOWED"
      },
      {
        "code": "INVALID_OPERATION"
      },
      {
        "code": "INVALID_STATE",
        "description": "If the machine is not in to_be_returned state or allocated_to_esp states, use /operations API to move it to to_be_returned (return operation) or allocated_to_esp (esp_received stock operation) state, before attempting to reallocate the machine to another client tenant."
      },
      {
        "code": "MACHINE_DELETE_DEFAULT_REGION"
      },
      {
        "code": "INVALID_MACHINE_REGION"
      }
    ]
  }
}

Update Tenant Machine (v2.3)

/v2.3/api/tenants/:tenant_id/clients/:client_id/machines/:machine_id/reallocate

Request​

Path Parameters

Body

Responses​

Request

Responses