Retrieve Collection Job Count

Scenario Overview

The CollectionService_GetCollectionJobCount API allows you to monitor the number of collection jobs in the system and their associated input, output, and error metrics. This information is useful for tracking job performance and identifying potential issues.

The CollectionService_GetCollectionJobCount API retrieves the count of collection jobs in the system, along with the counts of inputs, outputs, and errors for these jobs. You can specify a collection job ApplicationContext to retrieve counts for a specific job. If no ApplicationContext is specified, the API returns input, output, and error counts for all collection jobs in the system.

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

• Retrieve Collection Job Count 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 Count

To retrieve the count of collection jobs, update the collection_job_count_query.json input file with the required details (e.g., ApplicationContext), then run the collection_job_count_query.sh script from the example directory.

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

cd cnc-collections-api-examples;./collection_job_count_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_count_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 the input json with details of job for which we want counts in the file CNC_API_INPUT
    # STEP 3 :  Retrieve counts for collection job from the server and store the output in CNC_API_OUTPUT file

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

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