Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

See also: JIRA link:

Jira Legacy
serverSystem Jira
serverId3122c0e4-6090-3a7d-9725-8b5a32a8eaeb
keyNONRTRIC-965

Table of Contents

How to use the NONRTRIC Information Coordination Service (ICS)

...

  • Data producer API: 

    • Information Type and Information Producer 

      • Producer CALLBACKS: GET healthcheck (supervision); Information Job Creation/Modification/Delete.

  • Data consumer API:

    • Information Type Subscription Creation/Modification/Delete (REGISTERED/UNREGISTERED); Information Job (Creation/Modification/Delete) and GET Information Type 

      • Consumer CALLBACKS: POST Information Type Status: REGISTERED/UNREGISTERED invoked when a Information type status has been changed

  • Service status API:

    • Returns statistics such as Number of Producers Types and Jobs

...

  • jobCallbackUrl: This URL serves as a callback endpoint for the producer. When the service needs to communicate or interact with the producer regarding a specific job, it sends requests to this URL. In the stopInfoJob() method, the service constructs a URL by appending the job ID to the jobCallbackUrl of the producer. Then it sends a DELETE request to this URL, effectively stopping the job. In the startInfoJob() method, the service sends a POST request to the jobCallbackUrl to start a job in the producer.

  • producerSupervisionCallbackUrl: This URL is used for health checks or supervision purposes. The service can send requests to this URL to check the health or status of the producer. In the healthCheck() method, the service sends a GET request to the producerSupervisionCallbackUrl to check the health of the producer.

...