Get spot by ID

GET 
/api/inspect/v1/spot/:id

Fetch spot details with the ID of the spot.

Request

Path Parameters

id stringrequired

Spot ID for which spot details are to be fetched.

Responses

200

200 response

application/json

Schema

Schema

data

object

Details of the spot.

id uuid

The unique identifier of the spot

spotTemplateID uuid

The unique identifier of the spot template used to create the spot.

updatedAt int64

The timestamp when the spot was last updated in milliseconds

archived boolean

A flag indicating whether the spot is archived.

assetID uuid

The unique identifier of the asset to which the spot belongs.

createdAt int64

The timestamp when the spot was created in milliseconds

createdBy int64

The ID of the user who created the spot

fields

object

A map of spot fields and their values. The keys are the IDs of the spot fields, and the values are the values of the spot fields.

property name* any

A map of spot fields and their values. The keys are the IDs of the spot fields, and the values are the values of the spot fields.

thumbnailURL uri

The URL of the thumbnail image representing the spot.

ticketID int64

The spot number

updatedBy int64

The ID of the user who last updated the spot

Example (from schema)

{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "spotTemplateID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "updatedAt": 1652933097739,
    "archived": false,
    "assetID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "createdAt": 1652933097739,
    "createdBy": 1413,
    "fields": {
      "severity": "major",
      "377b652d-8ff7-4828-b7e1-31deae5b2faa": "There are some damages on the wall",
      "assignedTo": null,
      "dueDate": 1630444800000,
      "fb122b5a-8871-4fee-a708-9d9a3b94c0db": "377b652d-8ff7-4828-b7e1-31deae5b2faa"
    },
    "thumbnailURL": "https://example.com/spot/thumbnail.jpg",
    "ticketID": 3,
    "updatedBy": 1413
  }
}

400

400 Bad Request. The request is invalid. This may occur if required parameters are missing or invalid. Ensure that all required parameters are included and valid.

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 Unauthorized. Authentication is required and was not provided or is invalid. Ensure that the correct credentials or tokens are included in the request.

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 Forbidden. The client does not have permission to perform this action. This might happen if the client lacks the necessary privileges to interact with the specified entity.

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 Not Found. The specified entity does not exist. Verify that the reference given is correct and that the entity is available.

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 Internal Server Error. An error occurred on the server while processing the request. Retry the operation or contact support if the issue persists.

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...