Jump to

• Request
• Response

executeImport

post

/ccadmin/v1/importProcess

Execute Import. Initiate import execution

Request

Supported Media Types

• application/json

Body ()

Root Schema : executeImport_request

Type: object

Show Source

• fileName: string
  The file name to import.
• format(optional): string
  Import format. Should be configured only for standalone mode.
• id(optional): string
  Import operation id. Should be configured only for standalone mode.
• mode(optional): string
  Import execution mode. Valid values are standalone and bundle.
• params(optional): object params
  Import parameters. Should be configured only for standalone mode.

{
    "properties":{
        "mode":{
            "description":"Import execution mode. Valid values are standalone and bundle.",
            "type":"string"
        },
        "fileName":{
            "description":"The file name to import.",
            "type":"string"
        },
        "format":{
            "description":"Import format. Should be configured only for standalone mode.",
            "type":"string"
        },
        "id":{
            "description":"Import operation id. Should be configured only for standalone mode.",
            "type":"string"
        },
        "params":{
            "description":"Import parameters. Should be configured only for standalone mode.",
            "type":"object",
            "properties":{
                "update":{
                    "description":"Existing records are updated by default. Passing false for the flag forces creation of new records. An error will be thrown if the record to be imported already exists in the repository.",
                    "type":"boolean"
                }
            }
        }
    },
    "required":[
        "fileName"
    ],
    "example":{
        "fileName":"exportProfilesAndOrders.zip"
    }
}

Example:

{
    "fileName":"exportProfilesAndOrders.zip"
}

Nested Schema : params

Type: object

Import parameters. Should be configured only for standalone mode.

Show Source

• update(optional): boolean
  Existing records are updated by default. Passing false for the flag forces creation of new records. An error will be thrown if the record to be imported already exists in the repository.

{
    "description":"Import parameters. Should be configured only for standalone mode.",
    "type":"object",
    "properties":{
        "update":{
            "description":"Existing records are updated by default. Passing false for the flag forces creation of new records. An error will be thrown if the record to be imported already exists in the repository.",
            "type":"boolean"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

202 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : executeImport_response

Type: object

Show Source

• processId(optional): string
  Token corresponding to the import process.
• status(optional): string
  Status flag indicating whether import process was initiated.

{
    "properties":{
        "processId":{
            "description":"Token corresponding to the import process.",
            "type":"string"
        },
        "status":{
            "description":"Status flag indicating whether import process was initiated.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "processId":"N2ECA3RrG1jLYZjN4Q6XTNrkjc_10000",
    "links":[
        {
            "rel":"self",
            "href":"http://example.com:9080/ccadminui/v1/importProcess"
        }
    ],
    "status":"submitted"
}

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