Jump to

• Request
• Response

Get all top level locations

get

/connectedWorker/clientapi/v2/projects/{projectId}/locations

This operation retrieves all those locations that do not have a parent location.

Request

Path Parameters

• projectId: integer(int64)
  Project identifier

Back to Top

Response

Supported Media Types

• application/json

200 Response

Locations were successfully updated

Body ()

Root Schema : Locations

Type: object

Show Source

• items: array items
• links(optional): array links

{
    "type":"object",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Location"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Location

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Location"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : Location

Type: object

Show Source

• description(optional): string
  Description of the location

  Example: Description of the location
• generated(optional): boolean
  Default Value: false

  Flag describing the origin of a location. If false, location is part of the project view and can be created only by IoTCWProjectManager or IoTCWAdministrator. Otherwise, it describes a custom location, not displayable in project view. Generated location can be created by any employee.

  Example: false
• geoFenceId(optional): string
  Geofence identifier associated with the location

  Example: 828EDB09-A516-4485-AB60-CE1CFF5D8D8E
• hazardous(optional): boolean
  Read Only: true

  Default Value: false

  True if the location has been marked as hazardous, false otherwise

  Example: false
• id(optional): integer(int64)
  Read Only: true

  The unique id of the object

  Example: 53
• links(optional): array links
• locationPlanId(optional): integer(int64)
  Id of the location plan, the location is associated with

  Example: 51
• name: string
  Minimum Length: 0

  Maximum Length: 255

  Name of the location. It must be unique per project, max length is 255 characters

  Example: My location name
• parentId(optional): integer(int64)
  Parent location specified by its identifier

  Example: 51
• tags(optional): array tags
  Unique Items Required: true

  Tags associated with the location

{
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "id":{
            "type":"integer",
            "format":"int64",
            "example":53,
            "description":"The unique id of the object",
            "readOnly":true
        },
        "name":{
            "type":"string",
            "example":"My location name",
            "description":"Name of the location. It must be unique per project, max length is 255 characters",
            "minLength":0,
            "maxLength":255
        },
        "description":{
            "type":"string",
            "example":"Description of the location",
            "description":"Description of the location"
        },
        "generated":{
            "type":"boolean",
            "example":false,
            "description":"Flag describing the origin of a location. If false, location is part of the project view and can be created only by IoTCWProjectManager or IoTCWAdministrator. Otherwise, it describes a custom location, not displayable in project view. Generated location can be created by any employee.",
            "default":false
        },
        "hazardous":{
            "type":"boolean",
            "example":false,
            "description":"True if the location has been marked as hazardous, false otherwise",
            "readOnly":true,
            "default":false
        },
        "geoFenceId":{
            "type":"string",
            "example":"828EDB09-A516-4485-AB60-CE1CFF5D8D8E",
            "description":"Geofence identifier associated with the location"
        },
        "tags":{
            "type":"array",
            "example":"[\"tag1\", \"tag2\"]",
            "description":"Tags associated with the location",
            "uniqueItems":true,
            "items":{
                "type":"string"
            }
        },
        "parentId":{
            "type":"integer",
            "format":"int64",
            "example":51,
            "description":"Parent location specified by its identifier"
        },
        "locationPlanId":{
            "type":"integer",
            "format":"int64",
            "example":51,
            "description":"Id of the location plan, the location is associated with"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : tags

Type: array

Unique Items Required: true

Tags associated with the location

Show Source

• Array of: string

{
    "type":"array",
    "example":"[\"tag1\", \"tag2\"]",
    "description":"Tags associated with the location",
    "uniqueItems":true,
    "items":{
        "type":"string"
    }
}

Example:

["tag1", "tag2"]

Nested Schema : Link

Type: object

Show Source

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

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

Back to Top