Jump to

• Request
• Response

storePublishingChangeList

post

/ccadmin/v1/publishingChangeLists

Store Publishing Change List. Store a list of change item IDs for later dependency calculations or selective publishing

Request

Supported Media Types

• application/json

Body ()

Root Schema : storePublishingChangeList_request

Type: object

Show Source

• changeItemIds: array changeItemIds
  Array of change item IDs to store. Required only if the "q" parameter is not provided. If the "q" parameter is provided, then "changeItemIds" can be left off or it should only contain change IDs not already covered by the "q" parameter.
• q(optional): string
  An optional query filter string (in the SCM filter format) used in lieu of or in addition to the "changeItemIds" for identifying the criteria for what change items to store.

{
    "properties":{
        "q":{
            "description":"An optional query filter string (in the SCM filter format) used in lieu of or in addition to the \"changeItemIds\" for identifying the criteria for what change items to store.",
            "type":"string"
        },
        "changeItemIds":{
            "description":"Array of change item IDs to store. Required only if the \"q\" parameter is not provided.  If the \"q\" parameter is provided, then \"changeItemIds\" can be left off or it should only contain change IDs not already covered by the \"q\" parameter.",
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "required":[
        "changeItemIds"
    ],
    "example":{
        "q":"(assetType eq \"price\")",
        "changeItemIds":[
            "ID1",
            "ID2",
            "ID3"
        ]
    }
}

Example:

{
    "q":"(assetType eq \"price\")",
    "changeItemIds":[
        "ID1",
        "ID2",
        "ID3"
    ]
}

Nested Schema : changeItemIds

Type: array

Array of change item IDs to store. Required only if the "q" parameter is not provided. If the "q" parameter is provided, then "changeItemIds" can be left off or it should only contain change IDs not already covered by the "q" parameter.

Show Source

• Array of: string

{
    "description":"Array of change item IDs to store. Required only if the \"q\" parameter is not provided.  If the \"q\" parameter is provided, then \"changeItemIds\" can be left off or it should only contain change IDs not already covered by the \"q\" parameter.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : storePublishingChangeList_response

Type: object

Show Source

• changeListId(optional): string
  ID corresponding to the change item lists which can be used to invoke getPublishing endpoint.

{
    "properties":{
        "changeListId":{
            "description":"ID corresponding to the change item lists which can be used to invoke getPublishing endpoint.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "changeListId":"N2ECA3RrG1jLYZjN4Q6XTNrkjc_10000"
}

Default Response

The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |31034|List of input change item IDs not found|

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• errors(optional): array errors
  An optional list of errors if multiple errors were encountered
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code
• type(optional): string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top