Batches v1 · Batches

Download schema

Before calling these endpoints, use a Geoscape Hub application with access to this API product. Authenticate with your Consumer Key in the Authorization header. See Authentication, Error Handling, Rate Limiting, and Attribution for shared integration guidance.

Required response fields must be present when their containing object is returned. Supply the documented request parameters when calling the endpoint.

List batch jobs

GET

https://api.psma.com.au

/v1/batches/batch

Authorization (header)

Authentication: Use your Consumer Key in the Authorization header.

List your jobs as summaries in batchJobs. Follow links.next for additional pages. Use the ID in each summary to retrieve the full configuration.

Code
curl --fail-with-body \
  "https://api.psma.com.au/v1/batches/batch" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Accept: application/json"

List batch jobs › query Parameters

limit

integer · min: 1 · max: 1000

Maximum summaries per page. Defaults to 100 and accepts 1 to 1,000.

Default: 100

offset

integer · min: 0

Number of jobs to skip. Defaults to 0.

Default: 0

List batch jobs › Responses

Paginated summaries of your batch jobs.

Paginated job summaries. Retrieve each job by ID for its full configuration.

BatchesV1_BatchResponseSummaryList.v1

BatchesV1_BatchResponseSummary.v1[] · required

Job summaries for the current page.

BatchesV1_BatchPaginationLinks.v1

GET/v1/batches/batch

curl --fail-with-body \
  "https://api.psma.com.au/v1/batches/batch" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Accept: application/json"

Example Responses

{
  "batchJobs": [
    {
      "type": "addressGeocoder",
      "status": "Quoted",
      "displayName": "address-check",
      "batchInfo": {
        "batchId": "063b435f-22ca-43c6-ae1d-e697d50e514a",
        "createdAt": "2022-03-25T05:51:03.904108",
        "modifiedAt": "2022-03-25T05:51:03.904108",
        "executionRate": 5,
        "estimatedCreditCost": 21,
        "estimatedRunTime": "0:00:02",
        "totalRows": 21
      }
    }
  ],
  "links": {
    "numberMatched": 1,
    "numberReturned": 1,
    "self": "/v1/batches/batch?offset=0&limit=100"
  }
}

json

application/json

Submit batch job

POST

https://api.psma.com.au

/v1/batches/batch

Authorization (header)

Authentication: Use your Consumer Key in the Authorization header.

Validate a CSV job configuration and submit it for quoting. Returns Quoting with the job ID in batchInfo.batchId. Processing starts after /start, or after quoting when autoStart=true and sufficient credits are available. See Quickstart.

Code
curl --fail-with-body --request POST \
  "https://api.psma.com.au/v1/batches/batch" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  --data '{"type":"addressGeocoder","parameters":{"matchType":"Address"},"input":{"file":"https://example.com/input.csv","format":[{"name":"address","apiParameter":"address"}]},"output":{"format":[{"name":"Address ID","source":"$.features[0].properties.addressId"}]}}'

Submit batch job › Request Body

Job configuration. Match parameters and input mappings to type. See [Files and Mappings](/guides/batches/files-and-mappings).

BatchesV1_BatchRequest.v1

type

string · enum · required

Job type. Determines the Addresses v2 endpoint called for each CSV row.

Enum values:

addressGeocoder

mailPoint

reverseGeocoder

BatchesV1_BatchInput.v1 · required

Input file and column mappings.

Example: {"file":"https://example.com/input.csv","format":[{"name":"address","apiParameter":"address"}]}

BatchesV1_BatchOutput.v1 · required

Output destination and JSONPath column mappings.

Example: {"format":[{"name":"Matched Address","source":"$.features[0].properties.formattedAddress"},{"name":"Address ID","source":"$.features[0].properties.addressId"},{"name":"Parcel ID","source":"$.features[0].properties.cadastralIdentifier"},{"name":"Meshblock 2021","source":"$.features[0].properties.asgsMain[?(@.censusYear == 2021)].mbId"},{"name":"LGA","source":"$.features[0].properties.localGovernmentArea.lgaName"}]}

Job-wide settings. Geocoder and reverse-geocoder jobs require matchType. MailPoint parameters can be omitted.

autoStart

boolean

Queue the job after quoting when true and sufficient credits are available. Defaults to false.

Default: false

returnDownloadLink

boolean

Include batchInfo.downloadPath after completion. Forced to true when output.file is omitted. With an output destination, defaults to false.

