APIs Available in Brand Compliance

3 APIs Available in Brand Compliance

The APIs deployed in a particular implementation of Brand Compliance can be found at /services: https://<hostname>/<context>/services.

Individual Services

The following table lists the individual services available in Brand Compliance, indicating at which version each was introduced and, where appropriate, at which version it was deprecated.

Brand Compliance API Services

Service Name and Functions	Description	Type	From Version	To Version
User Details
userDetails	Manages single sign-on between the main Brand Compliance application and the Reports module. This is superseded by the SSO Restful Service.	SOAP	1.0	15.0
Product Service
createProduct	Creates a new Product Record.	SOAP	1.8	TBC
updateProduct	Updates existing Product Records.	SOAP	1.8	TBC
submitProduct	Allows the update and creation of Product Records. If the record already exists, it is updated; otherwise, a new record is created.	SOAP	1.8	TBC
Retrieve Product Specifications
getProductSpecificationV1	Retrieves a paged list of Product Specification records filtered according to the parameters defined in the request.	SOAP	1.8	TBC
Project Activities
Activity Management	Allows updates to Project Activities from an external service. Used in Artwork integration. This service has been superseded by the Artwork Rest Service.	SOAP	1.8	1.10
UserRestService
List of Values	Retrieves a list of retailer or supplier users in a paged list.	REST	1.9	NA
Retrieve Record by ID	Retrieves a single user's details. There are no request parameters, but the URL contains the id parameter that determines the record to retrieve.	REST	1.9	NA
Retrieve Record by Business Key	Retrieves a single user's details. There are no request parameters, but the URL contains the login id parameter that determines the record to retrieve.	REST	1.9	NA
Check Record Modification Timestamp	Retrieves the last modification time for a user. There are no request parameters, but the URL contains the record id parameter that determines the record to retrieve.	REST	1.9	NA
Create Record	Creates a new retailer or supplier user.	REST	1.9	NA
Update Record	Updates an existing retailer or supplier user.	REST	1.9	NA
SupplierRestService
List of Values	Retrieves a list of suppliers in a paged list.	REST	1.9	NA
Retrieve Record by ID	Retrieves a single supplier's details. There are no request parameters, but the URL contains the id parameter that determines the record to retrieve.	REST	1.9	NA
Retrieve Record by Business Key	Retrieves a single supplier's details. There are no request parameters, but the URL contains the key code parameter that determines the record to retrieve.	REST	1.9	NA
Check Record Modification Timestamp	Retrieves the last modification time for a supplier. There are no request parameters, but the URL contains the record id parameter that determines the record to retrieve.	REST	1.9	NA
Create Record	Creates a new supplier.	REST	1.9	NA
Update Record	Updates an existing supplier .	REST	1.9	NA
SiteRestService
List of Values	Retrieves a list of sites in a paged list.	REST	1.9	NA
Retrieve Record by ID	Retrieves a single site's details. There are no request parameters, but the URL contains the id parameter that determines the record to retrieve.	REST	1.9	NA
Retrieve Record by Business Key	Retrieves a single site's details. There are no request parameters, but the URL contains the supplier and site code parameters that determine the record to retrieve.	REST	1.9	NA
Check Record Modification Timestamp	Retrieves the last modification time for a site. There are no request parameters, but the URL contains the record id parameter that determines the record to retrieve.	REST	1.9	NA
Create Record	Creates a new site.	REST	1.9	NA
Update Record	Updates an existing site.	REST	1.9	NA
ContactRestService
List of Values	Retrieves a list of contacts in a paged list.	REST	15.0	NA
Retrieve Record by ID	Retrieves a single contact's details. There are no request parameters, but the URL contains the id parameter that determines the record to retrieve.	REST	15.0	NA
Retrieve Supplier Contact Record by Business Key	Retrieves a single supplier contact's details. There are no request parameters, but the URL contains the supplier code, name, and email address parameters that determine the record to retrieve.	REST	15.0	NA
Retrieve Site Contact Record by Business Key	Retrieves a single site contact's details. There are no request parameters, but the URL contains the supplier and site codes, name, and email address parameters that determine the record to retrieve.	REST	15.0	NA
Check Record Modification Timestamp	Retrieves the last modification time for a contact. There are no request parameters, but the URL contains the record id parameter that determines the record to retrieve.	REST	15.0	NA
Create Record	Creates a new contact.	REST	15.0	NA
Update Record	Updates an existing contact.	REST	15.0	NA
ProductRecordRestService
List of Values	Retrieves a list of Product Records in a paged list.	REST	1.9	NA
Retrieve Record by ID	Retrieves a single Product Record's details. There are no request parameters, but the URL contains the id parameter that determines the record to retrieve.	REST	1.9	NA
Retrieve Record by Business Key	Retrieves a single Product Record's details. There are no request parameters, but the URL contains the key code parameter that determines the record to retrieve.	REST	1.9	NA
Check Record Modification Timestamp	Retrieves the last modification time for a Product Record. There are no request parameters, but the URL contains the record id parameter that determines the record to retrieve.	REST	1.9	NA
Create Record	Creates a new Product Record.	REST	1.9	NA
Update Record	Updates an existing Product Record.	REST	1.9	NA
ProductSpecificationRestService
List of Values	Retrieves a list of Product Specifications in a paged list.	REST	1.9	NA
Retrieve Record by ID	Retrieves a single Product Specification's details. There are no request parameters, but the URL contains the id parameter that determines the record to retrieve.	REST	1.9	NA
Retrieve Record by Business Key	Retrieves a single Product Specification's details. There are no request parameters, but the URL contains the specification number and version parameters that determine the record to retrieve.	REST	1.9	NA
Retrieve List with Advanced Filtering	Retrieves a list of Product Specifications in a paged list using advanced filtering. Parameters are passed to filter the returned list by values such as specification status, specification type, country where sold, and so on.	REST	1.9	NA
Check Record Modification Timestamp	Retrieves the last modification time for a Product Specification. There are no request parameters, but the URL contains the record id parameter that determines the record to retrieve.	REST	1.9	NA
Create Record	Creates a new Product Specification.	REST	16.0	NA
Update Record	Updates an existing Product Specification.	REST	16.0	NA
BusinessCategoryService
List of Values	Retrieves a list of Business Categories in a paged list.	REST	16.0	NA
Retrieve Record	Retrieves a single Business Category (a path of all levels). There are no request parameters, but the URL contains the record id parameter that determines the record to retrieve.	REST	16.0	NA
Check Record Modification Timestamp	Retrieves the last modification time for a Business Category. There are no request parameters, but the URL contains the record id parameter that determines the record to retrieve.	REST	16.0	NA
Create Record	Creates a new Business Category.	REST	16.0	NA
Update Record	Updates an existing Business Category.	REST	16.0	NA
Delete Record	Deletes an existing Business Category.	REST	16.0	NA
AuditRestService
List of Values (Audit)	Retrieves a list of Audits or Visits in a paged list.	REST	16.0	NA
Retrieve Record by ID (Audit)	Retrieves a single Audit or Visit (and its Non Conformances/Issues). There are no request parameters, but the URL contains the record id parameter that determines the record to retrieve.	REST	16.0	NA
Retrieve Record by Business Key (Audit)	Retrieves a single Audit or Visit (and its Non Conformances/Issues). There are no request parameters, but the URL contains the key code parameter that determines the record to retrieve.	REST	16.0	NA
Check Record Modification Timestamp (Audit)	Retrieves the last modification time for an Audit or Visit. There are no request parameters, but the URL contains the record id parameter that determines the record to retrieve.	REST	16.0	NA
Create Record (Audit)	Creates a new Audit or Visit.	REST	16.0	NA
Update Record (Audit)	Updates an existing Audit or Visit.	REST	16.0	NA
List of Values (Checklist)	Retrieves a list of Checklists in a paged list.	REST	16.0	NA
Retrieve Record by ID (Checklist)	Retrieves a single Checklist. There are no request parameters, but the URL contains the record id parameter that determines the record to retrieve.	REST	16.0	NA
Retrieve Record by Business Key (Checklist)	Retrieves a single Checklist. There are no request parameters, but the URL contains the key code parameter that determines the record to retrieve.	REST	16.0	NA
Create Record (Checklist)	Creates a new Checklist.	REST	16.0	NA
Update Record (Checklist)	Updates an existing Checklist.	REST	16.0	NA
Delete Record (Checklist)	Deletes an existing Checklist.	REST	16.0	NA
TaskRestService
List of Values	Retrieves a list of current tasks for the user in the given language.	REST	1.9	NA
UrgentItemsRestService
Number of Urgent Items	Retrieves the number of urgent items pending for a given user.	REST	1.9	NA
ArtworkRestService
Started Activities	Retrieves a list of Project Activities that are flagged as Artwork activities, and their status has changed to Started within the specified date range.	REST	1.10	NA
Update Record	Updates the sub-status of existing Artwork Project Activities.	REST	1.10	NA
SSO	Single sign-on integration between Brand Compliance and the external Artwork system.	REST	1.10	Removed in 18.2
DataPrivacyService
Right to Access	Retrieves personal data from the system relating to the name of an individual.	REST	15.0	NA
Right to be Forgotten	Erases personal data from the system for an individual (subject to conditions).	REST	15.0	NA
AttachmentRestService
Retrieve Report Attachment	Retrieves attachment files that have been generated by the system as report outputs.	REST	18.0	NA
Retrieve Attachment	Retrieves files that have been attached to records.	REST	18.1	NA
ScorecardRestService
List of Values	Retrieves a list of Scorecards in a paged list.	REST	18.1	NA
Retrieve Record by ID	Retrieves a single Scorecard. There are no request parameters, but the URL contains the record id parameter that determines the record to retrieve.	REST	18.1	NA
Retrieve Record by Business Key	Retrieves a single Scorecard. There are no request parameters, but the URL contains the key code parameter that determines the record to retrieve.	REST	18.1	NA
Check Record Modification Timestamp	Retrieves the last modification time for a Scorecard. There are no request parameters, but the URL contains the record id parameter that determines the record to retrieve.	REST	18.1	NA
ProjectRestService
List of Values	Retrieves a list of Projects in a paged list.	REST	18.1	NA
Retrieve Record by ID	Retrieves a single Project. There are no request parameters, but the URL contains the record id parameter that determines the record to retrieve.	REST	18.1	NA
Retrieve Record by Business Key	Retrieves a single Project. There are no request parameters, but the URL contains the key code parameter that determines the record to retrieve.	REST	18.1	NA
Check Record Modification Timestamp	Retrieves the last modification time for a Project. There are no request parameters, but the URL contains the record id parameter that determines the record to retrieve.	REST	18.1	NA
ActivityRestService
List of Values	Retrieves a list of Project Activities in a paged list.	REST	18.1	NA
Retrieve Record by ID	Retrieves a single Project Activity. There are no request parameters, but the URL contains the record id parameter that determines the record to retrieve.	REST	18.1	NA
Retrieve Record by Business Key	Retrieves a single Project Activity. There are no request parameters, but the URL contains the key code parameter that determines the record to retrieve.	REST	18.1	NA
Check Record Modification Timestamp	Retrieves the last modification time for a Project Activity. There are no request parameters, but the URL contains the record id parameter that determines the record to retrieve.	REST	18.1	NA

