Jump to

• Request
• Response

doCreateExtensionVariable

post

/ccadmin/v1/extensionEnvironmentVariables

Create extension variable. Creates a new extension server variable.

Request

Supported Media Types

• application/json

Body ()

Root Schema : doCreateExtensionVariable_request

Type: object

Show Source

• name: string
  Name of the extension variable.
• value: string
  value of the extension variable.

{
    "properties":{
        "name":{
            "description":"Name of the extension variable.",
            "type":"string"
        },
        "value":{
            "description":"value of the extension variable.",
            "type":"string"
        }
    },
    "required":[
        "name",
        "value"
    ],
    "example":{
        "name":"atg.webhook.calculateShipping",
        "value":"pDDdn/kzVbGGyULkBmbuLBkor+GCyJ1Bi7xtqirulM4vSQj2hc+sNZEzBTMTo7j6sxl1gxR6vtoPtC8g0vVuvh=="
    }
}

Example:

{
    "name":"atg.webhook.calculateShipping",
    "value":"pDDdn/kzVbGGyULkBmbuLBkor+GCyJ1Bi7xtqirulM4vSQj2hc+sNZEzBTMTo7j6sxl1gxR6vtoPtC8g0vVuvh=="
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : doCreateExtensionVariable_response

Type: object

Show Source

• createdBy(optional): object createdBy
  extension variable created by which admin user.
• creationTime(optional): string
  Creation time of the extension variable.
• id(optional): string
  id of the extension variable.
• lastModifiedBy(optional): string
  last modified admin user.
• modificationTime(optional): string
  Modified time of the extension variable.
• name(optional): string
  name of the extension variable.
• value(optional): string
  value of the extension variable.

{
    "properties":{
        "creationTime":{
            "description":"Creation time of the extension variable.",
            "type":"string"
        },
        "createdBy":{
            "description":"extension variable created by which admin user.",
            "type":"object",
            "properties":{
                "firstName":{
                    "description":"first name of the admin user.",
                    "type":"string"
                },
                "lastName":{
                    "description":"last name of the admin user.",
                    "type":"string"
                },
                "id":{
                    "description":"Repository ID of admin user.",
                    "type":"string"
                }
            }
        },
        "modificationTime":{
            "description":"Modified time of the extension variable.",
            "type":"string"
        },
        "lastModifiedBy":{
            "description":"last modified admin user.",
            "type":"string"
        },
        "name":{
            "description":"name of the extension variable.",
            "type":"string"
        },
        "id":{
            "description":"id of the extension variable.",
            "type":"string"
        },
        "value":{
            "description":"value of the extension variable.",
            "type":"string"
        }
    }
}

Nested Schema : createdBy

Type: object

extension variable created by which admin user.

Show Source

• firstName(optional): string
  first name of the admin user.
• id(optional): string
  Repository ID of admin user.
• lastName(optional): string
  last name of the admin user.

{
    "description":"extension variable created by which admin user.",
    "type":"object",
    "properties":{
        "firstName":{
            "description":"first name of the admin user.",
            "type":"string"
        },
        "lastName":{
            "description":"last name of the admin user.",
            "type":"string"
        },
        "id":{
            "description":"Repository ID of admin user.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "creationTime":"2018-06-14T20:29:38.000Z",
    "createdBy":{
        "firstName":"Admin",
        "lastName":"User",
        "repositoryId":"admin",
        "id":"admin"
    },
    "modificationTime":"2018-06-15T15:55:24.442Z",
    "lastModifiedBy":"admin",
    "name":"atg.webhook.calculateShipping",
    "id":"100001",
    "value":"pDDdn/kzVbGGyULkBmbuLBkor+GCyJ1Bi7xtqirulM4vSQj2hc+sNZEzBTMTo7j6sxl1gxR6vtoPtC8g0vVuvh=="
}

Default Response

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