Documentation Powered by ReDoc

Boundaries API (1.0)

Download OpenAPI specification:Download

Boundary Profiles

Get Boundary Profiles

Get all boundary profiles for a given branch. Boundary profiles serve as containers for many boundaries.

query Parameters
branchKey
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Upload Boundary Profile

Uploads a Boundary definition file (typically created in the Appian DirectRoute tool) to create a set of boundaries within a specified boundary profile. The intended name of the boundary profile will be passed in alongside the definition file itself.

Boundary definition files will express the shapes of the boundaries as well as any associated EQ code(s) for those boundaries.

query Parameters
branchKey
required
integer
name
string

Responses

Response samples

Content type
application/json
{
  • "boundaryProfileId": "string",
  • "name": "string",
  • "branchKey": 0,
  • "companyName": "string",
  • "uploaded": "2019-08-24T14:15:22Z",
  • "boundaries": [
    ]
}

Delete Boundary Profile

delete the specified boundary profile if it is not in use.

path Parameters
boundaryProfileId
required
string

Responses

Update Boundary Profile

Rename the specified boundary profile

path Parameters
boundaryProfileId
required
string
Request Body schema: application/json
name
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "boundaryProfileId": "string",
  • "name": "string",
  • "branchKey": 0,
  • "companyName": "string",
  • "uploaded": "2019-08-24T14:15:22Z"
}

Get Boundary Profile

path Parameters
boundaryProfileId
required
string

Responses

Response samples

Content type
application/json
{
  • "boundaryProfileId": "string",
  • "name": "string",
  • "branchKey": 0,
  • "companyName": "string",
  • "uploaded": "2019-08-24T14:15:22Z"
}

Get Boundaries within Profile

This API call is an alias for GET /boundaries?boundaryProfileKey.

path Parameters
boundaryProfileId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Boundaries

Get Boundaries by Profile

query Parameters
boundaryProfileId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Boundary

Request Body schema: application/json
boundaryProfileId
string
name
string
object (schemas)

GeoJSON representation of an object's location in coordinate space.

object (schemas)

Responses

Request samples

Content type
application/json
{
  • "boundaryProfileId": "string",
  • "name": "string",
  • "geometry": {
    },
  • "routingRules": {
    }
}

Response samples

Content type
application/json
{
  • "boundaryKey": 0,
  • "boundaryProfileKey": 0,
  • "boundaryId": "string",
  • "name": "string",
  • "geometry": {
    },
  • "routingRules": {
    }
}

Get Boundary

Get a single boundary's details by boundary key.

path Parameters
boundaryId
required
string

Responses

Response samples

Content type
application/json
{
  • "boundaryKey": 0,
  • "boundaryProfileKey": 0,
  • "boundaryId": "string",
  • "name": "string",
  • "geometry": {
    },
  • "routingRules": {
    }
}

Update Boundary

path Parameters
boundaryId
required
string
Request Body schema: application/json
name
string
object (schemas)

GeoJSON representation of an object's location in coordinate space.

object (schemas)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "Geometry": {
    },
  • "RoutingRules": {
    }
}

Response samples

Content type
application/json
{
  • "boundaryKey": 0,
  • "boundaryProfileKey": 0,
  • "boundaryId": "string",
  • "name": "string",
  • "geometry": {
    },
  • "routingRules": {
    }
}