Create spot

POST 
/api/inspect/v1/spot

This API endpoint allows users to create a spot within an asset, providing a detailed record of a specific location or area of interest. The spot can include various types of attachments, such as photos, documents, or sensor data, and can be linked to a specific point on a Map, 2D View or 3D View. The spot template defines the fields for data entry, and the complete status indicates whether the spot creation is finalized. Spots are essential for documenting observations, issues, or potential conditions during asset inspections, and can be further processed once marked as complete.

Request

application/json

Body

required

link

object

The object representing the link to the spot's location on a Map, 2D View or 3D View. This includes details about the coordinates and type of view, such as Map, 2D View or 3D View.

attributes

object

Location of the spot on the Map or 2D View or 3D View

geometry

object

The geometry of the entity on the Map.

coordinates double[]

Possible values: >= 2, <= 2

The latitude and longitude coordinates of the entity on the Map.

type string

The type of geometry used, typically indicating the format of the map coordinates.

properties

object

The properties of the entity on the Map.

address string

The address of the entity on the Map.

name string

The name of the entity on the Map.

type string

The type of geometry used, typically indicating the format of the map coordinates.

type int32

Possible values: [0, 3, 4]

The type of view for the spot location. Possible values are 0 = 2D View, 3 = Map, and 4 = 3D View. 2D View refers to two-dimensional representations like floor plans, while 3D View refers to models like IFC or LiDAR representations.

spotTemplateID uuidrequired

The unique identifier (UUID) of the spot template. Spot templates are customizable and define specific fields for entering information during spot creation.

assetID uuidrequired

The unique identifier (UUID) of the asset to which the spot belongs. This parameter ensures that the spot is linked to a specific asset for further processing or retrieval.

attachments

object[]

A list of attachments associated with the spot. Attachments are files linked to the spot, such as 2D media, sketches, sensor measurements, or 3D models.

Array [

remarks string

Remarks or comments for the attachment.

type int32required

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

The type of attachment. Possible values are:

0 = Document, 1 = Photo, 2 = Audio, 3 = Video

updatedAt int64required

The timestamp when the spot attachment was last updated in milliseconds.

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

createdAt int64required

The timestamp when the spot attachment was created in milliseconds.

fileID uuidrequired

The ID reference of the file to be attached

name stringrequired

The name of the attachment.

]

complete booleanrequired

A flag indicating whether the spot creation is complete. If set to true, the spot is considered fully created and ready for further processing or review.

createdAt int64

The timestamp (in milliseconds) indicating when the spot was created. This value ensures that the spot’s creation time is accurately recorded.

fields

object

required

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.

Responses

201

201 Created. The spot was successfully created. The response includes the following details about the created spot:

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