Skip to main content
← Product Manager

Product Manager API

Product Manager API Documentation (1.1.1)

Download OpenAPI specification:Download

This is the API of Product Manager

Changes

Changes APIs

Create Immediate Change

This endpoint allows you to apply an immediate change to the system, enabling the creation, modification, or deletion of items directly without generating a scheduled changeset.

Each change is defined by a specific type, such as FEE_CREATE, which represents the creation of a Fee item. The required data structure and fields for the request will vary based on the type of change being applied.

Authorizations:
TokenBasedAuth
path Parameters
spaceId
required
string <uuid>

ID of the PRD Admin space

Request Body schema: application/json
required

Request body for Create Change

version
string
Default: "V1"

Payload Version

userId
required
string

The ID of the user that created the change

required
any (ChangeTypeV1)

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Get Changes

Retrieve the list of changes of a specific changeset within a Space.

Authorizations:
TokenBasedAuth
path Parameters
spaceId
required
string <uuid>

ID of the PRD Admin space

changesetId
required
string <uuid>

ID of the changeset

query Parameters
type
string (EnumChangeTypeV1)
Enum: "BULK_CDR_DATA_IMPORT" "BULK_DEPOSIT_RATE_CHANGE" "BULK_LENDING_RATE_CHANGE" "BUNDLE_CHANGE" "BUNDLE_CREATE" "BUNDLE_DELETE" "CARD_ART_CHANGE" "CARD_ART_CHANGE_V2" "CARD_ART_CREATE" "CARD_ART_CREATE_V2" "CARD_ART_DELETE" "CHANGE_DELETE" "CONSTRAINT_CHANGE" "CONSTRAINT_CHANGE_V3" "CONSTRAINT_CREATE" "CONSTRAINT_CREATE_V3" "CONSTRAINT_DELETE" "ELIGIBILITY_CHANGE" "ELIGIBILITY_CHANGE_V2" "ELIGIBILITY_CREATE" "ELIGIBILITY_CREATE_V2" "ELIGIBILITY_DELETE" "FEATURE_CHANGE" "FEATURE_CHANGE_V4" "FEATURE_CREATE" "FEATURE_CREATE_V4" "FEATURE_DELETE" "FEE_CHANGE" "FEE_CHANGE_V2" "FEE_CREATE" "FEE_CREATE_V2" "FEE_DELETE" "INDIVIDUAL_DEPOSIT_RATE_CHANGE" "INDIVIDUAL_DEPOSIT_RATE_CHANGE_V3" "INDIVIDUAL_DEPOSIT_RATE_CREATE" "INDIVIDUAL_DEPOSIT_RATE_CREATE_V3" "INDIVIDUAL_DEPOSIT_RATE_DELETE" "INDIVIDUAL_LENDING_RATE_CHANGE" "INDIVIDUAL_LENDING_RATE_CHANGE_V3" "INDIVIDUAL_LENDING_RATE_CREATE" "INDIVIDUAL_LENDING_RATE_CREATE_V3" "INDIVIDUAL_LENDING_RATE_DELETE" "INDIVIDUAL_PRODUCT_CHANGE" "INDIVIDUAL_PRODUCT_CHANGE_V2" "INDIVIDUAL_PRODUCT_CREATE" "INDIVIDUAL_PRODUCT_CREATE_V2" "INDIVIDUAL_PRODUCT_DELETE" "INSTALMENT_CREATE" "INSTALMENT_CHANGE" "INSTALMENT_DELETE" "TABLE_CHANGE" "TABLE_CREATE" "TABLE_DELETE"
Example: type=BULK_LENDING_RATE_CHANGE

Used to filter results based on the type of the change

page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

Responses

Response samples

Content type
application/json
{}

Create Change

This endpoint allows you to add a change to an existing changeset, identified by the changesetId specified in the path. Changesets are designed for future application and can be scheduled by setting their status to SCHEDULED and defining a scheduled time using the Changesets endpoint.

Each change is defined by a specific type, such as FEE_CREATE, which represents the creation of a Fee item. The required data structure and fields for the request will vary based on the type of change being applied.

Authorizations:
TokenBasedAuth
path Parameters
spaceId
required
string <uuid>

ID of the PRD Admin space

changesetId
required
string <uuid>

ID of the changeset

Request Body schema: application/json
required

Request body for Create Change

version
string
Default: "V1"

Payload Version

userId
required
string

The ID of the user that created the change

required
any (ChangeTypeV1)

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Get Change

Retrieve details of a change of a specific changeset in a Space.

