Retrieve Collection Job State

Scenario Overview

The GetCollectionJobState API retrieves the overall state of a collection job based on operational counters. These counters provide insights into the progress and current status of the job, helping to monitor and troubleshoot collection operations in CNC.

The operations in the following API references are used in this example.

• Retrieve Collection Job State API

Prerequisites

Before running this example, ensure that you have obtained an access token. Refer to the 'Getting Started' section for instructions.

Get Collection Job State

To retrieve the state of a collection job, update the collection_job_state_query.json input file with the required details (e.g., job ID or ApplicationContext), then run the collection_job_state_query.sh script from the example directory.

Navigate to the cnc-collections-api-examples directory and run the collection_job_state_query.sh script using the following command:

cd cnc-collections-api-examples;./collection_job_state_query.sh

Script Details

#!/bin/bash
# Import common API functions and environment variables
# This script reads input from the .json file located in the input directory.
# Upon successful execution, the output is saved to the .json file in the output directory.
. ./cnc-api-common.sh

collection_job_state_query() {
    # Step 1: Ensure the CNC JWT is obtained by running the get-cnc-jwt.sh script.
    # Read the JWT from the file and export it as the AUTH_TOKEN_HDR environment variable.
     export_jwt

    # STEP 2 :  Update input json with details of job for which we want job state in the file CNC_API_INPUT
    # STEP 3 :  Retrieve job state for collection job from the server and store the output in CNC_API_OUTPUT file

    CNC_COLLECTION_API=$CNC_COLLECTION_API_CTX/collectionjob/state/query
    CNC_API_INPUT="@$PRJ/input/collection_job_state_query.json"	 
    CNC_API_OUTPUT="$PRJ/output/collection_job_state_query.json"

    # Step 4: Send a POST request to retrieve the state of the collection job and store the response in the output file.
    http_post $CNC_COLLECTION_API $CNC_API_INPUT $CNC_API_OUTPUT
    
}
collection_job_state_query