Jump to

• Request
• Response

Retrieve all extensions

get

/ccadmin/v1/extensions

Get summary information on all extensions currently uploaded in the system.

Sample Request:

       GET /ccadmin/v1/extensions    

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returned when the operation succeeds.

Body ()

Root Schema : getAllExtensions_response

Type: object

Show Source

• items(optional): array items
  list of extensions

{
    "properties":{
        "items":{
            "description":"list of extensions",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "installedTime":{
                        "description":"date and time the Extension was installed.",
                        "type":"string"
                    },
                    "creator":{
                        "description":"name of the creator of the Extension.",
                        "type":"string"
                    },
                    "creationTime":{
                        "description":"time the Extension was created.",
                        "type":"string"
                    },
                    "origin":{
                        "description":"where the zip file came from - will always be 'upload' for now.",
                        "type":"string"
                    },
                    "lastModifiedBy":{
                        "description":"user who last modified the Extension.",
                        "type":"string"
                    },
                    "description":{
                        "description":"summary description of the Extension.",
                        "type":"string"
                    },
                    "readme":{
                        "description":"contents of the README file - if any.",
                        "type":"string"
                    },
                    "version":{
                        "description":"version number of the Extension.",
                        "type":"string"
                    },
                    "enabled":{
                        "description":"true if Extension is currently enabled.",
                        "type":"boolean"
                    },
                    "developerId":{
                        "description":"ID of developer who created the Extension.",
                        "type":"string"
                    },
                    "zipPath":{
                        "description":"path of the zip file on the server that contains the Extension.",
                        "type":"string"
                    },
                    "modificationTime":{
                        "description":"last time the Extension was modified in any way.",
                        "type":"string"
                    },
                    "repositoryId":{
                        "description":"ID the Extension is stored against in the Repository.",
                        "type":"string"
                    },
                    "name":{
                        "description":"name of the Extension.",
                        "type":"string"
                    },
                    "installedBy":{
                        "description":"user who installed the Extension.",
                        "type":"string"
                    },
                    "installedByUserName":{
                        "description":"user who installed the Extension.",
                        "type":"string"
                    },
                    "items":{
                        "description":"list of elements or widgets",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "repositoryId":{
                                    "description":"ID of item (Element or Widget) contained in the Extension.",
                                    "type":"string"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

list of extensions

Show Source

• Array of: object items

{
    "description":"list of extensions",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "installedTime":{
                "description":"date and time the Extension was installed.",
                "type":"string"
            },
            "creator":{
                "description":"name of the creator of the Extension.",
                "type":"string"
            },
            "creationTime":{
                "description":"time the Extension was created.",
                "type":"string"
            },
            "origin":{
                "description":"where the zip file came from - will always be 'upload' for now.",
                "type":"string"
            },
            "lastModifiedBy":{
                "description":"user who last modified the Extension.",
                "type":"string"
            },
            "description":{
                "description":"summary description of the Extension.",
                "type":"string"
            },
            "readme":{
                "description":"contents of the README file - if any.",
                "type":"string"
            },
            "version":{
                "description":"version number of the Extension.",
                "type":"string"
            },
            "enabled":{
                "description":"true if Extension is currently enabled.",
                "type":"boolean"
            },
            "developerId":{
                "description":"ID of developer who created the Extension.",
                "type":"string"
            },
            "zipPath":{
                "description":"path of the zip file on the server that contains the Extension.",
                "type":"string"
            },
            "modificationTime":{
                "description":"last time the Extension was modified in any way.",
                "type":"string"
            },
            "repositoryId":{
                "description":"ID the Extension is stored against in the Repository.",
                "type":"string"
            },
            "name":{
                "description":"name of the Extension.",
                "type":"string"
            },
            "installedBy":{
                "description":"user who installed the Extension.",
                "type":"string"
            },
            "installedByUserName":{
                "description":"user who installed the Extension.",
                "type":"string"
            },
            "items":{
                "description":"list of elements or widgets",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "repositoryId":{
                            "description":"ID of item (Element or Widget) contained in the Extension.",
                            "type":"string"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• creationTime(optional): string
  time the Extension was created.
• creator(optional): string
  name of the creator of the Extension.
• description(optional): string
  summary description of the Extension.
• developerId(optional): string
  ID of developer who created the Extension.
• enabled(optional): boolean
  true if Extension is currently enabled.
• installedBy(optional): string
  user who installed the Extension.
• installedByUserName(optional): string
  user who installed the Extension.
• installedTime(optional): string
  date and time the Extension was installed.
• items(optional): array items
  list of elements or widgets
• lastModifiedBy(optional): string
  user who last modified the Extension.
• modificationTime(optional): string
  last time the Extension was modified in any way.
• name(optional): string
  name of the Extension.
• origin(optional): string
  where the zip file came from - will always be 'upload' for now.
• readme(optional): string
  contents of the README file - if any.
• repositoryId(optional): string
  ID the Extension is stored against in the Repository.
• version(optional): string
  version number of the Extension.
• zipPath(optional): string
  path of the zip file on the server that contains the Extension.

{
    "type":"object",
    "properties":{
        "installedTime":{
            "description":"date and time the Extension was installed.",
            "type":"string"
        },
        "creator":{
            "description":"name of the creator of the Extension.",
            "type":"string"
        },
        "creationTime":{
            "description":"time the Extension was created.",
            "type":"string"
        },
        "origin":{
            "description":"where the zip file came from - will always be 'upload' for now.",
            "type":"string"
        },
        "lastModifiedBy":{
            "description":"user who last modified the Extension.",
            "type":"string"
        },
        "description":{
            "description":"summary description of the Extension.",
            "type":"string"
        },
        "readme":{
            "description":"contents of the README file - if any.",
            "type":"string"
        },
        "version":{
            "description":"version number of the Extension.",
            "type":"string"
        },
        "enabled":{
            "description":"true if Extension is currently enabled.",
            "type":"boolean"
        },
        "developerId":{
            "description":"ID of developer who created the Extension.",
            "type":"string"
        },
        "zipPath":{
            "description":"path of the zip file on the server that contains the Extension.",
            "type":"string"
        },
        "modificationTime":{
            "description":"last time the Extension was modified in any way.",
            "type":"string"
        },
        "repositoryId":{
            "description":"ID the Extension is stored against in the Repository.",
            "type":"string"
        },
        "name":{
            "description":"name of the Extension.",
            "type":"string"
        },
        "installedBy":{
            "description":"user who installed the Extension.",
            "type":"string"
        },
        "installedByUserName":{
            "description":"user who installed the Extension.",
            "type":"string"
        },
        "items":{
            "description":"list of elements or widgets",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "repositoryId":{
                        "description":"ID of item (Element or Widget) contained in the Extension.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

list of elements or widgets

Show Source

• Array of: object items

{
    "description":"list of elements or widgets",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "repositoryId":{
                "description":"ID of item (Element or Widget) contained in the Extension.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• repositoryId(optional): string
  ID of item (Element or Widget) contained in the Extension.

{
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"ID of item (Element or Widget) contained in the Extension.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "items":[
        {
            "installedTime":"2014-06-20T09:28:31.562Z",
            "creator":"Oracle Corp.",
            "creationTime":"2014-01-01",
            "origin":"upload",
            "lastModifiedBy":"admin",
            "description":"Delivering New Widget with Element",
            "readme":null,
            "version":"1",
            "enabled":true,
            "developerId":"999999",
            "zipPath":"extensions/2014520102830313_workingUnderElements.zip",
            "modificationTime":"2014-06-20T09:28:31.562Z",
            "repositoryId":"4ab03536-9c6f-41ce-84d8-45934bed0693",
            "name":"Widget with Element",
            "installedBy":"admin",
            "installedByUserName":"Amber Admin",
            "items":[
                {
                    "repositoryId":"100001"
                },
                {
                    "repositoryId":"100002"
                }
            ]
        }
    ]
}

401 Response

Returned if an internal error occurs in the endpoint.

Body ()

Root Schema : getAllExtensions_401response

Type: object

Show Source

• errorCode(optional): string
  The error code
• message(optional): string
  The localized message describing the error
• status(optional): string
  HTTP status code

{
    "properties":{
        "errorCode":{
            "description":"The error code",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "status":{
            "description":"HTTP status code",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "errorCode":"00001000",
    "message":"The user is not authenticated",
    "status":"401"
}

500 Response

Returned if an internal error occurs in the endpoint.

Body ()

Root Schema : getAllExtensions_500response

Type: object

Show Source

• errorCode(optional): string
  The OCC error code. See below table for details of common codes.
• message(optional): string
  The localized message describing the error
• status(optional): string
  HTTP status code

{
    "properties":{
        "errorCode":{
            "description":"The OCC error code. See below table for details of common codes.",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "status":{
            "description":"HTTP status code",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "errorCode":"000000000",
    "message":"Internal Error",
    "status":"500"
}

Default Response

The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:

Error Code	Description	Possible Fix
91004	Extension internal error	See error messages for further information.

The error response:

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