History of Enhancements

Release Version	Enhancements
16.0	Business Categories REST API Audits & Visits REST API Specs REST API update & create Supplier REST API - Linked Suppliers? Updated to REST Spec Inbound API Additional Supplier Info added to Produce Product Record Sustainability added to Spec
17.0	Business Categories REST API Audits & Visits REST API Specs REST API update & create Supplier REST API - Linked Suppliers? Updated to REST Spec Inbound API Additional Supplier Info added to Produce Product RecordSustainability added to Spec
18.0	Additional filters on Specs REST API Attachments REST API for Reports Changes to Specs REST API for use as report data source Alternative Product Number & Division added to Spec Date Approved added to Spec Main Details section Fields added to Main Details Spec section XML Additional Supplier Info updated in Produce Product Record
18.1	Scorecards REST API Projects & Activities REST API Attachments REST API (Scorecards, Projects & Activities) Additional filters for Spec, Supplier & Site REST APIs Audit/Visit code added to Audits REST API Wildcard searching & error logging added to REST APIs Extended Nutrient Target fields added to Spec Combined Specs fields added to Spec
18.2	Artwork SSO API removed ORBC-IDCS APIs Password fields removed from Users API for IDCS or OCI IAM Advanced Packaging section added to Spec
18.3	Nutri-Score data added to Spec Dual Nutrition Panel data added to Spec