Submit batch job › Responses

Job configuration and current status.

Job configuration and current status. Optional quote, progress, and download fields depend on the lifecycle stage.

BatchesV1_BatchResponse.v1

type

string · enum · required

Job type. Determines the Addresses v2 endpoint called for each CSV row.

Enum values:

addressGeocoder

mailPoint

reverseGeocoder

BatchesV1_BatchInfo.v1 · required

Informational job fields returned by the service. Do not supply these as request settings.

required

Job-wide settings. Geocoder and reverse-geocoder jobs require matchType. MailPoint parameters can be omitted.

BatchesV1_BatchInput.v1 · required

Input file and column mappings.

Example: {"file":"https://example.com/input.csv","format":[{"name":"address","apiParameter":"address"}]}

BatchesV1_BatchOutput.v1 · required

Output destination and JSONPath column mappings.

status

string · enum · required

Current processing state. See Managing Jobs.

Enum values:

Quoting

Quoted

Queued

Running

Completed

Failed

Cancelled

displayName

string

Job display name assigned by the service when one is not supplied.

messages

string[]

Job information, including download access restrictions, when supplied.

autoStart

boolean

Queue the job after quoting when true and sufficient credits are available. Defaults to false.

Default: false

returnDownloadLink

boolean

Include batchInfo.downloadPath after completion. Forced to true when output.file is omitted. With an output destination, defaults to false.

POST/v1/batches/batch

curl --fail-with-body --request POST \
  "https://api.psma.com.au/v1/batches/batch" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  --data '{"type":"addressGeocoder","parameters":{"matchType":"Address"},"input":{"file":"https://example.com/input.csv","format":[{"name":"address","apiParameter":"address"}]},"output":{"format":[{"name":"Address ID","source":"$.features[0].properties.addressId"}]}}'

Example Request Body

{
  "type": "addressGeocoder",
  "parameters": {
    "matchType": "Address",
    "additionalProperties": [
      "localGovernmentArea",
      "asgsMain"
    ]
  },
  "input": {
    "file": "https://example.com/input.csv",
    "format": [
      {
        "name": "address",
        "apiParameter": "address"
      }
    ]
  },
  "output": {
    "format": [
      {
        "name": "Matched Address",
        "source": "$.features[0].properties.formattedAddress"
      },
      {
        "name": "Address ID",
        "source": "$.features[0].properties.addressId"
      },
      {
        "name": "Parcel ID",
        "source": "$.features[0].properties.cadastralIdentifier"
      },
      {
        "name": "Meshblock 2021",
        "source": "$.features[0].properties.asgsMain[?(@.censusYear == 2021)].mbId"
      },
      {
        "name": "LGA",
        "source": "$.features[0].properties.localGovernmentArea.lgaName"
      }
    ]
  }
}

json

application/json

Example Responses

{
  "type": "addressGeocoder",
  "parameters": {
    "matchType": "Address",
    "additionalProperties": [
      "localGovernmentArea",
      "asgsMain"
    ]
  },
  "input": {
    "file": "https://example.com/input.csv",
    "format": [
      {
        "name": "address",
        "apiParameter": "address"
      }
    ]
  },
  "output": {
    "format": [
      {
        "name": "Matched Address",
        "source": "$.features[0].properties.formattedAddress"
      },
      {
        "name": "Address ID",
        "source": "$.features[0].properties.addressId"
      },
      {
        "name": "Parcel ID",
        "source": "$.features[0].properties.cadastralIdentifier"
      },
      {
        "name": "Meshblock 2021",
        "source": "$.features[0].properties.asgsMain[?(@.censusYear == 2021)].mbId"
      },
      {
        "name": "LGA",
        "source": "$.features[0].properties.localGovernmentArea.lgaName"
      }
    ]
  },
  "displayName": "address-check",
  "status": "Quoting",
  "batchInfo": {
    "batchId": "063b435f-22ca-43c6-ae1d-e697d50e514a",
    "createdAt": "2022-03-25T05:51:03.904108",
    "modifiedAt": "2022-03-25T05:51:03.904108",
    "executionRate": 5
  },
  "returnDownloadLink": true
}

json

application/json

Get batch job status

GET

https://api.psma.com.au

/v1/batches/batch/{batchId}

Authorization (header)

Authentication: Use your Consumer Key in the Authorization header.

