Jump to

• Request
• Response

ImportProjectAsyncASAP

post

/import/importProjectAsyncASAP

Imports one or more new projects from an XML file asynchronously as a job. Each new project is created under the EPS specified by the EPSObjectId. When you call the ImportProjects operation, you specify one or more ImportProject elements. Each of these elements contain information about the project you are importing.

Request

Header Parameters

• Authorization(required):
  OAuth token

Supported Media Types

• multipart/form-data

Request Body - multipart/form-data ()

Root Schema : AsyncASAPImportProject

Type: object

Title: AsyncASAPImportProject

AsyncASAPImportProject Entity

Show Source

• ImportProjectAsyncASAP: object ImportProjectAsyncASAP
• ProjectData: string (binary)
  File to import

{
    "title":"AsyncASAPImportProject",
    "type":"object",
    "properties":{
        "ProjectData":{
            "type":"string",
            "description":"File to import",
            "format":"binary"
        },
        "ImportProjectAsyncASAP":{
            "$ref":"#/components/schemas/ImportProjectAsyncASAP"
        }
    },
    "description":"AsyncASAPImportProject Entity"
}

Nested Schema : ImportProjectAsyncASAP

Type: object

Show Source

• CurrenciesImportInOption: string
  Allowed Values: [ "BASERATE", "XMLRATE" ]
• FileType: string
  Allowed Values: [ "GZIP", "XML", "ZIP" ]

  Specifies the file type that the system supports.
• IgnoreGUID: boolean
  When this flag is set to true, the XMLImporter ignores all GUID fields in the XML file, and allows new GUID values to be generated. When this flag is set to false, the XMLImporter uses the GUID fields.
• IgnoreSequenceNumber: boolean
  When this flag is set to true, the XMLImporter ignores all SequenceNumber fields in the XML file, and allows new SequenceNumber values to be generated. When this flag is set to false, XMLImporter uses the SequenceNumber fields.
• ImportProject: array ImportProject
• ImportTemplateName: string
• ImportType: string
• LogLevel: string
  Allowed Values: [ "SEVERE", "WARNING", "INFO", "CONFIG", "FINE", "FINER", "FINEST" ]
• PreImportCustomizationTemplateName: string

{
    "type":"object",
    "properties":{
        "CurrenciesImportInOption":{
            "type":"string",
            "enum":[
                "BASERATE",
                "XMLRATE"
            ]
        },
        "ImportProject":{
            "type":"array",
            "format":"textarea",
            "items":{
                "$ref":"#/components/schemas/ImportProject"
            }
        },
        "ImportType":{
            "type":"string"
        },
        "ImportTemplateName":{
            "type":"string"
        },
        "PreImportCustomizationTemplateName":{
            "type":"string"
        },
        "FileType":{
            "type":"string",
            "description":"Specifies the file type that the system supports.",
            "enum":[
                "GZIP",
                "XML",
                "ZIP"
            ]
        },
        "IgnoreGUID":{
            "type":"boolean",
            "description":"When this flag is set to true, the XMLImporter ignores all GUID fields in the XML file, and allows new GUID values to be generated. When this flag is set to false, the XMLImporter uses the GUID fields."
        },
        "IgnoreSequenceNumber":{
            "type":"boolean",
            "description":"When this flag is set to true, the XMLImporter ignores all SequenceNumber fields in the XML file, and allows new SequenceNumber values to be generated. When this flag is set to false, XMLImporter uses the SequenceNumber fields."
        },
        "LogLevel":{
            "type":"string",
            "enum":[
                "SEVERE",
                "WARNING",
                "INFO",
                "CONFIG",
                "FINE",
                "FINER",
                "FINEST"
            ]
        }
    }
}

Nested Schema : ImportProject

Type: array

Show Source

• Array of: object ImportProject
  Title: ImportProject

  ImportProject Entity

{
    "type":"array",
    "format":"textarea",
    "items":{
        "$ref":"#/components/schemas/ImportProject"
    }
}

Nested Schema : ImportProject

Type: object

Title: ImportProject

ImportProject Entity

Show Source

• EPSObjectId: integer (int32)
  If the ImportOption is Update Existing, then specifies the Project ID; if the ImportOption is Create New, then specifies the EPS ID.
• ImportOption: string
  Allowed Values: [ "CREATE_NEW", "DO_NOT_IMPORT", "KEEP_EXISTING", "UPDATE_EXISTING" ]

  Specify Create New to import a project that already exists as a new project; specify Update Existing to import a project to update an existing project.
• ProjectObjectId: integer (int32)
  Specifies the Project Id to be imported.

{
    "title":"ImportProject",
    "type":"object",
    "properties":{
        "ProjectObjectId":{
            "type":"integer",
            "description":"Specifies the Project Id to be imported.",
            "format":"int32"
        },
        "ImportOption":{
            "type":"string",
            "description":"Specify Create New to import a project that already exists as a new project; specify Update Existing to import a project to update an existing project.",
            "enum":[
                "CREATE_NEW",
                "DO_NOT_IMPORT",
                "KEEP_EXISTING",
                "UPDATE_EXISTING"
            ]
        },
        "EPSObjectId":{
            "type":"integer",
            "description":"If the ImportOption is Update Existing, then specifies the Project ID; if the ImportOption is Create New, then specifies the EPS ID.",
            "format":"int32"
        }
    },
    "description":"ImportProject Entity",
    "format":"textarea"
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

OK.

Body ()

Root Schema : ImportProjectAsyncASAPResponse

Type: object

Title: ImportProjectAsyncASAPResponse

ImportProjectAsyncASAPResponse Entity

Show Source

• ErrorMessage: string
• JobObjectId: integer (int32)
• Success: boolean
• SuccessMessage: string

{
    "title":"ImportProjectAsyncASAPResponse",
    "type":"object",
    "properties":{
        "ErrorMessage":{
            "type":"string"
        },
        "JobObjectId":{
            "type":"integer",
            "format":"int32"
        },
        "Success":{
            "type":"boolean"
        },
        "SuccessMessage":{
            "type":"string"
        }
    },
    "description":"ImportProjectAsyncASAPResponse Entity"
}

400 Response

Bad Request.

401 Response

Unauthorized.

403 Response

Forbidden.

404 Response

Not Found.

405 Response

Invalid Input.

500 Response

Internal Server Error.

Back to Top