Jump to

• Request
• Response

Batch Create Locations

post

/api/restapi/location/batch

Send a request to this endpoint to create one or more locations. An application object will be created for each JSON object provided in the request body.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : List<ApiEntityLocationInput>

Type: array

Title: List<ApiEntityLocationInput>

Show Source

• Array of: object ApiEntityLocationInput
  Title: ApiEntityLocationInput

  This entity represents a Location object, a unique Location object can be identified by the following combinations of the fields.

  • locationId
  • locationCode,workspaceId
  • locationCode,workspaceCode

{
    "title":"List<ApiEntityLocationInput>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityLocationInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityLocationInput

Type: object

Title: ApiEntityLocationInput

This entity represents a Location object, a unique Location object can be identified by the following combinations of the fields.

• locationId
• locationCode,workspaceId
• locationCode,workspaceCode

Show Source

• addressLine1: string
  Minimum Length: 0

  Maximum Length: 200

  The first line of the address of a location.
  This might be the building number and street address.
• addressLine2: string
  Minimum Length: 0

  Maximum Length: 200

  The second line of the address of a location.
  This might be a neighborhood or town.
• associationType: string
  Read Only: true

  Allowed Values: [ "OWNED", "INHERITED" ]

  Deprecated. As of 24.4.
  The type of association in the relationship between the location and the workspace. Possible values are Owned and Inherited.
• cityName: string
  Minimum Length: 0

  Maximum Length: 200

  The city name for a location.
• countryCode: string
  Minimum Length: 0

  Maximum Length: 3

  The country for a location. The value is expressed as a three letter code.
• description: string
  Minimum Length: 0

  Maximum Length: 4000

  Additional details about the location.
• latitude: number (double)
  Minimum Value: -90

  Maximum Value: 90

  The geographical coordinate for the latitude of the location.
  The default format for latitude is decimal degrees format, but the format you need to use will depend on your geolocation service.
• link: string (url)
  Read Only: true

  Deprecated. As of 24.4.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• locationCode: string
  Minimum Length: 1

  Maximum Length: 60

  The user-specified unique identifier of the location.
• locationId: integer (int64)
  The unique identifier for the location.
• locationName(required): string
  Minimum Length: 1

  Maximum Length: 255

  A name for the location that your users will understand and recognize.
• longitude: number (double)
  Minimum Value: -180

  Maximum Value: 180

  The geographical coordinate for the longitude of the location.
  The default format for longitude is decimal degrees format, but the format you need to use will depend on your geolocation service.
• postalCode: string
  Minimum Length: 0

  Maximum Length: 20

  The postal code, post code, or zip code of a location.
• pushDownType: string
  Allowed Values: [ "MANUAL", "AUTOMATIC" ]

  The push down type of the location.
• stateCode: string
  Minimum Length: 0

  Maximum Length: 2

  A unique identifier for the state or province.
• stateName: string
  Minimum Length: 0

  Maximum Length: 200

  The state, region, or province of a location.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 24.4.
  Date when the record was last updated.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.
• workspaceId(required): integer (int64)
  The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.

{
    "title":"ApiEntityLocationInput",
    "required":[
        "locationName",
        "workspaceId"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.4</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "description":{
            "maxLength":"4000",
            "minLength":"0",
            "type":"string",
            "description":"Additional details about the location.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.4</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "locationId":{
            "type":"integer",
            "description":"The unique identifier for the location.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "locationName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"A name for the location that your users will understand and recognize.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "locationCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified unique identifier of the location.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "pushDownType":{
            "type":"string",
            "description":"The push down type of the location.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "MANUAL",
                "AUTOMATIC"
            ]
        },
        "associationType":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.4</i>.</br>The type of association in the relationship between the location and the workspace. Possible values are Owned and Inherited.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "OWNED",
                "INHERITED"
            ]
        },
        "addressLine1":{
            "maxLength":"200",
            "minLength":"0",
            "type":"string",
            "description":"The first line of the address of a location. <br />This might be the building number and street address.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "addressLine2":{
            "maxLength":"200",
            "minLength":"0",
            "type":"string",
            "description":"The second line of the address of a location. <br />This might be a neighborhood or town.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "cityName":{
            "maxLength":"200",
            "minLength":"0",
            "type":"string",
            "description":"The city name for a location.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "stateName":{
            "maxLength":"200",
            "minLength":"0",
            "type":"string",
            "description":"The state, region, or province of a location.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "postalCode":{
            "maxLength":"20",
            "minLength":"0",
            "type":"string",
            "description":"The postal code, post code, or zip code of a location.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "countryCode":{
            "maxLength":"3",
            "minLength":"0",
            "type":"string",
            "description":"The country for a location. The value is expressed as a three letter code.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "latitude":{
            "maximum":"90",
            "minimum":"-90",
            "type":"number",
            "description":"The geographical coordinate for the latitude of the location. <br />The default format for latitude is decimal degrees format, but the format you need to use will depend on your geolocation service.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "longitude":{
            "maximum":"180",
            "minimum":"-180",
            "type":"number",
            "description":"The geographical coordinate for the longitude of the location. <br />The default format for longitude is decimal degrees format, but the format you need to use will depend on your geolocation service.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "stateCode":{
            "maxLength":"2",
            "minLength":"0",
            "type":"string",
            "description":"A unique identifier for the state or province.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a Location object, a unique Location object can be identified by the following combinations of the fields.<ul><li>locationId</li><li>locationCode,workspaceId</li><li>locationCode,workspaceCode</li>",
    "exampleSetFlag":false
}

Examples

Select an example Batch Create Locations

Back to Top

Response

Supported Media Types

• application/json

201 Response

The object was successfully created.

Body ()

Root Schema : List<ApiEntityLocation>

Type: array

Title: List<ApiEntityLocation>

Show Source

• Array of: object ApiEntityLocation
  Title: ApiEntityLocation

{
    "title":"List<ApiEntityLocation>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityLocation",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityLocation

Type: object

Title: ApiEntityLocation

Show Source

• addressLine1: string
  Minimum Length: 0

  Maximum Length: 200

  The first line of the address of a location.
  This might be the building number and street address.
• addressLine2: string
  Minimum Length: 0

  Maximum Length: 200

  The second line of the address of a location.
  This might be a neighborhood or town.
• associationType: string
  Allowed Values: [ "OWNED", "INHERITED" ]

  The type of association in the relationship between the location and the workspace. Possible values are Owned and Inherited.
• cityName: string
  Minimum Length: 0

  Maximum Length: 200

  The city name for a location.
• countryCode: string
  Minimum Length: 0

  Maximum Length: 3

  The country for a location. The value is expressed as a three letter code.
• description: string
  Minimum Length: 0

  Maximum Length: 4000

  Additional details about the location.
• latitude: number (double)
  Minimum Value: -90

  Maximum Value: 90

  The geographical coordinate for the latitude of the location.
  The default format for latitude is decimal degrees format, but the format you need to use will depend on your geolocation service.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• locationCode: string
  Minimum Length: 1

  Maximum Length: 60

  The user-specified unique identifier of the location.
• locationId: integer (int64)
  The unique identifier for the location.
• locationName: string
  Minimum Length: 1

  Maximum Length: 255

  A name for the location that your users will understand and recognize.
• longitude: number (double)
  Minimum Value: -180

  Maximum Value: 180

  The geographical coordinate for the longitude of the location.
  The default format for longitude is decimal degrees format, but the format you need to use will depend on your geolocation service.
• postalCode: string
  Minimum Length: 0

  Maximum Length: 20

  The postal code, post code, or zip code of a location.
• pushDownType: string
  Allowed Values: [ "MANUAL", "AUTOMATIC" ]

  The push down type of the location.
• stateCode: string
  Minimum Length: 0

  Maximum Length: 2

  A unique identifier for the state or province.
• stateName: string
  Minimum Length: 0

  Maximum Length: 200

  The state, region, or province of a location.
• updateDate: string (date-time)
  Date when the record was last updated.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.

{
    "title":"ApiEntityLocation",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "description":{
            "maxLength":"4000",
            "minLength":"0",
            "type":"string",
            "description":"Additional details about the location.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "locationId":{
            "type":"integer",
            "description":"The unique identifier for the location.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "locationName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"A name for the location that your users will understand and recognize.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "locationCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified unique identifier of the location.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "pushDownType":{
            "type":"string",
            "description":"The push down type of the location.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "MANUAL",
                "AUTOMATIC"
            ]
        },
        "associationType":{
            "type":"string",
            "description":"The type of association in the relationship between the location and the workspace. Possible values are Owned and Inherited.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "OWNED",
                "INHERITED"
            ]
        },
        "addressLine1":{
            "maxLength":"200",
            "minLength":"0",
            "type":"string",
            "description":"The first line of the address of a location. <br />This might be the building number and street address.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "addressLine2":{
            "maxLength":"200",
            "minLength":"0",
            "type":"string",
            "description":"The second line of the address of a location. <br />This might be a neighborhood or town.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "cityName":{
            "maxLength":"200",
            "minLength":"0",
            "type":"string",
            "description":"The city name for a location.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "stateName":{
            "maxLength":"200",
            "minLength":"0",
            "type":"string",
            "description":"The state, region, or province of a location.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "postalCode":{
            "maxLength":"20",
            "minLength":"0",
            "type":"string",
            "description":"The postal code, post code, or zip code of a location.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "countryCode":{
            "maxLength":"3",
            "minLength":"0",
            "type":"string",
            "description":"The country for a location. The value is expressed as a three letter code.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "latitude":{
            "maximum":"90",
            "minimum":"-90",
            "type":"number",
            "description":"The geographical coordinate for the latitude of the location. <br />The default format for latitude is decimal degrees format, but the format you need to use will depend on your geolocation service.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "longitude":{
            "maximum":"180",
            "minimum":"-180",
            "type":"number",
            "description":"The geographical coordinate for the longitude of the location. <br />The default format for longitude is decimal degrees format, but the format you need to use will depend on your geolocation service.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "stateCode":{
            "maxLength":"2",
            "minLength":"0",
            "type":"string",
            "description":"A unique identifier for the state or province.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

400 Response

Invalid input for the Location service. Verify the request contains valid data, then resubmit the request.

Back to Top