import_template location layer profiles

post

https://<subdomain>.huvrdata.app/api/location-layer-profiles/import-template/

Import a Location Layer template, this endpoint can simply do the conversion to yaml
The action parameter switches between import/convert.
If the id is passed in it will attempt to update the exisiting template.

Required permissions:

IsAuthenticated
WorkspaceRequired
HasRolePermissions::UNDEFINED

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

name

string

required

length between 1 and 100

description

string | null

version

string

required

length between 1 and 20

User defined version.

categories

object

Optional list of categories used for organization.

state

string

enum

Profile state: DRAFT, ACTIVE, ARCHIVED

Allowed:

schema_version

integer

0 to 32767

Schema Version of template. Defines the structure of the data

guide

string | null

Instructions for categorizing the location defined in this profile (Optional).

geo_mode

string

enum

Location mode related to geo-tagging

Allowed:

component_mode

string

enum

How components are entered during inspections.

Allowed:

component_options

object

List of component options

component_help

string | null

Help text displayed for setting component (Optional).

component_validators

object

List of validators run when entering component (Optional).

zone_mode

string

enum

How zones are entered during inspections.

Allowed:

zone_help

string | null

Help text displayed for setting zone (Optional).

zone_validators

object

List of validators run when entering zone (Optional).

zone_options

object

List of zone options

code_mode

string

enum

How location codes are entered during inspections.

Allowed:

code_help

string | null

Help text displayed for setting code (Optional).

code_validators

object

List of validators run when entering code (Optional).

code_options

object

List of code options

access_mode

string

enum

How access codes are entered during inspections.

Allowed:

access_help

string | null

Help text displayed for setting access (Optional).

access_validators

object

List of validators run when entering access (Optional).

access_options

object

List of access options

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

Language

Credentials

Header

Loading…

Response

Choose an example:

application/json

application/yaml

200