Jump to

• Request
• Response

getAllPublishingChangeAuthors

get

/ccadmin/v1/publishingChangeAuthors

Get All Publishing Change Authors. Get all authors who made publishing changes

Request

Supported Media Types

• application/json

Query Parameters

• cacheableDataOnly: string
  Boolean flag to set whether to return only cacheable data (for example cacheableDataOnly=true).
• worksetId: string
  The workset ID.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getAllPublishingChangeAuthors_response

Type: object

Show Source

• items: array items
  Items of authors.
• totalResults: integer
  Total number of authors.

{
    "properties":{
        "totalResults":{
            "description":"Total number of authors.",
            "type":"integer"
        },
        "items":{
            "description":"Items of authors.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "firstName":{
                        "description":"First Name of the Author of publishing changes.",
                        "type":"string"
                    },
                    "lastName":{
                        "description":"Last Name the of Author of publishing changes.",
                        "type":"string"
                    },
                    "author":{
                        "description":"Author of publishing changes.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

Items of authors.

Show Source

• Array of: object items

{
    "description":"Items of authors.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "firstName":{
                "description":"First Name of the Author of publishing changes.",
                "type":"string"
            },
            "lastName":{
                "description":"Last Name the of Author of publishing changes.",
                "type":"string"
            },
            "author":{
                "description":"Author of publishing changes.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• author: string
  Author of publishing changes.
• firstName: string
  First Name of the Author of publishing changes.
• lastName: string
  Last Name the of Author of publishing changes.

{
    "type":"object",
    "properties":{
        "firstName":{
            "description":"First Name of the Author of publishing changes.",
            "type":"string"
        },
        "lastName":{
            "description":"Last Name the of Author of publishing changes.",
            "type":"string"
        },
        "author":{
            "description":"Author of publishing changes.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "totalResults":2,
    "items":[
        {
            "firstName":"Admin",
            "lastName":"Amber",
            "author":"admin"
        },
        {
            "firstName":"Damon",
            "lastName":"Weber",
            "author":"service"
        }
    ]
}

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| |------------------|------------------| |31201|Internal Error|

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• errors: array errors
  An optional list of errors if multiple errors were encountered
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: string
  The HTTP status code
• type: 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: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: 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