UpdateExistingProject

post

/import/updateExistingProject

Updates the Project that is specified by the ProjectObjectId with data from an XML file.

Request

Query Parameters
  • DownloadType is required to download Logfile of Import response, By default BOTH is enabled(Supported values - ATTACHMENT_ONLY,BOTH,RESPONSE_JSON_ONLY)
    Example:
    BOTH
Header Parameters
Supported Media Types
Request Body - multipart/form-data ()
Root Schema : ImportUpdateExistingProject
Type: object
Title: ImportUpdateExistingProject
ImportUpdateExistingProject Entity
Show Source
Nested Schema : UpdateExistingProject
Type: object
Show Source
  • BusinessObjectOptions
    Specifies which business objects to import according to the following rules: If no BusinessObjectOptions are specified, then all of the business objects in the project are imported. If any BusinessObjectOptions are specified, then only those business objects specified by the BusinessObjectOptions element are imported.
  • Allowed Values: [ "CREATE_NEW", "DO_NOT_IMPORT", "KEEP_EXISTING", "UPDATE_EXISTING" ]
    Import options that may be applied to projects globally.
  • Allowed Values: [ "CREATE_NEW", "DO_NOT_IMPORT", "KEEP_EXISTING", "UPDATE_EXISTING" ]
    Import options that may be applied to specific projects.
  • Allowed Values: [ "GZIP", "XML", "ZIP" ]
    Specifies the file type that the system imports.
  • 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.
  • 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.
  • Allowed Values: [ "SEVERE", "WARNING", "INFO", "CONFIG", "FINE", "FINER", "FINEST" ]
    string restricted to SEVERE WARNING INFO CONFIG FINE FINER FINEST
  • Unique Id of associated project.
Nested Schema : BusinessObjectOptions
Type: object
Specifies which business objects to import according to the following rules: If no BusinessObjectOptions are specified, then all of the business objects in the project are imported. If any BusinessObjectOptions are specified, then only those business objects specified by the BusinessObjectOptions element are imported.
Show Source
Nested Schema : GlobalBusinessObjectOptions
Type: object
Show Source
Nested Schema : ProjectSpecificBusinessObjectOptions
Type: object
Show Source
Nested Schema : BusinessObjectType
Type: object
Title: BusinessObjectType
BusinessObjectType Entity
Show Source
Nested Schema : DeleteUnreferencedType
Type: object
Show Source
Back to Top

Response

Supported Media Types

201 Response

OK.
Body ()
Root Schema : UpdateExistingProjectResponse
Type: object
Title: UpdateExistingProjectResponse
UpdateExistingProjectResponse Entity
Show Source
  • If an exception is thrown, ErrorMessage contains the message part of the exception.
  • Contains the logging information from the ImportProjects operation.
  • Boolean flag that indicates whether the UpdateExistingProject operation was successful.

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