Working with the SCR API

Using the Service Component Repository (SCR) Application Programming Interface (API) is similar to building an iDML book. The same components of an iDML book are used when you use the SCR API implementation. They are the header, operation, payload, and the tail.

Note: Familiarize yourself with the information in the Importing resource information into the SCR section of this document, before attempting any of the operations in this section.

Header and operation

The SCRRegister function initiates the SCR API process and data acquisition. It creates the unique transaction ID that is required for all other functions so that the components and relationships created can be correctly associated with the single transaction. Using the SCRRegister function, two critical pieces of information are collected:
  • The management software system name
  • The transaction operation (refresh or delta)

The management software system name provides a connection between the source and the content that is being provided so that the SCR can integrate the information with data provided by other sources. The operation indicates to the SCR what operation is to be performed on the payload. Valid operations are refresh or delta. These operations are discussed in detail in the Custom namespace section of this guide.