Services Grouped by Area

The following sections summarize the service features available by area of Brand Compliance functionality.

User and Supplier APIs

The following service features are applicable to the functionality available for user and supplier APIs:

Allows Supplier, Site, Contact, and User records to be created, updated, and extracted.

Does not allow deletion of records.

Does not import or export file attachments.

Does not include Scorecards, Audits & Visits, or Alerts.

A system log of service transactions is kept (not reportable).

Product APIs

The following service features are applicable to the functionality available for product APIs:

Allows Product Records to be created, updated, and extracted.

Barcodes transmitted by the data feed are stored on the Product Record and automatically transferred to the Product Specification when linked (using normal specification editor procedures).

A Product Record must be activated before it can be linked to a Product Specification.

Does not import file attachments.

Not intended for bulk upload of Product Records.

Does not include Pack Copy files or Surveillance test results.

If the full content of the Product Record is not included in the data feed, subsequent manual data entry may be required.

Does not apply to Produce Product Record types as they are created through a different process in Brand Compliance.

The SOAP version only applies to the single variant mode of operating the Product module, that is, does not handle multiple variants on the same Product Record.

A system log of service transactions is kept (not reportable).

Specification Outbound API

The following service features are applicable to the functionality available for the specification outbound API:

Transmit Product Specification data in XML form for Product Specifications that meet the filters used in the service call from the external system.

