Jump to

• Request
• Response

Import a WBS from Project

post

/api/restapi/action/importWBS

Send a request to this endpoint to import a WBS from a project or project template.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ApiEntityWBSImportInput

Type: object

Title: ApiEntityWBSImportInput

Show Source

• copyOptions: array copyOptions
  The list of objects to be copied from the source WBS to the target WBS.
  ACTIVITIES must be selected to copy other objects associated with the WBS. If ACTIVITIES is not selected, then only the WBS will be copied.
  TASKS must be selected to copy TASK_HANDOFFS. If TASKS and ACTIVITIES are not selected along with TASK_HANDOFFS, the TASK_HANDOFFS will not be copied.
  Allowed Values : [ "ACTIVITIES", "PROJECT_CODES", "WORKSPACE_CODES", "CONFIGURED_FIELDS", "RELATIONSHIPS", "ASSIGNMENTS", "TASKS", "TASK_HANDOFFS"].
• sourceWBS: sourceWBS
  The identifier for the source WBS.
• targetWBS: targetWBS
  The identifier for the target WBS.

{
    "title":"ApiEntityWBSImportInput",
    "type":"object",
    "properties":{
        "sourceWBS":{
            "description":"The identifier for the source WBS.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityWBSImportIdentifierInput"
                }
            ]
        },
        "targetWBS":{
            "description":"The identifier for the target WBS.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityWBSImportIdentifierInput"
                }
            ]
        },
        "copyOptions":{
            "type":"array",
            "description":"The list of objects to be copied from the source WBS to the target WBS. <br />ACTIVITIES must be selected to copy other objects associated with the WBS. If ACTIVITIES is not selected, then only the WBS will be copied.  <br />TASKS must be selected to copy TASK_HANDOFFS. If TASKS and ACTIVITIES are not selected along with TASK_HANDOFFS, the TASK_HANDOFFS will not be copied.<br /> Allowed Values : [ \"ACTIVITIES\", \"PROJECT_CODES\", \"WORKSPACE_CODES\", \"CONFIGURED_FIELDS\", \"RELATIONSHIPS\", \"ASSIGNMENTS\", \"TASKS\", \"TASK_HANDOFFS\"].",
            "exampleSetFlag":false,
            "items":{
                "type":"string",
                "exampleSetFlag":false,
                "types":[
                    "string"
                ]
            },
            "types":[
                "array"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : copyOptions

Type: array

The list of objects to be copied from the source WBS to the target WBS.
ACTIVITIES must be selected to copy other objects associated with the WBS. If ACTIVITIES is not selected, then only the WBS will be copied.
TASKS must be selected to copy TASK_HANDOFFS. If TASKS and ACTIVITIES are not selected along with TASK_HANDOFFS, the TASK_HANDOFFS will not be copied.
Allowed Values : [ "ACTIVITIES", "PROJECT_CODES", "WORKSPACE_CODES", "CONFIGURED_FIELDS", "RELATIONSHIPS", "ASSIGNMENTS", "TASKS", "TASK_HANDOFFS"].

Show Source

• Array of: string

{
    "type":"array",
    "description":"The list of objects to be copied from the source WBS to the target WBS. <br />ACTIVITIES must be selected to copy other objects associated with the WBS. If ACTIVITIES is not selected, then only the WBS will be copied.  <br />TASKS must be selected to copy TASK_HANDOFFS. If TASKS and ACTIVITIES are not selected along with TASK_HANDOFFS, the TASK_HANDOFFS will not be copied.<br /> Allowed Values : [ \"ACTIVITIES\", \"PROJECT_CODES\", \"WORKSPACE_CODES\", \"CONFIGURED_FIELDS\", \"RELATIONSHIPS\", \"ASSIGNMENTS\", \"TASKS\", \"TASK_HANDOFFS\"].",
    "exampleSetFlag":false,
    "items":{
        "type":"string",
        "exampleSetFlag":false,
        "types":[
            "string"
        ]
    },
    "types":[
        "array"
    ]
}

Nested Schema : sourceWBS

The identifier for the source WBS.

Match All

Show Source

• object ApiEntityWBSImportIdentifierInput
  Title: ApiEntityWBSImportIdentifierInput

{
    "description":"The identifier for the source WBS.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityWBSImportIdentifierInput"
        }
    ]
}

