Jump to

• Request
• Response

listWorksets

get

/ccadmin/v1/worksets

Lists worksets.

Request

Supported Media Types

• application/json

Query Parameters

• includeScheduledWorksets(optional): boolean
  Whether to list scheduled worksets.
• q(optional): string
  Query string that filters the access rights to be returned from this request using SCIM filtering syntax.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : listWorksets_response

Type: object

Show Source

• items(optional): array items
  List of worksets
• limit(optional): string
  Number of records to be fetched.
• offset(optional): string
  The offset provided.
• sort(optional): array sort
  Sorting criteria.
• total(optional): string
  Total number of records present in database matching the searched string.
• totalResults(optional): string
  Total number of records present in database matching the searched string.

{
    "properties":{
        "total":{
            "description":"Total number of records present in database matching the searched string.",
            "type":"string"
        },
        "totalResults":{
            "description":"Total number of records present in database matching the searched string.",
            "type":"string"
        },
        "offset":{
            "description":"The offset provided.",
            "type":"string"
        },
        "limit":{
            "description":"Number of records to be fetched.",
            "type":"string"
        },
        "sort":{
            "description":"Sorting criteria.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "property":{
                        "description":"The property the listing is sorted by.",
                        "type":"string"
                    },
                    "order":{
                        "description":"Sort order: asc or desc.",
                        "type":"string"
                    }
                }
            }
        },
        "items":{
            "description":"List of worksets",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "description":"Workset name.",
                        "type":"string"
                    },
                    "repositoryId":{
                        "description":"Workset ID.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

List of worksets

Show Source

• Array of: object items

{
    "description":"List of worksets",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "description":"Workset name.",
                "type":"string"
            },
            "repositoryId":{
                "description":"Workset ID.",
                "type":"string"
            }
        }
    }
}

Nested Schema : sort

Type: array

Sorting criteria.

Show Source

• Array of: object items

{
    "description":"Sorting criteria.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "property":{
                "description":"The property the listing is sorted by.",
                "type":"string"
            },
            "order":{
                "description":"Sort order: asc or desc.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• name(optional): string
  Workset name.
• repositoryId(optional): string
  Workset ID.

{
    "type":"object",
    "properties":{
        "name":{
            "description":"Workset name.",
            "type":"string"
        },
        "repositoryId":{
            "description":"Workset ID.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• order(optional): string
  Sort order: asc or desc.
• property(optional): string
  The property the listing is sorted by.

{
    "type":"object",
    "properties":{
        "property":{
            "description":"The property the listing is sorted by.",
            "type":"string"
        },
        "order":{
            "description":"Sort order: asc or desc.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "total":2,
    "totalResults":2,
    "offset":0,
    "limit":250,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadmin/v1/worksets"
        }
    ],
    "sort":[
        {
            "property":"name",
            "order":"asc"
        }
    ],
    "items":[
        {
            "name":"default",
            "repositoryId":"default"
        },
        {
            "name":"summer_sales",
            "repositoryId":"ws10001"
        }
    ]
}

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| |------------------|------------------| |31303|Internal server error.| |85000|q query param is not valid SCIM filter format|

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