All specification types, including Produce and Counter Tickets, are supported.

Does not export file attachments.

Does not export Deleted Product Specifications.

A system log of service transactions is kept (not reportable).

Specification Inbound API

The following service features are applicable to the functionality available for the specification inbound API:

Allows Product Specification records to be created, updated, and extracted.

All specification types, including Produce and Counter Tickets, are supported.

Does not allow deletion of records.

Does not import or export file attachments.

Specifications can be created at any status; validation is applied when the user manually edits and progresses the specification through the Brand Compliance application UI.

A system log of service transactions is kept (not reportable).

Audits API

The following service features are applicable to the functionality available for the audits API:

Allows Audit and Visit records to be created, updated, and extracted.

Includes the associated Issues/Non Conformances and Checklists.

Does not allow deletion of records.

Does not import or export file attachments.

A system log of service transactions is kept (not reportable).

Artwork Project Activities

The following service features are applicable to the functionality available for the Artwork Project Activities API:

Enables external Artwork systems to update the sub-status of specific Project Activities that relate to Artwork. The external system is not enabled to complete the activity in Brand Compliance; this must be done manually.

Activity templates in the Project module of Brand Compliance have an option to integrate that activity with an Artwork system.

Project Activities in Brand Compliance, which have been set to integrate with Artwork and which have a status of Started, are available to the external system.

Pack Copy data is not sent using an API, it is automatically sent in email to the designer.

The start and end dates of the Activity are not sent to the Artwork system. The Artwork process is usually well defined and it is usual for a project to be set up in the Artwork system at this point, using the Artwork system's own templates and based on the date that the message is received.

The Artwork API is secured and initiated per other Brand Compliance APIs. The following table summarizes the features introduced by each Brand Compliance release:

Artwork Integration Features by Release