Retrieve the job configuration, status, and available quote or progress fields. A completed job can include batchInfo.downloadPath when requested and permitted. Check messages for access restrictions.

Set BATCH_ID to the returned batchInfo.batchId.

Code
curl --fail-with-body \
  "https://api.psma.com.au/v1/batches/batch/$BATCH_ID" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Accept: application/json"

Get batch job status › path Parameters

batchId

string · required

Get batch job status › Responses

Job configuration and current status.

Job configuration and current status. Optional quote, progress, and download fields depend on the lifecycle stage.

BatchesV1_BatchResponse.v1

type

string · enum · required

Job type. Determines the Addresses v2 endpoint called for each CSV row.

Enum values:

addressGeocoder

mailPoint

reverseGeocoder

BatchesV1_BatchInfo.v1 · required

Informational job fields returned by the service. Do not supply these as request settings.

required

Job-wide settings. Geocoder and reverse-geocoder jobs require matchType. MailPoint parameters can be omitted.

BatchesV1_BatchInput.v1 · required

Input file and column mappings.

Example: {"file":"https://example.com/input.csv","format":[{"name":"address","apiParameter":"address"}]}

BatchesV1_BatchOutput.v1 · required

Output destination and JSONPath column mappings.

status

string · enum · required

Current processing state. See Managing Jobs.

Enum values:

Quoting

Quoted

Queued

Running

Completed

Failed

Cancelled

displayName

string

Job display name assigned by the service when one is not supplied.

messages

string[]

Job information, including download access restrictions, when supplied.

autoStart

boolean

Queue the job after quoting when true and sufficient credits are available. Defaults to false.

Default: false

returnDownloadLink

boolean

Include batchInfo.downloadPath after completion. Forced to true when output.file is omitted. With an output destination, defaults to false.

GET/v1/batches/batch/{batchId}

curl --fail-with-body \
  "https://api.psma.com.au/v1/batches/batch/$BATCH_ID" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Accept: application/json"

Example Responses

{
  "type": "addressGeocoder",
  "parameters": {
    "matchType": "Address",
    "additionalProperties": [
      "localGovernmentArea",
      "asgsMain"
    ]
  },
  "input": {
    "file": "https://example.com/input.csv",
    "format": [
      {
        "name": "address",
        "apiParameter": "address"
      }
    ]
  },
  "output": {
    "format": [
      {
        "name": "Matched Address",
        "source": "$.features[0].properties.formattedAddress"
      },
      {
        "name": "Address ID",
        "source": "$.features[0].properties.addressId"
      },
      {
        "name": "Parcel ID",
        "source": "$.features[0].properties.cadastralIdentifier"
      },
      {
        "name": "Meshblock 2021",
        "source": "$.features[0].properties.asgsMain[?(@.censusYear == 2021)].mbId"
      },
      {
        "name": "LGA",
        "source": "$.features[0].properties.localGovernmentArea.lgaName"
      }
    ]
  },
  "displayName": "address-check",
  "status": "Quoted",
  "batchInfo": {
    "batchId": "063b435f-22ca-43c6-ae1d-e697d50e514a",
    "createdAt": "2022-03-25T05:51:03.904108",
    "modifiedAt": "2022-03-25T05:51:03.904108",
    "executionRate": 5,
    "estimatedCreditCost": 21,
    "estimatedRunTime": "0:00:02",
    "totalRows": 21
  },
  "returnDownloadLink": true
}

json

application/json

Update batch job

PUT

https://api.psma.com.au

/v1/batches/batch/{batchId}

Authorization (header)

Authentication: Use your Consumer Key in the Authorization header.

Replace the configuration of a Quoted or Cancelled job. Supply the complete JSON configuration. Changes trigger quoting again. An unchanged configuration returns the existing job.

Set BATCH_ID to the returned batchInfo.batchId.

Code
curl --fail-with-body --request PUT \
  "https://api.psma.com.au/v1/batches/batch/$BATCH_ID" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  --data '{"type":"addressGeocoder","parameters":{"matchType":"Address"},"input":{"file":"https://example.com/input.csv","format":[{"name":"address","apiParameter":"address"}]},"output":{"format":[{"name":"Address ID","source":"$.features[0].properties.addressId"}]}}'

Update batch job › path Parameters

batchId

string · required

Update batch job › Request Body

Job configuration. Match parameters and input mappings to type. See [Files and Mappings](/guides/batches/files-and-mappings).

BatchesV1_BatchRequest.v1

type