Authorizations:
TokenBasedAuth
path Parameters
spaceId
required
string <uuid>

ID of the PRD Admin space

changesetId
required
string <uuid>

ID of the changeset

changeId
required
string <uuid>

ID of the change

Responses

Response samples

Content type
application/json
{}

Changesets

Changesets APIs

Get Changesets

Retrieve a detailed list of changesets that exist within the specified Space. Each changeset includes metadata, description, and status information.

Authorizations:
TokenBasedAuth
path Parameters
spaceId
required
string <uuid>

ID of the PRD Admin space

query Parameters
status
string (EnumChangesetStatusV1)
Enum: "DRAFT" "SCHEDULED" "EXECUTED" "DELETED" "FAILED"
Example: status=DRAFT

Used to filter results based on the status of the changeset

page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

Responses

Response samples

Content type
application/json
{}

Create Changeset

Creates a new changeset in the specified Space. A changeset allows grouping related changes to manage them collectively, including scheduling updates or applying modifications.

By default, a newly created changeset will have a DRAFT status.

Authorizations:
TokenBasedAuth
path Parameters
spaceId
required
string <uuid>

ID of the PRD Admin space

Request Body schema: application/json
required

Request body for Create Changeset

userId
required
string

The ID of the user creating the changeset

description
required
string

A description of the changeset

scheduled
string <date-time>

The date and time that the changeset is scheduled for

Array of objects (ChangeV1)

The list of changes in the changeset

Responses

Request samples

Content type
application/json
{
  • "userId": "ab252852-9648-4b69-9f01-4d60c1b82c41",
  • "description": "An example changeset description",
  • "scheduled": "2022-08-22T14:10:37+00:00",
  • "changes": [
    ],
  • "version": "V1"
}

Response samples

Content type
application/json
{}

Get Changeset

Retrieve details of a specific changeset.

Authorizations:
TokenBasedAuth
path Parameters
spaceId
required
string <uuid>

ID of the PRD Admin space

changesetId
required
string <uuid>

ID of the changeset

Responses

Response samples

Content type
application/json
{}

Update Changeset Draft

This endpoint allows you to update a changeset in draft status, allowing changes to the description or scheduled time.

Authorizations:
TokenBasedAuth
path Parameters
spaceId
required
string <uuid>

ID of the PRD Admin space

changesetId
required
string <uuid>

ID of the changeset

Request Body schema: application/json
required

Request body for Update Changeset

userId
required
string

The ID of the user updating the changeset

description
required
string

A description of the changeset

scheduled
string <date-time>

The date and time that the changeset is scheduled for

Responses

Request samples

Content type
application/json
{
  • "userId": "ab252852-9648-4b69-9f01-4d60c1b82c41",
  • "description": "An example changeset description",
  • "scheduled": "2022-08-22T14:10:37+00:00"
}

Response samples

Content type
application/json
{}

Approve Changeset

Approves the changeset for execution at the scheduled date and time.

Authorizations:
TokenBasedAuth
path Parameters
spaceId
required
string <uuid>

ID of the PRD Admin space

changesetId
required
string <uuid>

ID of the changeset

Request Body schema: application/json
required

Request body for Update Changeset

userId
required
string

The ID of the user approving the changeset

Responses

Request samples

Content type
application/json
{
  • "userId": "ab252852-9648-4b69-9f01-4d60c1b82c41"
}

Response samples

Content type
application/json
{}

Unapprove Changeset

Unapproves the changeset back to draft status, allowing further changes to be added.

Authorizations:
TokenBasedAuth
path Parameters
spaceId
required
string <uuid>

ID of the PRD Admin space

changesetId
required
string <uuid>

ID of the changeset

Responses

Response samples

Content type
application/json
{}

Delete Changeset

Changes a changeset to a deleted status so that it is removed from the draft and scheduled changes.

Authorizations:
TokenBasedAuth
path Parameters
spaceId
required
string <uuid>

ID of the PRD Admin space

changesetId
required
string <uuid>

ID of the changeset

Request Body schema: application/json
required

Request body for Delete Changeset

userId
required
string

The ID of the user updating the changeset

Responses

Request samples

Content type
application/json
{
  • "userId": "ab252852-9648-4b69-9f01-4d60c1b82c41"
}

Response samples

Content type
application/json
{}

Products

Products APIs

Get Products

Retrieve a detailed list of products that exist in the Space.

Authorizations:
TokenBasedAuth
path Parameters
spaceId
required
string <uuid>

ID of the PRD Admin space

query Parameters
tableId
string <uuid>
Example: tableId=9bf2cae7-ca32-4124-905b-68404de9628f

