Jump to

• Request
• Response

ImportProjects

post

/import/importProjects

Imports one or more new projects from an XML file. 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

Query Parameters

• DownloadType(required): string
  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

• Authorization(required):
  OAuth token

Supported Media Types

• multipart/form-data

Request Body - multipart/form-data ()

Root Schema : ProjectsImport

Type: object

Title: ProjectsImport

ProjectsImport Entity

Show Source

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

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

Nested Schema : ImportProjects

Type: object

Show Source

• BusinessObjectOptions: object 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.
• CurrenciesImportInOption: string
  Allowed Values: [ "BASERATE", "XMLRATE" ]
• DefaultGlobalImportOption: string
  Allowed Values: [ "CREATE_NEW", "DO_NOT_IMPORT", "KEEP_EXISTING", "UPDATE_EXISTING" ]

  Import options that may be applied to projects globally.
• DefaultProjectSpecificImportOption: string
  Allowed Values: [ "CREATE_NEW", "DO_NOT_IMPORT", "KEEP_EXISTING", "UPDATE_EXISTING" ]

  Import options that may be applied to specific projects.
• FileType: string
  Allowed Values: [ "GZIP", "XML", "ZIP" ]

  Specifies the file type that the system imports.
• 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
• LogLevel: string
  Allowed Values: [ "SEVERE", "WARNING", "INFO", "CONFIG", "FINE", "FINER", "FINEST" ]

{
    "type":"object",
    "properties":{
        "CurrenciesImportInOption":{
            "type":"string",
            "enum":[
                "BASERATE",
                "XMLRATE"
            ]
        },
        "ImportProject":{
            "type":"array",
            "format":"textarea",
            "items":{
                "$ref":"#/components/schemas/ImportProject"
            }
        },
        "FileType":{
            "type":"string",
            "description":"Specifies the file type that the system imports.",
            "enum":[
                "GZIP",
                "XML",
                "ZIP"
            ]
        },
        "BusinessObjectOptions":{
            "$ref":"#/components/schemas/BusinessObjectOptions"
        },
        "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"
            ]
        },
        "DefaultGlobalImportOption":{
            "type":"string",
            "description":"Import options that may be applied to projects globally.",
            "enum":[
                "CREATE_NEW",
                "DO_NOT_IMPORT",
                "KEEP_EXISTING",
                "UPDATE_EXISTING"
            ]
        },
        "DefaultProjectSpecificImportOption":{
            "type":"string",
            "description":"Import options that may be applied to specific projects.",
            "enum":[
                "CREATE_NEW",
                "DO_NOT_IMPORT",
                "KEEP_EXISTING",
                "UPDATE_EXISTING"
            ]
        }
    }
}

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

• Global: object GlobalBusinessObjectOptions
• ProjectSpecific: object ProjectSpecificBusinessObjectOptions

{
    "type":"object",
    "properties":{
        "Global":{
            "$ref":"#/components/schemas/GlobalBusinessObjectOptions"
        },
        "ProjectSpecific":{
            "$ref":"#/components/schemas/ProjectSpecificBusinessObjectOptions"
        }
    },
    "description":"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."
}

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 : GlobalBusinessObjectOptions

Type: object

Show Source

• ActivityCode: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• ActivityCodeType: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• ActivityCodeTypeEPS: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• Calendar: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• CalendarRsrc: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• CostAccount: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• Currency: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• ExpenseCategory: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• FinancialPeriod: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• FundingSource: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• NotebookTopic: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• OBS: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• ProjectCode: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• ProjectCodeType: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• ProjectResourceCategory: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• Resource: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• ResourceCode: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• ResourceCodeType: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• ResourceCurve: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• ResourceRate: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• ResourceRole: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• RiskCategory: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• RiskMatrix: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• RiskMatrixScore: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• RiskMatrixThreshold: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• RiskThreshold: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• RiskThresholdLevel: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• Role: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• RoleLimit: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• RoleRate: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• Shift: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• ThresholdParameter: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• UDFCode: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• UDFType: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• UnitOfMeasure: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• WBSCategory: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity

{
    "type":"object",
    "properties":{
        "ActivityCode":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "ActivityCodeType":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "ActivityCodeTypeEPS":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "Calendar":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "CalendarRsrc":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "CostAccount":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "Currency":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "ExpenseCategory":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "FinancialPeriod":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "FundingSource":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "NotebookTopic":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "OBS":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "ProjectCode":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "ProjectCodeType":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "ProjectResourceCategory":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "Resource":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "ResourceCode":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "ResourceCodeType":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "ResourceCurve":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "ResourceRate":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "ResourceRole":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "RiskCategory":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "RiskMatrixScore":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "RiskMatrixThreshold":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "RiskMatrix":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "RiskThreshold":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "RiskThresholdLevel":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "Role":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "RoleRate":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "RoleLimit":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "Shift":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "ThresholdParameter":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "UnitOfMeasure":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "UDFCode":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "WBSCategory":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "UDFType":{
            "$ref":"#/components/schemas/BusinessObjectType"
        }
    }
}

Nested Schema : ProjectSpecificBusinessObjectOptions

Type: object

Show Source

