Get attachments for spot

GET 
/api/inspect/v1/spot/attachment

Fetch the list of attachments in a spot for the given spot ID.

Request

Query Parameters

spotID stringrequired

Spot ID for which attachments are to be fetched.

Responses

200

200 response

application/json

Schema

Schema

data

object[]

List of attachments

Array [

orderNo int64

Order number of the attachment

remarks string

Remarks of the attachment

type int32

Possible values: [0, 1, 2, 3]

Type of the attachment. 0 = Document, 1 = Photo, 2 = Audio, 3 = Video

updatedAt int64

Timestamp when the spot attachment was last updated in milliseconds

updatedBy int64

ID of the user who last updated the spot attachment

assetID uuid

ID of the asset to which the spot attachment belongs

attributes

object

A set of attributes for the attachment

photo360 boolean

Whether the attachment is a 360-degree photo

rotation double

Rotation angle of the attachment

id uuid

ID of the spot attachment

thumbnailURL uri

URL of the thumbnail image of the attachment

url uri

URL of the attachment

createdBy int64

ID of the user who created the spot attachment

name string

Name of the attachment

spotID uuid

ID of the spot to which the attachment is linked

createdAt int64

Timestamp when the spot attachment was created in milliseconds

]

Example (from schema)

{
  "data": [
    {
      "orderNo": 1,
      "remarks": "Crack detected on the wall",
      "type": 0,
      "updatedAt": 1652933097739,
      "updatedBy": 1413,
      "assetID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "attributes": {
        "rotation": 90,
        "photo360": false
      },
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "thumbnailURL": "https://example.com/attachment/thumbnail.jpg",
      "url": "https://example.com/attachment.jpg",
      "createdBy": 1413,
      "name": "Begonia",
      "spotID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "createdAt": 1652933097739
    }
  ]
}

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