Nested Schema : targetWBS

The identifier for the target WBS.

Match All

Show Source

• object ApiEntityWBSImportIdentifierInput
  Title: ApiEntityWBSImportIdentifierInput

{
    "description":"The identifier for the target WBS.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityWBSImportIdentifierInput"
        }
    ]
}

Nested Schema : ApiEntityWBSImportIdentifierInput

Type: object

Title: ApiEntityWBSImportIdentifierInput

Show Source

• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.The project object can also be identified by its unique criteria.
• wbsId: integer (int64)
  Unique identifier of the WBS.
• wbsPath: string
  Maximum Length: 4000

  The complete path to the WBS. This is the hierarchy path from the Project Code to the WBS. It is based on the following pattern: <ProjectCode>.<WSBCode>.<WSBCode>...<WBSCode>. For example, for a project with code 'P1' having the WBS hierarchy as 'WBS1', 'WBS2', and 'WBS3', the wbsPath for 'WBS3' will be defined as 'P1.WBS1.WBS2.WBS3'.
• workspaceCode: string
  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityWBSImportIdentifierInput",
    "type":"object",
    "properties":{
        "wbsPath":{
            "maxLength":"4000",
            "type":"string",
            "description":"The complete path to the WBS. This is the hierarchy path from the Project Code to the WBS. It is based on the following pattern: <ProjectCode>.<WSBCode>.<WSBCode>...<WBSCode>. For example, for a project with code 'P1' having the WBS hierarchy as 'WBS1', 'WBS2', and 'WBS3', the wbsPath for 'WBS3' will be defined as 'P1.WBS1.WBS2.WBS3'.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "wbsId":{
            "type":"integer",
            "description":"Unique identifier of the WBS.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Examples

Select an example Import a WBS from Project

Back to Top

Response

Supported Media Types

• application/json

201 Response

The object was successfully created.

Body ()

Root Schema : ApiEntityWBSImportResponse

Type: object

Title: ApiEntityWBSImportResponse

Show Source

• sourceProjectId: integer (int64)
  The system-generated unique identifier for the project under which the source WBS is present.
• sourceProjectName: string
  Maximum Length: 255

  The name of the project under which the source WBS is present.
• sourceWBSId: integer (int64)
  The system-generated unique identifier for the source WBS.
• sourceWBSName: string
  Maximum Length: 255

  The name of the source WBS.
• targetProjectId: integer (int64)
  The system-generated unique identifier for the project under which the target WBS is present.
• targetProjectName: string
  Maximum Length: 255

  The name of the project under which the target WBS is present.
• targetWBSId: integer (int64)
  The system-generated unique identifier for the target WBS.
• targetWBSName: string
  Maximum Length: 255

  The name of the target WBS.
• warningMessage: string
  The message generated when the import request did not complete in the allocated time and continues to run in the background. The field is non-persistable and thus maximum length is not applicable.

{
    "title":"ApiEntityWBSImportResponse",
    "type":"object",
    "properties":{
        "sourceWBSId":{
            "type":"integer",
            "description":"The system-generated unique identifier for the source WBS.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "sourceWBSName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the source WBS.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "targetWBSId":{
            "type":"integer",
            "description":"The system-generated unique identifier for the target WBS.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "targetWBSName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the target WBS.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "targetProjectName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the project under which the target WBS is present.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "targetProjectId":{
            "type":"integer",
            "description":"The system-generated unique identifier for the project under which the target WBS is present.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "warningMessage":{
            "type":"string",
            "description":"The message generated when the import request did not complete in the allocated time and continues to run in the background. The field is non-persistable and thus maximum length is not applicable.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "sourceProjectName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the project under which the source WBS is present.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "sourceProjectId":{
            "type":"integer",
            "description":"The system-generated unique identifier for the project under which the source WBS is present.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

400 Response

Invalid input for the Action service.

Back to Top