Contents

Title and Copyright Information

Send Us Your Comments

Preface

• Audience
• Documentation Accessibility
• Related Documents
• Improved Process for Oracle Retail Documentation Corrections
• Oracle Retail Documentation on the Oracle Help Center (docs.oracle.com)
• Conventions

1 Introduction

• Contents of this Guide
• Key Features of Brand Compliance Management Cloud Service

2 API Overview and Architecture

• SOAP and RESTful APIs
• Request and Response XML
• Versioning
• Logging
• Accessing the APIs
  • Availability
  • Deployment Model
  • Authentication
  • Authorization
  • Listing Available APIs
  • REST API Path
• Security Considerations
  • Password Management
  • Rich Text Data
  • Excluded Fields
  • Secured Connections
  • Change History
  • URL Encoding
• Reference Fields
  • Glossary and Locale/Language Fields
  • Enumeration Fields
  • Editable Text Selector Fields
• Key Features of the API Process

3 APIs Available in Brand Compliance

• Individual Services
• Services Grouped by Area
  • User and Supplier APIs
  • Product APIs
  • Specification Outbound API
  • Specification Inbound API
  • Audits API
  • Artwork Project Activities
  • Data Privacy API
• Dependencies
  • Linking to Related Records

4 RESTful APIs

• Parameters and Filtering
• Error Messages
• Wildcard Searches
• UserRestService
  • List of Values
  • Retrieve Record by ID
  • Retrieve Record by Business Key
  • Check Record Modification Timestamp
  • Create Record
  • Update Record
• SupplierRestService
  • List of Values
  • Retrieve Record by ID
  • Retrieve Record by Business Key
  • Check Record Modification Timestamp
  • Create Record
  • Update Record
• SiteRestService
  • List of Values
  • Retrieve Record by ID
  • Retrieve Record by Business Key
  • Check Record Modification Timestamp
  • Create Record
  • Update Record
• ContactRestService
  • List of Values
  • Retrieve Record by ID
  • Retrieve Supplier Contact Record by Business Key
  • Retrieve Site Contact Record by Business Key
  • Check Record Modification Timestamp
  • Create Record
  • Update Record
• ProductRecordRestService
  • List of Values
  • Retrieve Record by ID
  • Retrieve Record by Business Key
  • Check Record Modification Timestamp
  • Create Record
  • Update Record
• ProductSpecificationRestService
  • List of Values
  • Retrieve Record by ID
  • Retrieve Record by Business Key
  • Retrieve List with Advanced Filtering
  • Check Record Modification Timestamp
  • Create Record
  • Update Record
• TaskRestService
  • List of Tasks
• UrgentItemsRestService
  • Number of Urgent Items
• ArtworkRestService
  • Started Activities
  • Update Record
• BusinessCategoryService
  • List of Values
  • Retrieve Record by ID
  • Check Record Modification Timestamp
  • Create Record
  • Update Record
  • Delete Record
• AuditRestService
  • List of Values (Audit)
  • Retrieve Record by ID (Audit)
  • Retrieve Record by Business Key (Audit)
  • Check Record Modification Timestamp (Audit)
  • Create Record (Audit)
  • Update Record (Audit)
  • List of Values (Checklist)
  • Retrieve Record by ID (Checklist)
  • Retrieve Record by Business Key (Checklist)
  • Create Record (Checklist)
  • Update Record (Checklist)
  • Delete Record (Checklist)
• DataPrivacyService
  • Right to Access
  • Right to be Forgotten
• AttachmentRestService
  • Retrieve Report Attachment
  • Retrieve Attachment
• ScorecardRestService
  • List of Values
  • Retrieve Record by ID
  • Retrieve Record by Business Key
  • Check Record Modification Timestamp
• ProjectRestService
  • List of Values
  • Retrieve Record by ID
  • Retrieve Record by Business Key
  • Check Record Modification Timestamp
• ActivityRestService
  • List of Values
  • Retrieve Record by ID
  • Retrieve Record by Business Key
  • Check Record Modification Timestamp

5 SOAP APIs

• Parameters and Filtering
• User Details
  • userDetails
• Product Service
  • createProduct
  • updateProduct
  • submitProduct
• Retrieve Product Specifications
  • getProductSpecificationV1
• Project Activities
  • Activity Management

A Appendix: Secure Development Guide

• Best Practices for Web Service Use
  • Store External System Credentials Securely
  • Configure External Systems Permissions Appropriately
  • Maintain Strong Passwords for External System Records
  • Make Use of the Web Service Log
  • Ensure Your Client Supports TLS v1.2 or Higher
  • Limit the Size of Web Service Payloads

B Appendix: Using the Data Privacy API

• Definition of Personal Data
• Personal Data Flow
• Right to Access Requests
  • Personal Data Searched and Returned
  • Security and Logging
  • Example of Using the Right to Access Service
• Right to be Forgotten Requests
  • Personal Data Updated
    • Exceptions
  • Purging Inactive User Accounts
  • Security and Logging
  • Example of Using the Right to be Forgotten Service
• Other Aspects of Data Privacy

C Appendix: Using the Report Attachment API

Glossary