Jump to

• Request
• Response

Import a Decoded P6 XML

post

/api/restapi/action/importDecodedP6xml

Send a request to this endpoint to create a job to import a well-formed, compressed, and decoded P6 XML file. Send a request to the View Job Status endpoint to monitor the job status.

Request

There are no request parameters for this operation.

Supported Media Types

• multipart/form-data

Request Body - multipart/form-data ()

Root Schema : schema

Type: object

Show Source

• data(required): data
  Entity payload or information with workspace, clobber options and projects to be imported using the given P6 XML.
• file(required): object file
  The xml file to be imported.

{
    "required":[
        "data",
        "file"
    ],
    "type":"object",
    "properties":{
        "file":{
            "type":"object",
            "description":"The xml file to be imported.",
            "exampleSetFlag":false,
            "types":[
                "object"
            ],
            "jsonSchema":{
                "type":"object"
            }
        },
        "data":{
            "description":"Entity payload or information with workspace, clobber options and projects to be imported using the given P6 XML.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityImportP6XMLInput"
                }
            ]
        }
    },
    "exampleSetFlag":false,
    "types":[
        "object"
    ]
}

Nested Schema : data

Entity payload or information with workspace, clobber options and projects to be imported using the given P6 XML.

Match All

Entity payload or information with workspace, clobber options and projects to be imported using the given P6 XML.

Show Source

• object ApiEntityImportP6XMLInput
  Title: ApiEntityImportP6XMLInput

{
    "description":"Entity payload or information with workspace, clobber options and projects to be imported using the given P6 XML.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityImportP6XMLInput"
        }
    ]
}

Nested Schema : file

Type: object

The xml file to be imported.

Nested Schema : ApiEntityImportP6XMLInput

Type: object

Title: ApiEntityImportP6XMLInput

Show Source

• importClobberConfig: importClobberConfig
  Project & Workspace Level Objects' clobber configuration.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• projectsInfo(required): array projectsInfo
  The import option and baseline information for each project in the xml or xer file.
• updateDate: string (date-time)
  Date when the record was last updated.
• workspaceCode: string
  Maximum Length: 60

  User provided identifier of workspace for importing xml or xer file.
• workspaceId(required): integer (int64)
  System generated identifier of workspace for importing xml or xer file.

{
    "title":"ApiEntityImportP6XMLInput",
    "required":[
        "projectsInfo",
        "workspaceId"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectsInfo":{
            "type":"array",
            "description":"The import option and baseline information for each project in the xml or xer file.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityProjectInfoInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"System generated identifier of workspace for importing xml or xer file.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "importClobberConfig":{
            "description":"Project & Workspace Level Objects' clobber configuration.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityImportClobberConfigInput"
                }
            ]
        },
        "workspaceCode":{
            "maxLength":60,
            "type":"string",
            "description":"User provided identifier of workspace for importing xml or xer file.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : importClobberConfig

Project & Workspace Level Objects' clobber configuration.

Match All

Project & Workspace Level Objects' clobber configuration.

Show Source

• object ApiEntityImportClobberConfigInput
  Title: ApiEntityImportClobberConfigInput

{
    "description":"Project & Workspace Level Objects' clobber configuration.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityImportClobberConfigInput"
        }
    ]
}

Nested Schema : projectsInfo

Type: array

The import option and baseline information for each project in the xml or xer file.

Show Source

• Array of: object ApiEntityProjectInfoInput
  Title: ApiEntityProjectInfoInput

