Skip to page contentSkip to chat
ServiceNow support
    • Community
      Ask questions, give advice, and connect with fellow ServiceNow professionals.
      Developer
      Build, test, and deploy applications
      Documentation
      Find detailed information about ServiceNow products, apps, features, and releases.
      Impact
      Accelerate ROI and amplify your expertise.
      Learning
      Build skills with instructor-led and online training.
      Partner
      Grow your business with promotions, news, and marketing tools
      ServiceNow
      Learn about ServiceNow products & solutions.
      Store
      Download certified apps and integrations that complement ServiceNow.
      Support
      Manage your instances, access self-help, and get technical support.
API overview - life cycle flow - Support and Troubleshooting
  • >
  • Knowledge Base
  • >
  • Support and Troubleshooting (Knowledge Base)
  • >
  • API overview - life cycle flow
KB0854280

API overview - life cycle flow


556 Views Last updated : Sep 15, 2023 public Copy Permalink
KB Summary by Now Assist

SWEAGLE offers a set of APIs that allows creating, managing, and updating the config data set without the need for manual interactions through the user interface. There is a set of endpoints available to support the most common actions in each of the key steps in the life cycle of the configuration data. 

The "collect" is the step in which changes to the configuration data are brought into SWEAGLE. This consists of opening a data changeset, adding all the changes on nodes and CDIs into the changeset, validating there are no blocking factors, and approving the data changeset in order to apply the changes to the data model. 

The "consolidate" is where the applied changes are evaluated in the data model, listing the config data sets that are impacted by the data changes and for which there is pending data, and run any relevant validators to ensure there are no violations. 

The "snapshot" step is where the pending data is stored as an unalterable snapshot for every config data set. The new snapshot automatically becomes the current active snapshot which can be consumed through the API. All snapshots are stored in the system, and the history is available for analysis and comparison such as the DIFF calculation between any 2 snapshots in time. 

The "consume" step is where other tools and processes can request snapshot data through the API. Those requests can be for the full "dump" of the snapshot in a particular format, or it can be a request for a particular part of the data by calling a specific "exporter" with arguments. 

collect
  • /api/v1/data/bulk-operations/dataLoader/upload
  • add/modify/delete data from nodes and CDIs
consolidate
  • /api/v1/data/include/validate

  • /api/v1/tenant/metadata-parser/validate 

  • get validation result status for pending data of a data set
  • run a custom validator on a given data set
snapshot
  • /api/v1/data/include/snapshot/
  • snapshot the pending data for a given data set
consume
  • /api/v1/tenant/metadata-parser/parse
  • /api/v1/tenant/template-parser/replace
  • /api/v1/data/include/validate 
  • /api/v1/data/include/diff
  • get the content of a data set through an exporter
  • generate full resolved config file through a template
  • get the validation status of a given data set
  • difference between the current snapshot of 2 data sets

The world works with ServiceNow.

Sign in for more! There's more content available only to authenticated users Sign in for more!
Did this KB article help you?
Did this KB article help you?

How would you rate your Now Support digital experience?

*

Very unsatisfied

Unsatisfied

Neutral

Satisfied

Very satisfied

Very unsatisfied

Unsatisfied

Neutral

Satisfied

Very satisfied

What can we improve? Please select all that apply.

What are we doing well? Please select all that apply.

Tell us more

*

Do you expect a response from this feedback?

  • Terms and conditions
  • Privacy statement
  • GDPR
  • Cookie policy
  • © 2025 ServiceNow. All rights reserved.