string · enum · required

Job type. Determines the Addresses v2 endpoint called for each CSV row.

Enum values:

addressGeocoder

mailPoint

reverseGeocoder

BatchesV1_BatchInput.v1 · required

Input file and column mappings.

Example: {"file":"https://example.com/input.csv","format":[{"name":"address","apiParameter":"address"}]}

BatchesV1_BatchOutput.v1 · required

Output destination and JSONPath column mappings.

Job-wide settings. Geocoder and reverse-geocoder jobs require matchType. MailPoint parameters can be omitted.

autoStart

boolean

Queue the job after quoting when true and sufficient credits are available. Defaults to false.

Default: false

returnDownloadLink

boolean

Include batchInfo.downloadPath after completion. Forced to true when output.file is omitted. With an output destination, defaults to false.

Update batch job › Responses

Job configuration and current status.

Job configuration and current status. Optional quote, progress, and download fields depend on the lifecycle stage.

BatchesV1_BatchResponse.v1

type

string · enum · required

Job type. Determines the Addresses v2 endpoint called for each CSV row.

Enum values:

addressGeocoder

mailPoint

reverseGeocoder

BatchesV1_BatchInfo.v1 · required

Informational job fields returned by the service. Do not supply these as request settings.

required

Job-wide settings. Geocoder and reverse-geocoder jobs require matchType. MailPoint parameters can be omitted.

BatchesV1_BatchInput.v1 · required

Input file and column mappings.

Example: {"file":"https://example.com/input.csv","format":[{"name":"address","apiParameter":"address"}]}

BatchesV1_BatchOutput.v1 · required

Output destination and JSONPath column mappings.

status

string · enum · required

Current processing state. See Managing Jobs.

Enum values:

Quoting

Quoted

Queued

Running

Completed

Failed

Cancelled

displayName

string

Job display name assigned by the service when one is not supplied.

messages

string[]

Job information, including download access restrictions, when supplied.

autoStart

boolean

Queue the job after quoting when true and sufficient credits are available. Defaults to false.

Default: false

returnDownloadLink

boolean

Include batchInfo.downloadPath after completion. Forced to true when output.file is omitted. With an output destination, defaults to false.

PUT/v1/batches/batch/{batchId}

curl --fail-with-body --request PUT \
  "https://api.psma.com.au/v1/batches/batch/$BATCH_ID" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  --data '{"type":"addressGeocoder","parameters":{"matchType":"Address"},"input":{"file":"https://example.com/input.csv","format":[{"name":"address","apiParameter":"address"}]},"output":{"format":[{"name":"Address ID","source":"$.features[0].properties.addressId"}]}}'

Example Request Body

{
  "type": "addressGeocoder",
  "parameters": {
    "matchType": "Address",
    "additionalProperties": [
      "localGovernmentArea",
      "asgsMain"
    ]
  },
  "input": {
    "file": "https://example.com/input.csv",
    "format": [
      {
        "name": "address",
        "apiParameter": "address"
      }
    ]
  },
  "output": {
    "format": [
      {
        "name": "Matched Address",
        "source": "$.features[0].properties.formattedAddress"
      },
      {
        "name": "Address ID",
        "source": "$.features[0].properties.addressId"
      },
      {
        "name": "Parcel ID",
        "source": "$.features[0].properties.cadastralIdentifier"
      },
      {
        "name": "Meshblock 2021",
        "source": "$.features[0].properties.asgsMain[?(@.censusYear == 2021)].mbId"
      },
      {
        "name": "LGA",
        "source": "$.features[0].properties.localGovernmentArea.lgaName"
      }
    ]
  }
}

json

application/json

Example Responses

{
  "type": "addressGeocoder",
  "parameters": {
    "matchType": "Address",
    "additionalProperties": [
      "localGovernmentArea",
      "asgsMain"
    ]
  },
  "input": {
    "file": "https://example.com/input.csv",
    "format": [
      {
        "name": "address",
        "apiParameter": "address"
      }
    ]
  },
  "output": {
    "format": [
      {
        "name": "Matched Address",
        "source": "$.features[0].properties.formattedAddress"
      },
      {
        "name": "Address ID",
        "source": "$.features[0].properties.addressId"
      },
      {
        "name": "Parcel ID",
        "source": "$.features[0].properties.cadastralIdentifier"
      },
      {
        "name": "Meshblock 2021",
        "source": "$.features[0].properties.asgsMain[?(@.censusYear == 2021)].mbId"
      },
      {
        "name": "LGA",
        "source": "$.features[0].properties.localGovernmentArea.lgaName"
      }
    ]
  },
  "displayName": "address-check",
  "status": "Quoting",
  "batchInfo": {
    "batchId": "063b435f-22ca-43c6-ae1d-e697d50e514a",
    "createdAt": "2022-03-25T05:51:03.904108",
    "modifiedAt": "2022-03-25T05:51:03.904108",
    "executionRate": 5
  },
  "returnDownloadLink": true
}

