Jump to

• Request
• Response

Get the location details.

get

/connectedWorker/clientapi/v2/orgs/{orgId}/projects/{projectId}/locations/{locationId}

This operation retrieves the location details within a specific project.

Request

Path Parameters

• locationId: string
  Location identifier
• 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

Location was successfully retrieved.

Body ()

Root Schema : Location

Type: object

Show Source

• description(optional): string
  Description of the location

  Example: Description of the location
• generated(optional): boolean
  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

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

  Example: false
• id(optional): string
  Read Only: true

  The unique id of the object

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

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

  Maximum amount of employees that can be in the location without penalty. Note that both maxEmployeeCount and maxEmployeeTime must be set together to null or not null values. If set to null, there is no restriction

  Example: 51
• maxEmployeeTime(optional): integer(int64)
  Minimum Value: 0

  The amount of time that the number of employees can be higher than maxEmployeeCount in a location without any penalty. Note that both maxEmployeeCount and maxEmployeeTime must be set together to null or not null values. If set to null, there is no restriction

  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): string
  Parent location specified by its identifier

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

  Amount of time that employee must spend outside the location 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 in seconds. If set to null, there is no restriction

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

  Tags associated with the location
• timeZone(optional): string
  Time zone where of the location

  Example: Europe/Paris
• type(optional): string
  Read Only: true

  Allowed Values: [ "REGULAR", "ASSET" ]

  Type of the location. This field indicates whether the location was created from REST endpoint (REGULAR) or from integration (INTEGRATION). Location(s) of type REGULAR are updatable

  Example: REGULAR

{
    "required":[
        "name"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The unique id of the object",
            "readOnly":true,
            "example":"53"
        },
        "name":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Name of the location. It must be unique per project, max length is 255 characters",
            "example":"My location name"
        },
        "description":{
            "type":"string",
            "description":"Description of the location",
            "example":"Description of the location"
        },
        "generated":{
            "type":"boolean",
            "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.",
            "example":false
        },
        "hazardous":{
            "type":"boolean",
            "description":"True if the location has been marked as hazardous, false otherwise",
            "readOnly":true,
            "example":false
        },
        "geoFenceId":{
            "type":"string",
            "description":"Geofence identifier associated with the location",
            "example":"828EDB09-A516-4485-AB60-CE1CFF5D8D8E"
        },
        "tags":{
            "uniqueItems":true,
            "type":"array",
            "description":"Tags associated with the location",
            "example":[
                "tag1",
                "tag2"
            ],
            "items":{
                "type":"string",
                "description":"Tags associated with the location",
                "example":"[\"tag1\",\"tag2\"]"
            }
        },
        "parentId":{
            "type":"string",
            "description":"Parent location specified by its identifier",
            "example":"51"
        },
        "locationPlanId":{
            "type":"string",
            "description":"Id of the location plan, the location is associated with",
            "example":"51"
        },
        "restrictedTime":{
            "minimum":1,
            "type":"integer",
            "description":"Maximum amount of time that employee can spend in the location 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 to reenter it again. If set to null, there is no restriction",
            "format":"int64",
            "example":51
        },
        "maxEmployeeCount":{
            "minimum":1,
            "type":"integer",
            "description":"Maximum amount of employees that can be in the location without penalty. Note that both maxEmployeeCount and maxEmployeeTime must be set together to null or not null values. If set to null, there is no restriction",
            "format":"int64",
            "example":51
        },
        "maxEmployeeTime":{
            "minimum":0,
            "type":"integer",
            "description":"The amount of time that the number of employees can be higher than maxEmployeeCount in a location without any penalty. Note that both maxEmployeeCount and maxEmployeeTime must be set together to null or not null values. If set to null, there is no restriction",
            "format":"int64",
            "example":51
        },
        "timeZone":{
            "type":"string",
            "description":"Time zone where of the location",
            "example":"Europe/Paris"
        },
        "type":{
            "type":"string",
            "description":"Type of the location. This field indicates whether the location was created from REST endpoint (REGULAR) or from integration (INTEGRATION). Location(s) of type REGULAR are updatable",
            "readOnly":true,
            "example":"REGULAR",
            "enum":[
                "REGULAR",
                "ASSET"
            ]
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : tags

Type: array

Unique Items Required: true

Tags associated with the location

Show Source

• Array of: string
  Tags associated with the location

  Example: ["tag1","tag2"]

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

Example:

[
    "tag1",
    "tag2"
]

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