• Activity: object DeleteUnreferencedType
• ActivityCode: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• ActivityCodeType: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• ActivityExpense: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• ActivityNote: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• ActivityPeriodActual: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• ActivityRisk: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• ActivityStep: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• Calendar: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• ExtRelationship: object DeleteUnreferencedType
• ProjectBudgetChangeLog: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• ProjectFunding: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• ProjectIssue: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• ProjectNote: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• ProjectResource: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• ProjectResourceQuantity: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• ProjectSpendingPlan: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• ProjectThreshold: object DeleteUnreferencedType
• Relationship: object DeleteUnreferencedType
• ResourceAssignment: object DeleteUnreferencedType
• ResourceAssignmentPeriodActual: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• Risk: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• RiskImpact: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• RiskResponseAction: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• RiskResponseActionImpact: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• RiskResponsePlan: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• WBS: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity
• WBSMilestone: object BusinessObjectType
  Title: BusinessObjectType

  BusinessObjectType Entity

{
    "type":"object",
    "properties":{
        "Activity":{
            "$ref":"#/components/schemas/DeleteUnreferencedType"
        },
        "ActivityCode":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "ActivityCodeType":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "ActivityExpense":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "ActivityNote":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "ActivityPeriodActual":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "ActivityRisk":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "ActivityStep":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "Calendar":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "ProjectBudgetChangeLog":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "ProjectFunding":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "ProjectIssue":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "ProjectNote":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "ProjectResource":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "ProjectResourceQuantity":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "ProjectSpendingPlan":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "ProjectThreshold":{
            "$ref":"#/components/schemas/DeleteUnreferencedType"
        },
        "Relationship":{
            "$ref":"#/components/schemas/DeleteUnreferencedType"
        },
        "ExtRelationship":{
            "$ref":"#/components/schemas/DeleteUnreferencedType"
        },
        "ResourceAssignment":{
            "$ref":"#/components/schemas/DeleteUnreferencedType"
        },
        "ResourceAssignmentPeriodActual":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "Risk":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "RiskImpact":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "RiskResponseAction":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "RiskResponseActionImpact":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "RiskResponsePlan":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "WBS":{
            "$ref":"#/components/schemas/BusinessObjectType"
        },
        "WBSMilestone":{
            "$ref":"#/components/schemas/BusinessObjectType"
        }
    }
}

Nested Schema : BusinessObjectType

Type: object

Title: BusinessObjectType

BusinessObjectType Entity

Show Source

• ImportOption: string
  Allowed Values: [ "CREATE_NEW", "DO_NOT_IMPORT", "KEEP_EXISTING", "UPDATE_EXISTING" ]

{
    "title":"BusinessObjectType",
    "type":"object",
    "properties":{
        "ImportOption":{
            "type":"string",
            "enum":[
                "CREATE_NEW",
                "DO_NOT_IMPORT",
                "KEEP_EXISTING",
                "UPDATE_EXISTING"
            ]
        }
    },
    "description":"BusinessObjectType Entity"
}

Nested Schema : DeleteUnreferencedType

Type: object

Show Source

• DeleteUnreferenced: boolean
• ImportOption: string
  Allowed Values: [ "CREATE_NEW", "DO_NOT_IMPORT", "KEEP_EXISTING", "UPDATE_EXISTING" ]

{
    "type":"object",
    "properties":{
        "ImportOption":{
            "type":"string",
            "enum":[
                "CREATE_NEW",
                "DO_NOT_IMPORT",
                "KEEP_EXISTING",
                "UPDATE_EXISTING"
            ]
        },
        "DeleteUnreferenced":{
            "type":"boolean"
        }
    }
}

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

• multipart/mixed
• application/json

201 Response

OK.

Body ()

Root Schema : ImportProjectsResponse

Type: object

Title: ImportProjectsResponse

ImportProjectsResponse Entity

Show Source

• ErrorMessage: string
  If an exception is thrown, ErrorMessage contains the message part of the exception.
• LogFile: string
  Contains the logging information from the ImportProjects operation.
• ProjectObjectId: array ProjectObjectId
  The unique identifier of the project that was created or updated by the ImportProjects operation. If multiple objects are created, a list of project object IDs is returned.
• Success: boolean
  Boolean flag that indicates whether the ImportProjects operation was successful.

{
    "title":"ImportProjectsResponse",
    "type":"object",
    "properties":{
        "LogFile":{
            "type":"string",
            "description":"Contains the logging information from the ImportProjects operation."
        },
        "ErrorMessage":{
            "type":"string",
            "description":"If an exception is thrown, ErrorMessage contains the message part of the exception."
        },
        "Success":{
            "type":"boolean",
            "description":"Boolean flag that indicates whether the ImportProjects operation was successful."
        },
        "ProjectObjectId":{
            "type":"array",
            "description":"The unique identifier of the project that was created or updated by the ImportProjects operation. If multiple objects are created, a list of project object IDs is returned.",
            "items":{
                "type":"integer",
                "description":"The unique identifier of the project that was created or updated by the ImportProjects operation. If multiple objects are created, a list of project object IDs is returned.",
                "format":"int32"
            }
        }
    },
    "description":"ImportProjectsResponse Entity"
}

Nested Schema : ProjectObjectId

Type: array

The unique identifier of the project that was created or updated by the ImportProjects operation. If multiple objects are created, a list of project object IDs is returned.

Show Source

• Array of: integer(int32)
  The unique identifier of the project that was created or updated by the ImportProjects operation. If multiple objects are created, a list of project object IDs is returned.

{
    "type":"array",
    "description":"The unique identifier of the project that was created or updated by the ImportProjects operation. If multiple objects are created, a list of project object IDs is returned.",
    "items":{
        "type":"integer",
        "description":"The unique identifier of the project that was created or updated by the ImportProjects operation. If multiple objects are created, a list of project object IDs is returned.",
        "format":"int32"
    }
}

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