Skip to main content

Delayed connections batch status

During and after a batch is processed the status regarding the individual delayed connections can be tracked via API Delayed connections batch status.

The signature of this API is as follows. GET /api/v1/delayed-connections/batch/{id}

note

{id} is a GUID, for example 5e862306-673a-4744-9234-17f8063f52a0

Characteristics​

Actuality of data​

The Delayed connections batch status API retrieves the statuses from the Cocon Fiber database. Therefore the actuality of the data is real-time.

Quality of service​

The availability of the Delayed connections batch status API is similar to the other Cocon Fiber API's. Dependent on the type of subscription, specific rate limiting and/or quota measures may be in effect (see the general rate limiting information on the API's overview page).

Filtering and paging​

Filtering and paging are not applicable to the Delayed connections batch status API.

Security​

The Delayed connections batch status API uses system context authentication. See the general information about system context authentication on the APIs overview page.

Usage Guidelines​

There are certain specifics with regard to the usage of the Delayed connections batch status API, which are described below.

General usage​

Call the Delayed connections batch status endpoint in order to get the real-time status of the delayed connections (being) processed.

note

You can find the Delayed Connection API Specifications here

Request​

Example
GET /api/v1/delayed-connections/batch/5e862306-673a-4744-9234-17f8063f52a0

Parameters From query string

  • {id}: The batch id that uniquely identifies the batch containing the background jobs. (Type: string as GUID) e.g. 5e862306-673a-4744-9234-17f8063f52a0.

    The id was returned as a response by API Delayed connections batch after successfully creating the batch jobs.

Response​

On success (HTTP Status Code 200) the statuses of the individual delayed connections are returned.

Example of a response regarding a bulk operation in progress, containing five delayed connections:

A response regarding a bulk operation in progress, containing five delayed connections
{
  "batchId": "5e862306-673a-4744-9234-17f8063f52a0",
  "status": "InProgress",
  "success": [
      {
          "buildingName": "3573BR-27",
          "details": {
              "buildingId": "1490696",
              "cableId": "1269015",
              "frameId": "1031411",
              "patchPosition1Id": 387628,
              "patchPosition2Id": 765373
          }
      }
  ],
  "failure": [
      {
          "buildingName": "3573BR-25",
          "errors": [
              {
                  "code": "DC-0002",
                  "message": "Building not found"
              }
          ]
      },
      {
          "buildingName": "3573BR-29",
          "errors": [
              {
                  "code": "DC-0018",
                  "message": "No slack connected to building"
              }
          ]
      }
  ],
  "pending": [
	"buildingName": "3573BR-23",
	"buildingName": "3573BR-31"
  ]
}
note

Note that the jobs are processed asynchronously.

The status of the background batch job can contain the following values:

  • Finished
  • InProgress

The status is reported per delayed connection. The following three statuses can be reported:

  • Success - the delayed connection was processed successfully
  • Pending - the delayed connection is waiting to processed 
  • Failure - an expected (validation) error occurred during execution of the delayed connection. See page Delayed connections batch for details on validations.

In case of failure the specific error is stated. The possible errors are listed below.

Errors​

The failure fragment in the response contains relevant error codes for each failed job. These error codes are the same as the 'general' delayed connections error codes listed here: Delayed connections

note

See the generic Transactional API documentation for information about Error Responses.