Used to filter results based on the existence of a specific table reference

product-category
string (EnumBankingProductCategoryV2)
Enum: "BUSINESS_LOANS" "BUY_NOW_PAY_LATER" "CRED_AND_CHRG_CARDS" "LEASES" "MARGIN_LOANS" "OVERDRAFTS" "PERS_LOANS" "REGULATED_TRUST_ACCOUNTS" "RESIDENTIAL_MORTGAGES" "TERM_DEPOSITS" "TRADE_FINANCE" "TRANS_AND_SAVINGS_ACCOUNTS" "TRAVEL_CARDS"
Example: product-category=TRANS_AND_SAVINGS_ACCOUNTS

Used to filter tables based on the category of the product they are in

page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

Responses

Response samples

Content type
application/json
Example
{}

Spaces

Spaces APIs

Get Spaces

Retrieve a list of Spaces and related data given the subscriptionId provided.

Authorizations:
TokenBasedAuth
query Parameters
subscriptionId
Array of strings
Example: subscriptionId=9bf2cae7-ca32-4124-905b-68404de9628f

Used to get information about specific subscriptions

page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

Responses

Response samples

Content type
application/json
{}

Create Space

Create a new Space for managing your Product Reference Data.

Authorizations:
TokenBasedAuth
Request Body schema: application/json
required

Request body for Create Space

principalId
required
string

A principal ID for the space

subscriptionId
required
string

The subscription ID for the space

name
required
string

A human-friendly name for the space

cdrBrandId
required
string

A CDR brand ID for the space

lastUpdated
required
string <date-time>

The date and time that the space was last updated

Responses

Request samples

Content type
application/json
{
  • "principalId": "ab252852-9648-4b69-9f01-4d60c1b82c41",
  • "subscriptionId": "ab252852-9648-4b69-9f01-4d60c1b82c41",
  • "name": "An example space",
  • "cdrBrandId": "An example CDR brand ID",
  • "lastUpdated": "2022-08-20T03:01:42+00:00"
}

Response samples

Content type
application/json
{
  • "meta": { },
  • "version": "V1",
  • "data": {
    }
}

Update Space

Update an existing Space.

Authorizations:
TokenBasedAuth
path Parameters
spaceId
required
string <uuid>

ID of the PRD Admin space

Request Body schema: application/json
required

Request body for Update Space

name
required
string

A human-friendly name for the space

cdrBrandId
required
string

A CDR brand ID for the space

Responses

Request samples

Content type
application/json
{
  • "name": "An example space",
  • "cdrBrandId": "An example CDR brand ID"
}

Response samples

Content type
application/json
{
  • "meta": { },
  • "version": "V1",
  • "data": {
    }
}

Tables

Tables APIs

List Tables

Retrieve a list of tables that exist in the Space.

Authorizations:
TokenBasedAuth
path Parameters
spaceId
required
string <uuid>

ID of the PRD Admin space

query Parameters
type
string (EnumItemTypeV1)
Enum: "FEE" "FEE_V2" "FEATURE" "FEATURE_V4" "ELIGIBILITY" "ELIGIBILITY_V2" "CONSTRAINT" "CONSTRAINT_V3" "BUNDLE" "CARD_ART" "CARD_ART_V2" "DEPOSIT_RATE" "DEPOSIT_RATE_V3" "LENDING_RATE" "LENDING_RATE_V3" "INSTALMENT"
Example: type=FEATURE

Used to filter results based on the type of the item

product-category
string (EnumBankingProductCategoryV2)
Enum: "BUSINESS_LOANS" "BUY_NOW_PAY_LATER" "CRED_AND_CHRG_CARDS" "LEASES" "MARGIN_LOANS" "OVERDRAFTS" "PERS_LOANS" "REGULATED_TRUST_ACCOUNTS" "RESIDENTIAL_MORTGAGES" "TERM_DEPOSITS" "TRADE_FINANCE" "TRANS_AND_SAVINGS_ACCOUNTS" "TRAVEL_CARDS"
Example: product-category=TRANS_AND_SAVINGS_ACCOUNTS

Used to filter tables based on the category of the product they are in

isRetrievingItems
boolean
Default: true

Flag to determine if items should be retrieved for each table

page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

Responses

Response samples

Content type
application/json

Get Table

Retrieve detailed information about a specific table, including its associated items.

Authorizations:
TokenBasedAuth
path Parameters
spaceId
required
string <uuid>

ID of the PRD Admin space

tableId
required
string <uuid>

ID of the table

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "version": "V1",
  • "data": {
    }
}