Retrieve Configuration for a Collection Job

Scenario Overview

The GetCollectionJobConfig API allows you to retrieve detailed configuration information for collection jobs in CNC. This includes sensor configurations, device sets, and their destinations, helping you validate and monitor job configurations.

The GetCollectionJobConfig API retrieves configuration details for a collection job within the Collection Service API. It provides all sensor configurations, device sets, and their destinations. Specifying an ApplicationContext is optional when using this API.

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

• Retrieve Collection Job Config API

Prerequisites

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

Get Configuration Details for Collection Job

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

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

cd cnc-collections-api-examples;./collection_job_config_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_config_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 you want the config details in the file CNC_API_INPUT
    # STEP 3 :  Retrieve configs for collection job from the server and store the output in CNC_API_OUTPUT file

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

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