Release	Feature
1.0	Activity Management SOAP API available to send a message when an activity status is set to Started. Message can be returned to set the Activity's sub-status accordingly in Brand Compliance.
1.5/1.6	Single Sign-on (SSO) Phase I: The Artwork system's URI is stored in the Brand Compliance Admin Area. An Artwork option is added to the Brand Compliance Navigator bar. It is enabled if the user has the Artwork User authority profile. Users must be created manually in both systems. SSO is achieved using a SOAP call.
1.8	Single Sign-on (SSO) Phase II: Users are managed automatically between Brand Compliance and the Artwork system through a REST API to pass user and role information; so no need to create manually in both systems. It is not necessary to log into both applications. The user must first log in to Brand Compliance, and when the user clicks the Artwork link, a custom SSO takes places. This involves the exchange of a secure token, and a callback to Brand Compliance from the external system to retrieve the user's information.
1.10	The Activity Management SOAP API is deprecated. It is superseded by the equivalent Artwork Rest Service.
15.0	Security Improvements: Messages are no longer automatically sent out from Brand Compliance, but now rely on a call from the Artwork external system to check if an activity has started. Also relies on a call to Brand Compliance to check for new users.
18.2	Single sign-on SSO API is removed. Single sign-on between Brand Compliance and the Artwork module is achieved using IDCS. A separate IDCS tenant must be created for the Artwork system. See the Oracle Retail Brand Compliance Management Cloud Service Administration Guide for details of the use of IDCS in Brand Compliance. The Artwork solution must be upgraded to a version that can communicate with the IDCS tenant to continue to utilize Single Sign-on.

Data Privacy API

The following service features are applicable to the functionality available for the Data Privacy API:

Right to Access requests, to retrieve personal data relating to the name of an individual.

Right to be Forgotten requests, to erase personal data for an individual (subject to conditions).

Certain due diligence approval data is not permitted to be erased.

Data is erased by being overwritten with randomly-generated text.

The erasure of data is not recorded in Change History logs.

Dependencies

Following is the typical sequence of records to be created in order to create all of the above services:

Figure 3-1 Dependencies

The following table indicates the dependencies of each type of record that can be created using the APIs, that is, what configuration or other records must be in place for the creation to succeed:

Record Creation Dependencies