json

application/json

Start batch job

POST

https://api.psma.com.au

/v1/batches/batch/{batchId}/start

Authorization (header)

Authentication: Use your Consumer Key in the Authorization header.

Queue a Quoted job for processing. A Cancelled job is requoted and starts automatically after quoting. No request body is required. Sufficient credits are needed to start. See Managing Jobs.

Set BATCH_ID to the returned batchInfo.batchId.

Code
curl --fail-with-body --request POST \
  "https://api.psma.com.au/v1/batches/batch/$BATCH_ID/start" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Accept: application/json"

Start batch job › path Parameters

batchId

string · required

Start batch job › Responses

Job configuration and current status.

Job configuration and current status. Optional quote, progress, and download fields depend on the lifecycle stage.

BatchesV1_BatchResponse.v1

type

string · enum · required

Job type. Determines the Addresses v2 endpoint called for each CSV row.

Enum values:

addressGeocoder

mailPoint

reverseGeocoder

BatchesV1_BatchInfo.v1 · required

Informational job fields returned by the service. Do not supply these as request settings.

required

Job-wide settings. Geocoder and reverse-geocoder jobs require matchType. MailPoint parameters can be omitted.

BatchesV1_BatchInput.v1 · required

Input file and column mappings.

Example: {"file":"https://example.com/input.csv","format":[{"name":"address","apiParameter":"address"}]}

BatchesV1_BatchOutput.v1 · required

Output destination and JSONPath column mappings.

status

string · enum · required

Current processing state. See Managing Jobs.

Enum values:

Quoting

Quoted

Queued

Running

Completed

Failed

Cancelled

displayName

string

Job display name assigned by the service when one is not supplied.

messages

string[]

Job information, including download access restrictions, when supplied.

autoStart

boolean

Queue the job after quoting when true and sufficient credits are available. Defaults to false.

Default: false

returnDownloadLink

boolean

Include batchInfo.downloadPath after completion. Forced to true when output.file is omitted. With an output destination, defaults to false.

POST/v1/batches/batch/{batchId}/start

curl --fail-with-body --request POST \
  "https://api.psma.com.au/v1/batches/batch/$BATCH_ID/start" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Accept: application/json"

Example Responses

{
  "type": "addressGeocoder",
  "parameters": {
    "matchType": "Address",
    "additionalProperties": [
      "localGovernmentArea",
      "asgsMain"
    ]
  },
  "input": {
    "file": "https://example.com/input.csv",
    "format": [
      {
        "name": "address",
        "apiParameter": "address"
      }
    ]
  },
  "output": {
    "format": [
      {
        "name": "Matched Address",
        "source": "$.features[0].properties.formattedAddress"
      },
      {
        "name": "Address ID",
        "source": "$.features[0].properties.addressId"
      },
      {
        "name": "Parcel ID",
        "source": "$.features[0].properties.cadastralIdentifier"
      },
      {
        "name": "Meshblock 2021",
        "source": "$.features[0].properties.asgsMain[?(@.censusYear == 2021)].mbId"
      },
      {
        "name": "LGA",
        "source": "$.features[0].properties.localGovernmentArea.lgaName"
      }
    ]
  },
  "displayName": "address-check",
  "status": "Queued",
  "batchInfo": {
    "batchId": "063b435f-22ca-43c6-ae1d-e697d50e514a",
    "createdAt": "2022-03-25T05:51:03.904108",
    "modifiedAt": "2022-03-25T05:51:03.904108",
    "executionRate": 5
  },
  "returnDownloadLink": true
}

json

application/json

Stop batch job

POST

https://api.psma.com.au

/v1/batches/batch/{batchId}/stop

Authorization (header)

Authentication: Use your Consumer Key in the Authorization header.

Stop a Quoted, Queued, or Running job. Returns Cancelled. No request body is required. See Managing Jobs.

