Jump to

• Request
• Response

Process an extension

post

/ccadmin/v1/extensions/{id}

Activate/deactivate a previously uploaded extension.

When an extension is deactivated, all content contained in that extension is removed from the system. The extension zip file is retained.

When an extension is actibvated, the contents are revalidated and re-uploaded to the system. This is equivalent to what happens when the extension is initially uploaded from the UI.

Sample Request:

       POST /ccadmin/v1/extensions/{id}    

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  The ID of the extension to process.

Body ()

Root Schema : processExtension_request

Type: object

Show Source

• op: string
  The operation to perform, either 'activate' or 'deactivate'.

{
    "properties":{
        "op":{
            "description":"The operation to perform, either 'activate' or 'deactivate'.",
            "type":"string"
        }
    },
    "required":[
        "op"
    ],
    "example":"POST /ccadmin/v1/extensions/021be6f7-9b84-43ed-9d16-59358443d29f"
}

Example:

POST /ccadmin/v1/extensions/021be6f7-9b84-43ed-9d16-59358443d29f

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returned when the operation succeeds.

Body ()

Root Schema : processExtension_response

Type: object

Show Source

• success(optional): boolean
  True if the extension was successfully processed.

{
    "properties":{
        "success":{
            "description":"True if the extension was successfully processed.",
            "type":"boolean"
        }
    }
}

Example Response (application/json)

{
    "success":true,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadminui/v1/extensions/951e17e9-e272-4b79-bb06-f591d955add7"
        }
    ]
}

401 Response

Returned if the user is not authenticated.

Body ()

Root Schema : processExtension_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"
}

404 Response

Returned if the extension is not found.

Body ()

Root Schema : processExtension_404response

Type: object

Show Source

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

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

Example Response (application/json)

{
    "message":"HTTP 404 not found",
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4",
    "status":"404"
}

500 Response

Returned if an internal error occurs in the endpoint.

Body ()

Root Schema : processExtension_500response

Type: object

Show Source

• errorCode(optional): string
  The Commerce error code. See the table for information on common codes.
• message(optional): string
  The localized message describing the error
• status(optional): string
  HTTP status code

{
    "properties":{
        "errorCode":{
            "description":"The Commerce error code. See the table for information on 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 internal error codes are thrown by this API when the request fails in Commerce:

Error Code	Description	Possible Fix
91004	Endpoint internal error	See error messages for more information.
91017	Extension not found.	Ensure that a valid extension has been specified.
91020	Extension is already inactive.	Ensure that you are deactivating an active extension.

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