Get spot fields for asset

GET 
/api/inspect/v1/spot/field

Fetch the list of spot fields in an asset for the given asset ID.

Request

Query Parameters

assetID stringrequired

Asset ID for which spot fields are to be fetched.

Responses

200

200 response

application/json

Schema

Schema

data

object[]

List of spot fields

Array [

multivalued boolean

Whether the spot field is multi-valued

name string

Name of the spot field

options

object[]

List of options for the spot field

Array [

text string

Text of the option

value string

Value of the option

color string

Color of the option

]

type int32

Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]

Type of the spot field. Possible values are: 1 = Multiple Choice, 2 = System, 3 = Date, 4 = Date Range, 5 = Text, 6 = Text Multiline, 7 = Number Integer, 8 = Number Decimal, 9 = User, 10 = External Photo

id string

ID of the spot field

multiLevel boolean

Whether the spot field is multi-level

]

Example (from schema)

{
  "data": [
    {
      "multivalued": false,
      "name": "Severity",
      "options": [
        {
          "color": "#FF0000",
          "text": "Major",
          "value": "major"
        },
        {
          "color": "#FFFF00",
          "text": "Minor",
          "value": "minor"
        }
      ],
      "type": 1,
      "id": "severity",
      "multiLevel": false
    }
  ]
}

400

400 response

application/json

Schema

Schema

error string

A code representing the specific error that occurred. This can be used to programmatically identify and handle the error.

errorDescription string

A detailed description of the error, providing more context or information about what went wrong. This is intended to help understand the cause of the error and how to resolve it.

Example (from schema)

{
  "error": "Forbidden",
  "errorDescription": "permission denied"
}

401

401 response

application/json

Schema

Schema

error string

A code representing the specific error that occurred. This can be used to programmatically identify and handle the error.

errorDescription string

A detailed description of the error, providing more context or information about what went wrong. This is intended to help understand the cause of the error and how to resolve it.

Example (from schema)

{
  "error": "Forbidden",
  "errorDescription": "permission denied"
}

403

403 response

application/json

Schema

Schema

error string

A code representing the specific error that occurred. This can be used to programmatically identify and handle the error.

errorDescription string

A detailed description of the error, providing more context or information about what went wrong. This is intended to help understand the cause of the error and how to resolve it.

Example (from schema)

{
  "error": "Forbidden",
  "errorDescription": "permission denied"
}

404

404 response

application/json

Schema

Schema

error string

A code representing the specific error that occurred. This can be used to programmatically identify and handle the error.

errorDescription string

A detailed description of the error, providing more context or information about what went wrong. This is intended to help understand the cause of the error and how to resolve it.

Example (from schema)

{
  "error": "Forbidden",
  "errorDescription": "permission denied"
}

500

500 response

application/json

Schema

Schema

error string

A code representing the specific error that occurred. This can be used to programmatically identify and handle the error.

errorDescription string

A detailed description of the error, providing more context or information about what went wrong. This is intended to help understand the cause of the error and how to resolve it.

Example (from schema)

{
  "error": "Forbidden",
  "errorDescription": "permission denied"
}

Loading...