Jump to

• Request
• Response

Get integrations with Asset Monitoring Cloud Service.

get

/connectedWorker/clientapi/v2/orgs/{orgId}/projects/{projectId}/assetIntegrations

This operation retrieves integrations with Asset Monitoring Cloud Service within given project.

Request

Path Parameters

• orgId: string
  Organization identifier
• projectId: string
  Project identifier

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Integrations were successfully retrieved.

Body ()

Root Schema : AMIntegrations

Type: object

Show Source

• items: array items
• links(optional): array links
  Read Only: true

{
    "required":[
        "items"
    ],
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AMIntegration"
            }
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object AMIntegration

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AMIntegration"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object Link

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : AMIntegration

Type: object

Show Source

• assetTypeId: string
  Minimum Length: 0

  Maximum Length: 255

  Id of the asset for integration

  Example: 54321
• certificateTypeIds(optional): array certificateTypeIds
  Ids of certificate types for integration
• id(optional): string
  Read Only: true

  The unique id of the object

  Example: 53
• links(optional): array links
• organizationId(optional): string
  Id of the organization

  Example: 51
• projectId: string
  Id of the project

  Example: 52
• radius: number
  Minimum Value: 0

  Minimum Value: > true

  Maximum Value: 999.99

  Maximum Value: < false

  Radius of an location generated around an asset in metres. Must be positive number, less than 1000.

  Example: 8
• reenterTime(optional): integer(int64)
  Minimum Value: 0

  Amount of time that employee must spend outside the location created for asset to reenter it again. If set to null, there is no restriction

  Example: 51
• restrictedTime(optional): integer(int64)
  Minimum Value: 1

  Maximum amount of time that employee can spend in the location created for asset in seconds. If set to null, there is no restriction

  Example: 51
• vicinityRadius(optional): number
  Minimum Value: 0

  Minimum Value: > true

  Maximum Value: 999.99

  Maximum Value: < false

  Vicinity radius of an asset geo fence to generate approaching message in metres. Must be positive number, greater than radius, less than 1000.

  Example: 10

{
    "required":[
        "assetTypeId",
        "projectId",
        "radius"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The unique id of the object",
            "readOnly":true,
            "example":"53"
        },
        "assetTypeId":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Id of the asset for integration",
            "example":"54321"
        },
        "radius":{
            "maximum":999.99,
            "exclusiveMaximum":false,
            "minimum":0,
            "exclusiveMinimum":true,
            "type":"number",
            "description":"Radius of an location generated around an asset in metres. Must be positive number, less than 1000.",
            "example":8
        },
        "vicinityRadius":{
            "maximum":999.99,
            "exclusiveMaximum":false,
            "minimum":0,
            "exclusiveMinimum":true,
            "type":"number",
            "description":"Vicinity radius of an asset geo fence to generate approaching message in metres. Must be positive number, greater than radius, less than 1000.",
            "example":10
        },
        "restrictedTime":{
            "minimum":1,
            "type":"integer",
            "description":"Maximum amount of time that employee can spend in the location created for asset in seconds. If set to null, there is no restriction",
            "format":"int64",
            "example":51
        },
        "reenterTime":{
            "minimum":0,
            "type":"integer",
            "description":"Amount of time that employee must spend outside the location created for asset to reenter it again. If set to null, there is no restriction",
            "format":"int64",
            "example":51
        },
        "certificateTypeIds":{
            "type":"array",
            "description":"Ids of certificate types for integration",
            "writeOnly":true,
            "example":[
                54,
                321
            ],
            "items":{
                "type":"string",
                "description":"Ids of certificate types for integration",
                "example":"[54,321]"
            }
        },
        "projectId":{
            "type":"string",
            "description":"Id of the project",
            "writeOnly":true,
            "example":"52"
        },
        "organizationId":{
            "type":"string",
            "description":"Id of the organization",
            "writeOnly":true,
            "example":"51"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    }
}

Nested Schema : certificateTypeIds

Type: array

Ids of certificate types for integration

Show Source

• Array of: string
  Ids of certificate types for integration

  Example: [54,321]

{
    "type":"array",
    "description":"Ids of certificate types for integration",
    "writeOnly":true,
    "example":[
        54,
        321
    ],
    "items":{
        "type":"string",
        "description":"Ids of certificate types for integration",
        "example":"[54,321]"
    }
}

Example:

[
    54,
    321
]

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
  The target resource's URI
• rel: string
  Relation type

{
    "required":[
        "href",
        "rel"
    ],
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Relation type"
        },
        "href":{
            "type":"string",
            "description":"The target resource's URI"
        }
    }
}

Back to Top