{
    "type":"array",
    "description":"The import option and baseline information for each project in the xml or xer file.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityProjectInfoInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityImportClobberConfigInput

Type: object

Title: ApiEntityImportClobberConfigInput

Show Source

• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• projectClobberOptions: array projectClobberOptions
  The options for taking action on project level items in the XML.
• updateDate: string (date-time)
  Date when the record was last updated.
• workspaceClobberOptions: array workspaceClobberOptions
  The options for taking action on workspace level items in the XML.

{
    "title":"ApiEntityImportClobberConfigInput",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceClobberOptions":{
            "type":"array",
            "description":"The options for taking action on workspace level items in the XML.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityWorkspaceClobberConfigInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "projectClobberOptions":{
            "type":"array",
            "description":"The options for taking action on project level items in the XML.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityProjectClobberConfigInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : projectClobberOptions

Type: array

The options for taking action on project level items in the XML.

Show Source

• Array of: object ApiEntityProjectClobberConfigInput
  Title: ApiEntityProjectClobberConfigInput

{
    "type":"array",
    "description":"The options for taking action on project level items in the XML.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityProjectClobberConfigInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : workspaceClobberOptions

Type: array

The options for taking action on workspace level items in the XML.

Show Source

• Array of: object ApiEntityWorkspaceClobberConfigInput
  Title: ApiEntityWorkspaceClobberConfigInput

{
    "type":"array",
    "description":"The options for taking action on workspace level items in the XML.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityWorkspaceClobberConfigInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityProjectClobberConfigInput

Type: object

Title: ApiEntityProjectClobberConfigInput

Show Source

• importOption(required): string
  Allowed Values: [ "UPDATE_EXISTING", "KEEP_EXISTING", "IGNORE" ]

  The import action indicates how to handle the entities from the import file that already exist in the application.
• isDeleteUnref: boolean
  Enables you to remove the corresponding entity from OPC if it is not part of XML or XER file being imported.
• item(required): string
  Allowed Values: [ "CALENDAR", "ACTIVITY", "ACTIVITYCODE", "RELATIONSHIP", "RESOURCE", "ROLE", "WBS", "RISK" ]

  The project level entity which will be added to the application during import.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityProjectClobberConfigInput",
    "required":[
        "importOption",
        "item"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "item":{
            "type":"string",
            "description":"The project level entity which will be added to the application during import.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "CALENDAR",
                "ACTIVITY",
                "ACTIVITYCODE",
                "RELATIONSHIP",
                "RESOURCE",
                "ROLE",
                "WBS",
                "RISK"
            ]
        },
        "importOption":{
            "type":"string",
            "description":"The import action indicates how to handle the entities from the import file that already exist in the application.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "UPDATE_EXISTING",
                "KEEP_EXISTING",
                "IGNORE"
            ]
        },
        "isDeleteUnref":{
            "type":"boolean",
            "description":"Enables you to remove the corresponding entity from OPC if it is not part of XML or XER file being imported.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityWorkspaceClobberConfigInput

Type: object

Title: ApiEntityWorkspaceClobberConfigInput

Show Source

• importOption(required): string
  Allowed Values: [ "CREATE_NEW", "UPDATE_EXISTING", "KEEP_EXISTING", "IGNORE" ]

  The import action indicates how to handle the entities from the import file that already exist in the application.
• isDeleteUnref: boolean
  Enables you to remove the corresponding entity from OPC if it is not part of XML or XER file being imported.
• item(required): string
  Allowed Values: [ "CALENDAR", "CURVE", "RESOURCE", "ROLE", "UNITSOFMEASURE", "ACTIVITYUDF", "ASSIGNMENTUDF", "PROJECTUDF", "WBSUDF", "RISKUDF", "ACTIVITYCODE", "PROJECTCODE", "RESOURCECODE", "NOTEBOOKTOPIC" ]

  The workspace level entity which will be added to the application during import.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• promoteOption(required): string
  Allowed Values: [ "INSERT_NEW", "IGNORE", "FAIL_AND_ABORT", "NOT_APPLICABLE" ]

  Promote setting for multiple matching shared data items which are found in lower-level child workspace.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityWorkspaceClobberConfigInput",
    "required":[
        "importOption",
        "item",
        "promoteOption"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "item":{
            "type":"string",
            "description":"The workspace level entity which will be added to the application during import.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "CALENDAR",
                "CURVE",
                "RESOURCE",
                "ROLE",
                "UNITSOFMEASURE",
                "ACTIVITYUDF",
                "ASSIGNMENTUDF",
                "PROJECTUDF",
                "WBSUDF",
                "RISKUDF",
                "ACTIVITYCODE",
                "PROJECTCODE",
                "RESOURCECODE",
                "NOTEBOOKTOPIC"
            ]
        },
        "importOption":{
            "type":"string",
            "description":"The import action indicates how to handle the entities from the import file that already exist in the application.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "CREATE_NEW",
                "UPDATE_EXISTING",
                "KEEP_EXISTING",
                "IGNORE"
            ]
        },
        "isDeleteUnref":{
            "type":"boolean",
            "description":"Enables you to remove the corresponding entity from OPC if it is not part of XML or XER file being imported.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "promoteOption":{
            "type":"string",
            "description":"Promote setting for multiple matching shared data items which are found in lower-level child workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "INSERT_NEW",
                "IGNORE",
                "FAIL_AND_ABORT",
                "NOT_APPLICABLE"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityProjectInfoInput

Type: object

Title: ApiEntityProjectInfoInput

Show Source

• baselineProjectInfo: array baselineProjectInfo
  The baselines data of specific project. It is not available for XER.
• importInfo: importInfo
  The import information of specific project.
• importOption: string
  Maximum Length: 255

  Default Value: UPDATE_EXISTING

  The import action to be taken for each project in the XML or XER.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• projectCode(required): string
  Maximum Length: 60

  The user provided identifier of the project being imported through XML or XER.
• projectId: integer (int64)
  The system generated identifier of the project being imported through XML or XER.
• scenarioProjectInfo: array scenarioProjectInfo
  The scenario data of specific project.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityProjectInfoInput",
    "required":[
        "projectCode"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "baselineProjectInfo":{
            "type":"array",
            "description":"The baselines data of specific project. It is not available for XER.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityBaselineProjectInfoInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "scenarioProjectInfo":{
            "type":"array",
            "description":"The scenario data of specific project.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityBaselineProjectInfoInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "importInfo":{
            "description":"The import information of specific project.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityProjectImportInfoInput"
                }
            ]
        },
        "importOption":{
            "maxLength":255,
            "type":"string",
            "description":"The import action to be taken for each project in the XML or XER.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "default":"UPDATE_EXISTING"
        },
        "projectId":{
            "type":"integer",
            "description":"The system generated identifier of the project being imported through XML or XER.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":60,
            "type":"string",
            "description":"The user provided identifier of the project being imported through XML or XER.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : baselineProjectInfo

Type: array

The baselines data of specific project. It is not available for XER.

Show Source

• Array of: object ApiEntityBaselineProjectInfoInput
  Title: ApiEntityBaselineProjectInfoInput

{
    "type":"array",
    "description":"The baselines data of specific project. It is not available for XER.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityBaselineProjectInfoInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : importInfo

The import information of specific project.

Match All

The import information of specific project.

Show Source

• object ApiEntityProjectImportInfoInput
  Title: ApiEntityProjectImportInfoInput

{
    "description":"The import information of specific project.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityProjectImportInfoInput"
        }
    ]
}

Nested Schema : scenarioProjectInfo

Type: array

The scenario data of specific project.

Show Source

• Array of: object ApiEntityBaselineProjectInfoInput
  Title: ApiEntityBaselineProjectInfoInput

{
    "type":"array",
    "description":"The scenario data of specific project.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityBaselineProjectInfoInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityBaselineProjectInfoInput

Type: object

Title: ApiEntityBaselineProjectInfoInput

Show Source

• id: integer (int64)
  The system generated identifier of a baseline or scenario within a project.
• importInfo: importInfo
  The import information of specific baseline or scenario.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• name: string
  Maximum Length: 255

  The name of the baseline or scenario of a project.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityBaselineProjectInfoInput",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "name":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the baseline or scenario of a project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "id":{
            "type":"integer",
            "description":"The system generated identifier of a baseline or scenario within a project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "importInfo":{
            "description":"The import information of specific baseline or scenario.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityBaselineImportInfoInput"
                }
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : importInfo

The import information of specific baseline or scenario.

Match All

The import information of specific baseline or scenario.

Show Source

• object ApiEntityBaselineImportInfoInput
  Title: ApiEntityBaselineImportInfoInput

{
    "description":"The import information of specific baseline or scenario.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityBaselineImportInfoInput"
        }
    ]
}

Nested Schema : ApiEntityBaselineImportInfoInput

Type: object

Title: ApiEntityBaselineImportInfoInput

Show Source

• existingBaselineOrScenarioId: integer (int64)
  The system generated identifier of a baseline or scenario within a project.
• existingBaselineOrScenarioName: string
  The name of the baseline or scenario of a project.
• existingProjectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• existingProjectId: integer (int64)
  The unique identifier for the project.
• importType: string
  Allowed Values: [ "BASELINE", "SCENARIO", "PROJECT", "IGNORE" ]

  The import type indicates the target object type.
• importWithProject: boolean
  Flag to enable the import baseline or scenario along with project. Default value is 'true'.
• option: string
  Default Value: CREATE_NEW

  Allowed Values: [ "CREATE_NEW", "UPDATE_EXISTING", "KEEP_EXISTING", "IGNORE" ]

  The import action to be taken for each baseline or scenario in the XML or XER.
• updatedCodeOrName: string
  The name of the baseline or scenario of a project.

{
    "title":"ApiEntityBaselineImportInfoInput",
    "type":"object",
    "properties":{
        "importWithProject":{
            "type":"boolean",
            "description":"Flag to enable the import baseline or scenario along with project. Default value is 'true'.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "existingProjectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "existingBaselineOrScenarioId":{
            "type":"integer",
            "description":"The system generated identifier of a baseline or scenario within a project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "existingProjectCode":{
            "maxLength":60,
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updatedCodeOrName":{
            "type":"string",
            "description":"The name of the baseline or scenario of a project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "existingBaselineOrScenarioName":{
            "type":"string",
            "description":"The name of the baseline or scenario of a project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "importType":{
            "type":"string",
            "description":"The import type indicates the target object type.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "BASELINE",
                "SCENARIO",
                "PROJECT",
                "IGNORE"
            ]
        },
        "option":{
            "type":"string",
            "description":"The import action to be taken for each baseline or scenario in the XML or XER.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "default":"CREATE_NEW",
            "enum":[
                "CREATE_NEW",
                "UPDATE_EXISTING",
                "KEEP_EXISTING",
                "IGNORE"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityProjectImportInfoInput

Type: object

Title: ApiEntityProjectImportInfoInput

Show Source

• existingBaselineOrScenarioId: integer (int64)
  The system generated identifier of a baseline or scenario within a project.
• existingBaselineOrScenarioName: string
  The name of the baseline or scenario of a project.
• existingProjectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• existingProjectId: integer (int64)
  The unique identifier for the project.
• importType: string
  Allowed Values: [ "PROJECT", "BASELINE", "SCENARIO", "IGNORE" ]

  The import type indicates the target object type.
• option: string
  Default Value: CREATE_NEW

  Allowed Values: [ "CREATE_NEW", "UPDATE_EXISTING", "KEEP_EXISTING", "IGNORE" ]

  The import action to be taken for each project in the XML or XER.
• updatedCodeOrName: string
  The name of the baseline or scenario of a project.

{
    "title":"ApiEntityProjectImportInfoInput",
    "type":"object",
    "properties":{
        "existingProjectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "existingBaselineOrScenarioId":{
            "type":"integer",
            "description":"The system generated identifier of a baseline or scenario within a project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "existingProjectCode":{
            "maxLength":60,
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updatedCodeOrName":{
            "type":"string",
            "description":"The name of the baseline or scenario of a project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "existingBaselineOrScenarioName":{
            "type":"string",
            "description":"The name of the baseline or scenario of a project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "importType":{
            "type":"string",
            "description":"The import type indicates the target object type.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "PROJECT",
                "BASELINE",
                "SCENARIO",
                "IGNORE"
            ]
        },
        "option":{
            "type":"string",
            "description":"The import action to be taken for each project in the XML or XER.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "default":"CREATE_NEW",
            "enum":[
                "CREATE_NEW",
                "UPDATE_EXISTING",
                "KEEP_EXISTING",
                "IGNORE"
            ]
        }
    },
    "exampleSetFlag":false
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Successful operation

Body ()

Root Schema : ApiEntityJobDetail

Type: object

Title: ApiEntityJobDetail

Show Source

• jobId: integer (int64)
  The unique identifier for the background service.
• jobLog: string
  Maximum Length: 4000

  Log of the job.
• jobStatus: string
  Allowed Values: [ "NEW", "QUEUED", "RUNNING", "DELEGATED", "ON_HOLD", "REJECTED", "COMPLETED", "COMPLETED_WITH_ERRORS", "FAILED", "NOOP", "COMPLETED_WITH_WARNINGS", "RETRIED" ]

  The status of the background service.
• jobType: string
  Allowed Values: [ "MONTHLY", "DAILY", "FLEX_COLUMN_DELETE", "SCHEDULE_MONTE_CARLO", "SCHEDULE_MONTE_CARLO_LARGE", "SCHEDULE_MONTE_CARLO_EXPRESS", "SCHEDULE_MONTE_CARLO_ULTRALARGE", "GATEWAY_SYNC_JOB", "USER_DEFINED_REPORT", "LEVEL", "SCHEDULE_SCHEDULER", "APPLY_ACT_UNCERTAINTY", "RECALCULATE_SCHEDULE_COST", "STORE_PERIOD_PERFORMANCE", "SETUP_STORE_PERIOD_PERFORMANCE", "CALCULATE_PROJECT_SPREADS", "CALCULATE_ASSIGNMENT_SPREADS", "CALCULATE_ACTIVITY_SPREADS", "REPLACE_RESOURCES", "RUN_GLOBAL_CHANGE", "WORK_RATE_SYNC_TENANT", "WORK_RATE_SYNC_WORKSPACE", "RECALCULATE_COST", "RECALCULATE_PROJECTS_COST", "RECALCULATE_WORKSPACE_COST", "RECALCULATE_PROGRAM_COST", "CALCULATE_PROG_PROJ_COST_CURVE", "CREATE_SCENARIO", "IMPORT_FROM_P6", "P6_IMPORT_MIGRATION_JOB", "IMPORT_XER_FROM_P6", "IMPORT_FROM_P6_API", "IMPORT_XER_FROM_P6_API", "IMPORT_SCHEDULE_RECALCULATION", "EXPORT_TO_P6", "EXPORT_XER_TO_P6", "EXPORT_TO_MSP", "GATEWAY_SYNC_MASTER_DATA", "MEASURES_BY_PORTFOLIO_CALC", "MEASURE_BY_PERIOD_CALC", "MEASURES_BY_STRATEGY_CALC", "MEASURES_BY_PROJECT_CALC", "PROJECT_MEASURES_BY_WORKSPACE_CALC", "PROJECT_MEASURES_BY_PORTFOLIO_CALC", "PROGRAM_MEASURES_BY_WORKSPACE_CALC", "PROGRAM_MEASURES_BY_PORTFOLIO_CALC", "PROJECT_ACTUALS_EXCEL_IMPORT", "SCOPE_ASSIGNMENT_EXCEL_IMPORT", "FUND_EXCEL_IMPORT", "PORTFOLIO_FUND_EXCEL_IMPORT", "WORKSPACE_ROLE_EXCEL_IMPORT", "TASKS_EXCEL_IMPORT", "ASSIGN_RISK_MATRIX_TO_PROJECT", "RISKS_EXCEL_IMPORT", "RISK_IMPACT_RECALCULATION", "PROG_RISKS_EXCEL_IMPORT", "SYNC_ACTIVITY_BASED_RISK_DATA", "BUDGET_EXCEL_IMPORT", "PROG_BUDGET_EXCEL_IMPORT", "PROJECT_DELETE", "PORTFOLIO_AUTO_REFRESH", "RESOURCE_SCENARIO_APPROVAL", "RESOURCE_SCENARIO_DELETE", "RESOURCE_SCENARIO_PROPOSE", "WBS_EXCEL_IMPORT", "WBS_DELETE_WITH_ACTIVITIES_TASKS", "PROJECT_ACTIVITY_EXCEL_IMPORT", "RESOURCE_SCENARIO_COST_REFRESH", "PROJECT_DEMAND_COST_REFRESH", "PROJECT_CASHFLOW_RESOURCE_COST_REFRESH", "PROJECT_DEMAND_ASSIGNMENT_FETCH", "SUBMITTAL_EXCEL_IMPORT", "WORKSPACE_RESOURCE_EXCEL_IMPORT", "PROJECT_RESOURCE_EXCEL_IMPORT", "PROJECT_ROLE_EXCEL_IMPORT", "SUBJECT_AREA_REFRESH", "RECOMPUTE_STRATEGIC_ALIGN_SCORE", "PROJECT_SCHEDULE_HEALTH_UPGRADE", "RECALCULATE_SCHEDULE_HEALTH", "BUDGET_SCENARIO_APPROVAL", "COPY_WORKSPACE", "SET_ACTIVITY_SCENARIO", "MERGE_ACTIVITIES", "ACTIVITY_RESOURCE_SYNC", "PROJECT_EXCEL_IMPORT", "SCENARIO_EXCEL_IMPORT", "BUDGET_SCENARIO_OPTIMIZATION", "RESOURCE_SCENARIO_OPTIMIZATION", "USER_MIGRATION_EXPORT", "USER_MIGRATION_IMPORT", "GLOBAL_AUTH_MIGRATION_EXPORT", "GLOBAL_AUTH_MIGRATION_IMPORT", "CONFIG_MIGRATION_EXPORT", "CONFIG_MIGRATION_IMPORT", "RECALCULATE_TASK_SUMMARY_CHECK", "PROJECT_YEARLY_COSTS_EXCEL_IMPORT", "PROJECT_QUARTERLY_COSTS_EXCEL_IMPORT", "PROJECT_MONTHLY_COSTS_EXCEL_IMPORT", "PROGRAM_YEARLY_COSTS_EXCEL_IMPORT", "PROGRAM_QUARTERLY_COSTS_EXCEL_IMPORT", "PROGRAM_MONTHLY_COSTS_EXCEL_IMPORT", "RECALCULATE_FUNCTION", "RECALCULATE_FUNCTION_SEGMENT", "RECALCULATE_FUNCTION_SEGMENT_OVERLAY", "RECALCULATE_FUNCTIONS_FOR_SCHEDULER", "RECALCULATE_FUNCTIONS_FOR_EXCEL_IMPORT", "MIGRATE_TENANT_TO_LOBBY", "RENUMBER_ACTIVITY", "PC_MIGRATION", "COMPANY_MIGRATION_EXPORT", "COMPANY_MIGRATION_IMPORT", "CUSTOM_LOG_EXCEL_IMPORT", "PORTFOLIO_PRIORITIZATION_MATRIX_EXCEL_IMPORT", "WEATHER_MONTE_CARLO", "PROGRAM_DELETE", "PROGRAM_PROJECT_FILTER", "PROGRAM_EXCEL_IMPORT", "PROJECT_MOVE", "PROGRAM_SECURITY_SYNC", "IDEA_SECURITY_SYNC", "IDEA_SECURITY_MIGRATION", "IDEA_USERLINK_MIGRATION", "WORKSPACE_DELETE", "WORKSPACE_HARD_DELETE", "WORKSPACE_MOVE", "CASHFLOW_MIGRATION", "CBS_SYNC", "EVALUATION_REFRESH", "SCHEDULE_COMPARISON_EXPORT", "PROJECT_MOVE_RECALCULATE_FUNCTION", "PROJECT_MOVE_RECALCULATE_FUNCTION_SEGMENT", "PROJECT_MOVE_RECALCULATE_FUNCTION_SEGMENT_OVERLAY", "WORKSPACE_EXCHANGE_RATE_REFRESH", "TASK_COPY_PASTE_WITH_HANDOFF", "EXPORT_SPREAD_TO_EXCEL", "SCENARIO_LINK_ALL", "P6_IMPORT_MIGRATION_RECALCULATE_FUNCTION_JOB", "SCENARIO_LINK_ALL_SEGMENT", "EXTRACT_CASHFLOW_DATA" ]

  The type of a job.
• lastCompletionDate: string (date-time)
  The date the background service was last performed.
• lastStartDate: string (date-time)
  The date and time the last job was executed.

{
    "title":"ApiEntityJobDetail",
    "type":"object",
    "properties":{
        "lastCompletionDate":{
            "type":"string",
            "description":"The date the background service was last performed.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "jobType":{
            "type":"string",
            "description":"The type of a job.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "MONTHLY",
                "DAILY",
                "FLEX_COLUMN_DELETE",
                "SCHEDULE_MONTE_CARLO",
                "SCHEDULE_MONTE_CARLO_LARGE",
                "SCHEDULE_MONTE_CARLO_EXPRESS",
                "SCHEDULE_MONTE_CARLO_ULTRALARGE",
                "GATEWAY_SYNC_JOB",
                "USER_DEFINED_REPORT",
                "LEVEL",
                "SCHEDULE_SCHEDULER",
                "APPLY_ACT_UNCERTAINTY",
                "RECALCULATE_SCHEDULE_COST",
                "STORE_PERIOD_PERFORMANCE",
                "SETUP_STORE_PERIOD_PERFORMANCE",
                "CALCULATE_PROJECT_SPREADS",
                "CALCULATE_ASSIGNMENT_SPREADS",
                "CALCULATE_ACTIVITY_SPREADS",
                "REPLACE_RESOURCES",
                "RUN_GLOBAL_CHANGE",
                "WORK_RATE_SYNC_TENANT",
                "WORK_RATE_SYNC_WORKSPACE",
                "RECALCULATE_COST",
                "RECALCULATE_PROJECTS_COST",
                "RECALCULATE_WORKSPACE_COST",
                "RECALCULATE_PROGRAM_COST",
                "CALCULATE_PROG_PROJ_COST_CURVE",
                "CREATE_SCENARIO",
                "IMPORT_FROM_P6",
                "P6_IMPORT_MIGRATION_JOB",
                "IMPORT_XER_FROM_P6",
                "IMPORT_FROM_P6_API",
                "IMPORT_XER_FROM_P6_API",
                "IMPORT_SCHEDULE_RECALCULATION",
                "EXPORT_TO_P6",
                "EXPORT_XER_TO_P6",
                "EXPORT_TO_MSP",
                "GATEWAY_SYNC_MASTER_DATA",
                "MEASURES_BY_PORTFOLIO_CALC",
                "MEASURE_BY_PERIOD_CALC",
                "MEASURES_BY_STRATEGY_CALC",
                "MEASURES_BY_PROJECT_CALC",
                "PROJECT_MEASURES_BY_WORKSPACE_CALC",
                "PROJECT_MEASURES_BY_PORTFOLIO_CALC",
                "PROGRAM_MEASURES_BY_WORKSPACE_CALC",
                "PROGRAM_MEASURES_BY_PORTFOLIO_CALC",
                "PROJECT_ACTUALS_EXCEL_IMPORT",
                "SCOPE_ASSIGNMENT_EXCEL_IMPORT",
                "FUND_EXCEL_IMPORT",
                "PORTFOLIO_FUND_EXCEL_IMPORT",
                "WORKSPACE_ROLE_EXCEL_IMPORT",
                "TASKS_EXCEL_IMPORT",
                "ASSIGN_RISK_MATRIX_TO_PROJECT",
                "RISKS_EXCEL_IMPORT",
                "RISK_IMPACT_RECALCULATION",
                "PROG_RISKS_EXCEL_IMPORT",
                "SYNC_ACTIVITY_BASED_RISK_DATA",
                "BUDGET_EXCEL_IMPORT",
                "PROG_BUDGET_EXCEL_IMPORT",
                "PROJECT_DELETE",
                "PORTFOLIO_AUTO_REFRESH",
                "RESOURCE_SCENARIO_APPROVAL",
                "RESOURCE_SCENARIO_DELETE",
                "RESOURCE_SCENARIO_PROPOSE",
                "WBS_EXCEL_IMPORT",
                "WBS_DELETE_WITH_ACTIVITIES_TASKS",
                "PROJECT_ACTIVITY_EXCEL_IMPORT",
                "RESOURCE_SCENARIO_COST_REFRESH",
                "PROJECT_DEMAND_COST_REFRESH",
                "PROJECT_CASHFLOW_RESOURCE_COST_REFRESH",
                "PROJECT_DEMAND_ASSIGNMENT_FETCH",
                "SUBMITTAL_EXCEL_IMPORT",
                "WORKSPACE_RESOURCE_EXCEL_IMPORT",
                "PROJECT_RESOURCE_EXCEL_IMPORT",
                "PROJECT_ROLE_EXCEL_IMPORT",
                "SUBJECT_AREA_REFRESH",
                "RECOMPUTE_STRATEGIC_ALIGN_SCORE",
                "PROJECT_SCHEDULE_HEALTH_UPGRADE",
                "RECALCULATE_SCHEDULE_HEALTH",
                "BUDGET_SCENARIO_APPROVAL",
                "COPY_WORKSPACE",
                "SET_ACTIVITY_SCENARIO",
                "MERGE_ACTIVITIES",
                "ACTIVITY_RESOURCE_SYNC",
                "PROJECT_EXCEL_IMPORT",
                "SCENARIO_EXCEL_IMPORT",
                "BUDGET_SCENARIO_OPTIMIZATION",
                "RESOURCE_SCENARIO_OPTIMIZATION",
                "USER_MIGRATION_EXPORT",
                "USER_MIGRATION_IMPORT",
                "GLOBAL_AUTH_MIGRATION_EXPORT",
                "GLOBAL_AUTH_MIGRATION_IMPORT",
                "CONFIG_MIGRATION_EXPORT",
                "CONFIG_MIGRATION_IMPORT",
                "RECALCULATE_TASK_SUMMARY_CHECK",
                "PROJECT_YEARLY_COSTS_EXCEL_IMPORT",
                "PROJECT_QUARTERLY_COSTS_EXCEL_IMPORT",
                "PROJECT_MONTHLY_COSTS_EXCEL_IMPORT",
                "PROGRAM_YEARLY_COSTS_EXCEL_IMPORT",
                "PROGRAM_QUARTERLY_COSTS_EXCEL_IMPORT",
                "PROGRAM_MONTHLY_COSTS_EXCEL_IMPORT",
                "RECALCULATE_FUNCTION",
                "RECALCULATE_FUNCTION_SEGMENT",
                "RECALCULATE_FUNCTION_SEGMENT_OVERLAY",
                "RECALCULATE_FUNCTIONS_FOR_SCHEDULER",
                "RECALCULATE_FUNCTIONS_FOR_EXCEL_IMPORT",
                "MIGRATE_TENANT_TO_LOBBY",
                "RENUMBER_ACTIVITY",
                "PC_MIGRATION",
                "COMPANY_MIGRATION_EXPORT",
                "COMPANY_MIGRATION_IMPORT",
                "CUSTOM_LOG_EXCEL_IMPORT",
                "PORTFOLIO_PRIORITIZATION_MATRIX_EXCEL_IMPORT",
                "WEATHER_MONTE_CARLO",
                "PROGRAM_DELETE",
                "PROGRAM_PROJECT_FILTER",
                "PROGRAM_EXCEL_IMPORT",
                "PROJECT_MOVE",
                "PROGRAM_SECURITY_SYNC",
                "IDEA_SECURITY_SYNC",
                "IDEA_SECURITY_MIGRATION",
                "IDEA_USERLINK_MIGRATION",
                "WORKSPACE_DELETE",
                "WORKSPACE_HARD_DELETE",
                "WORKSPACE_MOVE",
                "CASHFLOW_MIGRATION",
                "CBS_SYNC",
                "EVALUATION_REFRESH",
                "SCHEDULE_COMPARISON_EXPORT",
                "PROJECT_MOVE_RECALCULATE_FUNCTION",
                "PROJECT_MOVE_RECALCULATE_FUNCTION_SEGMENT",
                "PROJECT_MOVE_RECALCULATE_FUNCTION_SEGMENT_OVERLAY",
                "WORKSPACE_EXCHANGE_RATE_REFRESH",
                "TASK_COPY_PASTE_WITH_HANDOFF",
                "EXPORT_SPREAD_TO_EXCEL",
                "SCENARIO_LINK_ALL",
                "P6_IMPORT_MIGRATION_RECALCULATE_FUNCTION_JOB",
                "SCENARIO_LINK_ALL_SEGMENT",
                "EXTRACT_CASHFLOW_DATA"
            ]
        },
        "jobLog":{
            "maxLength":4000,
            "type":"string",
            "description":"Log of the job.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "jobId":{
            "type":"integer",
            "description":"The unique identifier for the background service.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "lastStartDate":{
            "type":"string",
            "description":"The date and time the last job was executed.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "jobStatus":{
            "type":"string",
            "description":"The status of the background service.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "NEW",
                "QUEUED",
                "RUNNING",
                "DELEGATED",
                "ON_HOLD",
                "REJECTED",
                "COMPLETED",
                "COMPLETED_WITH_ERRORS",
                "FAILED",
                "NOOP",
                "COMPLETED_WITH_WARNINGS",
                "RETRIED"
            ]
        }
    },
    "exampleSetFlag":false
}

400 Response

Invalid input for the Action service.

Back to Top