Import selected local geoBoundaries gbOpen features into an existing or new geo zone set.

POST

/api/workspace/admin/geo-boundary-catalog/import

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://example.com/api/workspace/admin/geo-boundary-catalog/import"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
    Content = new StringContent("{ \"DatasetKey\": \"example\", \"FeatureIds\": [ \"example\" ], \"TargetZoneSetId\": \"example\", \"NewZoneSet\": { \"Name\": \"example\", \"Key\": \"example\", \"Description\": \"example\", \"Enabled\": true, \"ConflictMode\": 0, \"SortOrder\": 1 }, \"ChangeReason\": \"example\" }")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

const url = 'https://example.com/api/workspace/admin/geo-boundary-catalog/import';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"DatasetKey":"example","FeatureIds":["example"],"TargetZoneSetId":"example","NewZoneSet":{"Name":"example","Key":"example","Description":"example","Enabled":true,"ConflictMode":0,"SortOrder":1},"ChangeReason":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/workspace/admin/geo-boundary-catalog/import \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "DatasetKey": "example", "FeatureIds": [ "example" ], "TargetZoneSetId": "example", "NewZoneSet": { "Name": "example", "Key": "example", "Description": "example", "Enabled": true, "ConflictMode": 0, "SortOrder": 1 }, "ChangeReason": "example" }'

Authorizations

WorkspaceBearer

Parameters

Query Parameters

access_token

string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Request Body

Request payload for importing selected local administrative-boundary features.

object

DatasetKey

string

nullable

FeatureIds

Array<string>

nullable

TargetZoneSetId

string

nullable

NewZoneSet

Request payload for creating a geo zone set.

object

Name

string

nullable

Key

string

nullable

Description

string

nullable

Enabled

boolean

ConflictMode

integer format: int32

Allowed values: 0 1 2 3

SortOrder

integer format: int32

ChangeReason

string

nullable

Responses

200

application/json

object

Data

Result payload for an administrative-boundary catalog import.

object

GeoZoneSetId

string

nullable

DatasetKey

string

nullable

ImportedCount

integer format: int32

Zones

Array<object>

nullable

Imported geo zone produced from one local administrative-boundary feature.

object

GeoZoneId

string

nullable

Name

string

nullable

Key

string

nullable

FeatureId

string

nullable

ProviderBoundaryId

string

nullable

GeometryRevisionNumber

integer format: int32

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

400

Bad Request

application/json

object

Data

Result payload for an administrative-boundary catalog import.

object

GeoZoneSetId

string

nullable

DatasetKey

string

nullable

ImportedCount

integer format: int32

Zones

Array<object>

nullable

Imported geo zone produced from one local administrative-boundary feature.

object

GeoZoneId

string

nullable

Name

string

nullable

Key

string

nullable

FeatureId

string

nullable

ProviderBoundaryId

string

nullable

GeometryRevisionNumber

integer format: int32

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

403

Forbidden

application/json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Not Found

application/json

object

Data

Result payload for an administrative-boundary catalog import.

object

GeoZoneSetId

string

nullable

DatasetKey

string

nullable

ImportedCount

integer format: int32

Zones

Array<object>

nullable

Imported geo zone produced from one local administrative-boundary feature.

object

GeoZoneId

string

nullable

Name

string

nullable

Key

string

nullable

FeatureId

string

nullable

ProviderBoundaryId

string

nullable

GeometryRevisionNumber

integer format: int32

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

Import selected local geoBoundaries gbOpen features into an existing or new geo zone set.

Authorizations

Parameters

Query Parameters

Request Body

Responses

200

Example

400

Example

403

Examplegenerated

404

Example

Example^generated