Record Type	Configuration	Other Record Types	Comments
User	Company (mandatory) Languages (mandatory) User Roles (mandatory) Authority Profiles Time Zones Users (Managers and Delegates) Areas	Supplier (if a supplier user)	When creating a user, it is associated to either the retailer or a supplier. If it is a supplier user, the ID of the Supplier record must be provided. The notification email sent to a new user is not generated when creating a user through the API.
Supplier	Billing Codes (mandatory) Business Units (mandatory) Supplier Types (mandatory) Countries Supplier Top Grades Currencies Invoicing Systems Supplier Statuses Areas	NA	When creating a Supplier, omit the Site and Supplier Contact elements, and omit the Billing Details ID. Create Sites, Contacts, AND Users after creating the Supplier. The initial user account is not automatically created when creating a supplier through the API.
Site	Product Technologists (mandatory) Business Categories (mandatory) Site Types (mandatory) Business Units Currencies Invoicing Systems Countries Audit Reasons Reference Types Reference Statuses Site Top Grades Site Statuses Risk LevelsOther Production Details	Supplier User (Product Technologist)	When creating a Site, the ID of the Supplier record must be provided. Omit the Scorecards and Audit elements, and omit the Billing Details ID and Reference ID. If assigning a Business Category, the ID of the Business Category record must be provided; if assigning a Product Technologist, the IDs of the User record must be provided. Create Contacts after creating the Site.
Contact	Contact Roles (mandatory)	User Supplier Site (if a Site contact)	When creating a Contact, the IDs of the associated User and Person records must be provided. The Person record holds an individual's personal contact details; the Contact record holds the individual's contact details in relation to that role (which may be different per role); the User record represents the individual's user account. A contact is associated to a supplier and/or a site; the IDs of the Supplier and Site records must be provided as appropriate. Omit the Site element if not a site-level contact.
Product	RecordSpecification Types (mandatory) Product Record Statuses (mandatory) Product Technologist (mandatory) Other Contacts (mandatory) Test Disciplines Specification Formats Business Categories	Supplier (if Active) Site (if linked to a site) User	A Product Record may be linked to a supplier/site; the IDs of the Supplier and Site records must be provided as appropriate. Omit the Discipline Detail, Product Covered, Barcode and Shipping Case Code IDs when creating. If assigning a Business Category, the ID of the Business Category record must be provided; if assigning a Product Technologist or Other Contact, the IDs of the User record must be provided. Product Technologist and Other Contacts are mandatory, however will be defaulted to TBC on creation if not provided, however, the dummy TBC User record must already exist. The status must be Active in order to be linked to a specification; for the status to be Active the Product Record must be linked to a supplier.
Product Specification	Specification Glossaries (some are mandatory)	Supplier (if linked to PR) Site (if linked to PR) Product Record (if linked to PR Contact (if linked to PR) User (if linked to PR) Business Category (if linked to PR)	A Specification may be linked to a Product Record by providing the ID of a Product Record which it is at Active status. If linking to a Product Record, the Supplier, Site, and Product Record (and associated Users, Contacts and Business Categories) must be created first. Some links to Specification Glossaries are mandatory.
Business Category	Business Categories (parent levels) Specification Types	NA	When creating a Business Category, if the category is a lower-level category, the ID of its parent Business Category record must be provided.
Audit/Visit	Audit/Visit Template (mandatory) Audit/Visit Status (mandatory) Product Technologist (mandatory) People Present (mandatory) Supplier Contacts Business Categories Non Conformance: Assigned to Completed by Approved by	Supplier Site User	An Audit or Visit is linked to a supplier/site; the IDs of the Supplier and Site records must be provided. If assigning a Business Category, the ID of the Business Category record must be provided; if assigning a Product Technologist or People Present, the IDs of the User record must be provided. Non Conformances may include links to User records for the users who the issue is assigned to, was completed by, or is approved by. If the person is not a user of the application, a corresponding text field can be used to record the name. Also, see notes below.
Checklists	Audit/Visit (mandatory) Checklist Question (mandatory)	Audit/Visit Checklist Template	A Checklist is linked to an Audit/Visit, the IDs of the Audit or Visit record must be provided. The Checklist's questionnaire questions and available answers are derived from the Checklist Templates assigned to the Audit/Visit, the IDs of the Template records must be provided.

Record Type

Configuration

Other Record Types

Comments

User

Company (mandatory)

Languages (mandatory)

User Roles (mandatory)

Authority Profiles

Time Zones

Users (Managers and Delegates)

Areas

Supplier

(if a supplier user)

When creating a user, it is associated to either the retailer or a supplier. If it is a supplier user, the ID of the Supplier record must be provided.

The notification email sent to a new user is not generated when creating a user through the API.

Supplier

Billing Codes (mandatory)

Business Units (mandatory)

Supplier Types (mandatory)

Countries

Supplier Top Grades

Currencies

Invoicing Systems

Supplier Statuses

Areas

When creating a Supplier, omit the Site and Supplier Contact elements, and omit the Billing Details ID.

Create Sites, Contacts, AND Users after creating the Supplier.

The initial user account is not automatically created when creating a supplier through the API.

Site

Product Technologists (mandatory)

Business Categories (mandatory)

Site Types (mandatory)

Business Units

Currencies

Invoicing Systems

Countries

Audit Reasons

Reference Types

Reference Statuses

Site Top Grades

Site Statuses

Risk LevelsOther Production Details

Supplier User (Product Technologist)

When creating a Site, the ID of the Supplier record must be provided. Omit the Scorecards and Audit elements, and omit the Billing Details ID and Reference ID.

If assigning a Business Category, the ID of the Business Category record must be provided; if assigning a Product Technologist, the IDs of the User record must be provided.

Create Contacts after creating the Site.

Contact

Contact Roles (mandatory)

User

Supplier

Site (if a Site contact)

When creating a Contact, the IDs of the associated User and Person records must be provided. The Person record holds an individual's personal contact details; the Contact record holds the individual's contact details in relation to that role (which may be different per role); the User record represents the individual's user account.

A contact is associated to a supplier and/or a site; the IDs of the Supplier and Site records must be provided as appropriate. Omit the Site element if not a site-level contact.

Product

RecordSpecification Types (mandatory)

Product Record Statuses (mandatory)

Product Technologist (mandatory)

Other Contacts (mandatory)

Test Disciplines

Specification Formats

Business Categories

Supplier (if Active)

Site (if linked to a site)

User

A Product Record may be linked to a supplier/site; the IDs of the Supplier and Site records must be provided as appropriate. Omit the Discipline Detail, Product Covered, Barcode and Shipping Case Code IDs when creating.

If assigning a Business Category, the ID of the Business Category record must be provided; if assigning a Product Technologist or Other Contact, the IDs of the User record must be provided.

Product Technologist and Other Contacts are mandatory, however will be defaulted to TBC on creation if not provided, however, the dummy TBC User record must already exist.

The status must be Active in order to be linked to a specification; for the status to be Active the Product Record must be linked to a supplier.

Product Specification

Specification Glossaries (some are mandatory)

Supplier (if linked to PR)

Site (if linked to PR)

Product Record (if linked to PR

Contact (if linked to PR)

User (if linked to PR)

Business Category (if linked to PR)

A Specification may be linked to a Product Record by providing the ID of a Product Record which it is at Active status.

If linking to a Product Record, the Supplier, Site, and Product Record (and associated Users, Contacts and Business Categories) must be created first.

Some links to Specification Glossaries are mandatory.

Business Category

Business Categories (parent levels)

Specification Types

When creating a Business Category, if the category is a lower-level category, the ID of its parent Business Category record must be provided.

Audit/Visit

Audit/Visit Template (mandatory)

Audit/Visit Status (mandatory)

Product Technologist (mandatory)

People Present (mandatory)

Supplier Contacts

Business Categories

Non Conformance:

Assigned to

Completed by

Approved by

Supplier

Site

User

An Audit or Visit is linked to a supplier/site; the IDs of the Supplier and Site records must be provided.

If assigning a Business Category, the ID of the Business Category record must be provided; if assigning a Product Technologist or People Present, the IDs of the User record must be provided.

Non Conformances may include links to User records for the users who the issue is assigned to, was completed by, or is approved by. If the person is not a user of the application, a corresponding text field can be used to record the name.

Also, see notes below.

Checklists

Audit/Visit (mandatory)

Checklist Question (mandatory)

Audit/Visit

Checklist Template

A Checklist is linked to an Audit/Visit, the IDs of the Audit or Visit record must be provided.

The Checklist's questionnaire questions and available answers are derived from the Checklist Templates assigned to the Audit/Visit, the IDs of the Template records must be provided.

Notes on the Creation and Maintenance of Audits/Visits and Checklists

The following diagram shows the main links between Audits/Visits, their Checklists, and other entities:

Figure 3-2 Links Between Audits/Visits and Other Entities
For the creation of an Audit/Visit and its Checklists, in addition to providing the links to the associated Audit/Visit Template and Checklist Template records, certain values from the templates must also be included in the payload of the Audit/Visit Create and Update functions.
It is recommended that the creation of Audits/Visits and Checklist be managed within the Brand Compliance application. Once created, records can be taken into the external system where the audit is performed, prior to importing back into Brand Compliance.

This approach ensures the necessary template fields will have been obtained with the initial Retrieve Record function.

The following diagram shows the stages of a typical scenario:

Figure 3-3 Stages of a Typical Scenario
If it is necessary to create audits or visits from scratch in the external system, the recommended approach would be to create a set of gold standard audits/visits in Brand Compliance, which are assigned to a dummy supplier and site.

To create a new audit or visit, the process would be to retrieve the appropriate gold standard audit/visit through the GET function, amend the retuned XML data to reflect the audit/visit to be created, and then submit the creation of the new audit/visit (plus any non conformances and checklists) using the POST function.
If a checklist audit is to be created using the Create Audit service, the Audit/Visit record must first be created using the Create Audit function, followed by the creation of each of its Checklist records.

Creating an audit through the API which is linked to a checklist template does not automatically create the checklists. They must be individually created using the Create Checklist function.
An audit/visit's non conformances are included as separate elements within the audit/visit data. An audit/visit's non conformances are allocated when creating or updating the audit/visit.

Note:

The API does not automatically create non conformances based on the answers of checklist questions.

Linking to Related Records

Links to associated records are included in the XML as an id element, which holds the record ID of the related record. In some cases, a code element also holds the related record's business key.

For example, the XML returned from the SiteRestService API will contain a supplier element, which itself contains an id element and a code element. The value in the id element can be used by the SupplierRestService Retrieve Record by ID function to retrieve the full details of the Supplier record. Alternatively, the value in the code element can be used by the SupplierRestService Retrieve Record by Business Key function to retrieve the Supplier record.

The id element is also used in the XML to hold the record ID of a value that is held in a glossary such as a recipe ingredient or a country.

The following table shows where an API provides links to other records, and the id or code elements used to locate those records. The list of notes below the table indicates the service to use to retrieve the related record.

API	Links to Records
Supplier	Contact: contactDetail/id (Contact record ID link). See note 7. Contact (User): person/id (User record ID link). See note 1. Site: site/id (Site record ID link). See note 3. Site: site/code site (Site business key link). See note 4.
Site	Supplier: supplier/id (Supplier record ID link). See note 5. Supplier: supplier/code (Supplier business key link). See note 6. Business Categories: businessCategories/id (Business Category record ID link). See note 10. Lead Business Category: leadBusinessCategory/id (Business Category record ID link). See note 10. Lead Product Technologist (User): leadTechnicalManager/id (User record ID link). See note 1. Lead Product Technologist (User):leadTechnicalManager/code (User business key link). See note 2. Other Technologists (User): otherTMs/id (User record ID link). See note 1. Other Technologists (User): otherTMs/code (User business key link). See note 2. Contact: siteContact/id (Contact record ID link). See note 7.
Contact	Contact (User): person/id (User record ID link). See note 1. Supplier: company/id (Supplier record ID link). See note 5. Supplier: Company/code (Supplier business key link). See note 6. Site: site/id (Site record ID link). See note 3. Site: Site/code (Site business key link). See note 4.
User	Supplier: supplier/id (Supplier record ID link). See note 5. Supplier: Supplier/code (Supplier business key link). See note 6.
Audit/Visit	Supplier: supplier/id (Supplier record ID link). See note 5. Supplier: supplier/code (Supplier business key link). See note 6. Site: site/id (Site record ID link). See note 3. Site: Site/code (Site business key link). See note 4. People Present (User): user/id (User record ID link). See note 1. People Present (User): user/code (User business key link). See note 2. Lead Product Technologist (User): leadTechnicalManager/id (User record ID link). See note 1. Lead Product Technologist (User): leadTechnicalManager/code (User business key link). See note 2. Business Categories: businessCategories/id (Business Category record ID link). See note 9. Lead Business Category: leadBusinessCategory/id (Business Category record ID link). See note 9. Non Conformance Assigned To (User): assignedTo/id (User record ID link). See note 1. Non Conformance Completed By (User): completedBy/id (User record ID link). See note 1. Non Conformance Approved By (User): approvedBy/id (User record ID link). See note 1.
Checklist	Audit/Visit: audit/id (Audit/Visit record ID link). See note 11.
Product Record	Supplier: supplier/id (Supplier record ID link). See note 5. Supplier: supplier/code (Supplier business key link). See note 6. Site: site/id (Site record ID link). See note 3. Site: site/code (Site business key link). See note 4. Business Categories: businessCategory/id (Business Category record ID link). See note 10. Technologist (User): technologist/id (User record ID link). See note 1. Technologist (User): technologist/code (User business key link). See note 2. Other Contacts (User): user/id record ID link). See note 1. Other Contacts (User): user/code (business key link). See note 2.
Produce Product Record	As per Product Record, except Business Categories, which are derived from the Product Specification.
Product Specification	Supplier: site/supplierId (Supplier record ID link). See note 5. Supplier: site/supplierCode (Supplier business key link). See note 6. Site: primarySites/site/id (Site record ID link). See note 3. Site: primarySites/site/code (Site business key link). See note 4. Product Record: productRecord/id (Product Record record ID link). See note 8. Product Record: productRecord/code (Product Record business key link). See note 9. Supplier Contact: contactDetails/id (Contact record ID link). See note 7. Supplier Contact (User): person/id (User record ID link). See note 1. For further details on locating a Specification's Product Record, see the Main Details page of the Oracle Retail Brand Compliance Management Cloud Service Data Dictionary, Volume 4 - Product (Food Specification).