Set BATCH_ID to the returned batchInfo.batchId.

Code
curl --fail-with-body --request POST \
  "https://api.psma.com.au/v1/batches/batch/$BATCH_ID/stop" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Accept: application/json"

Stop batch job › path Parameters

batchId

string · required

Stop batch job › Responses

Job configuration and current status.

Job configuration and current status. Optional quote, progress, and download fields depend on the lifecycle stage.

BatchesV1_BatchResponse.v1

type

string · enum · required

Job type. Determines the Addresses v2 endpoint called for each CSV row.

Enum values:

addressGeocoder

mailPoint

reverseGeocoder

BatchesV1_BatchInfo.v1 · required

Informational job fields returned by the service. Do not supply these as request settings.

required

Job-wide settings. Geocoder and reverse-geocoder jobs require matchType. MailPoint parameters can be omitted.

BatchesV1_BatchInput.v1 · required

Input file and column mappings.

Example: {"file":"https://example.com/input.csv","format":[{"name":"address","apiParameter":"address"}]}

BatchesV1_BatchOutput.v1 · required

Output destination and JSONPath column mappings.

status

string · enum · required

Current processing state. See Managing Jobs.

Enum values:

Quoting

Quoted

Queued

Running

Completed

Failed

Cancelled

displayName

string

Job display name assigned by the service when one is not supplied.

messages

string[]

Job information, including download access restrictions, when supplied.

autoStart

boolean

Queue the job after quoting when true and sufficient credits are available. Defaults to false.

Default: false

returnDownloadLink

boolean

Include batchInfo.downloadPath after completion. Forced to true when output.file is omitted. With an output destination, defaults to false.

POST/v1/batches/batch/{batchId}/stop

curl --fail-with-body --request POST \
  "https://api.psma.com.au/v1/batches/batch/$BATCH_ID/stop" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Accept: application/json"

Example Responses

{
  "type": "addressGeocoder",
  "parameters": {
    "matchType": "Address",
    "additionalProperties": [
      "localGovernmentArea",
      "asgsMain"
    ]
  },
  "input": {
    "file": "https://example.com/input.csv",
    "format": [
      {
        "name": "address",
        "apiParameter": "address"
      }
    ]
  },
  "output": {
    "format": [
      {
        "name": "Matched Address",
        "source": "$.features[0].properties.formattedAddress"
      },
      {
        "name": "Address ID",
        "source": "$.features[0].properties.addressId"
      },
      {
        "name": "Parcel ID",
        "source": "$.features[0].properties.cadastralIdentifier"
      },
      {
        "name": "Meshblock 2021",
        "source": "$.features[0].properties.asgsMain[?(@.censusYear == 2021)].mbId"
      },
      {
        "name": "LGA",
        "source": "$.features[0].properties.localGovernmentArea.lgaName"
      }
    ]
  },
  "displayName": "address-check",
  "status": "Cancelled",
  "batchInfo": {
    "batchId": "063b435f-22ca-43c6-ae1d-e697d50e514a",
    "createdAt": "2022-03-25T05:51:03.904108",
    "modifiedAt": "2022-03-25T05:51:03.904108",
    "executionRate": 5
  },
  "returnDownloadLink": true
}

json

application/json

Delete batch jobs

POST

https://api.psma.com.au

/v1/batches/batch/delete

Authorization (header)

Authentication: Use your Consumer Key in the Authorization header.

Delete one or more of your jobs in Quoted, Completed, Failed, or Cancelled status. Send a JSON array of job IDs. This operation uses POST.

HTTP 200 reports the deletion results, even when some or all jobs could not be deleted
Check summary.failed and details.failed before treating the operation as successful
Deleted jobs are no longer available through the public job lookup or list. Save any results you need before deleting

See Managing Jobs for failure codes and examples. Use your application's Consumer Key as the Authorization header value.

Code
curl --fail-with-body --request POST \
  "https://api.psma.com.au/v1/batches/batch/delete" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  --data '["063b435f-22ca-43c6-ae1d-e697d50e514a"]'

Delete batch jobs › Request Body

string[]

Delete batch jobs › Responses

Per-job results. State, ownership, and missing-job failures are reported in the body rather than the HTTP status.

Deletion results grouped by outcome. The order of failure groups is not guaranteed.

BatchesV1_BatchDeletionResponse.v1

object · required

Administrative Boundaries v1 · Admin Bounds Buildings v2.1 · Building