Jump to

• Request
• Response

Batch Create Scope Assignment Planned Time Phased Data

post

/api/restapi/plannedTimePhasedData/batch

Creates a scopeAssignment planned time phased data.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : List<ApiEntityScopeAssignmentPlannedTimePhasedDataInput>

Type: array

Title: List<ApiEntityScopeAssignmentPlannedTimePhasedDataInput>

Show Source

• Array of: object ApiEntityScopeAssignmentPlannedTimePhasedDataInput
  Title: ApiEntityScopeAssignmentPlannedTimePhasedDataInput

  This entity represents a ScopeAssignmentPlannedTimePhasedData object, a unique ScopeAssignmentPlannedTimePhasedData object can be identified by the following combinations of the fields.

  • scopeAssignmentPlannedTimePhasedDataId

{
    "title":"List<ApiEntityScopeAssignmentPlannedTimePhasedDataInput>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityScopeAssignmentPlannedTimePhasedDataInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityScopeAssignmentPlannedTimePhasedDataInput

Type: object

Title: ApiEntityScopeAssignmentPlannedTimePhasedDataInput

This entity represents a ScopeAssignmentPlannedTimePhasedData object, a unique ScopeAssignmentPlannedTimePhasedData object can be identified by the following combinations of the fields.

• scopeAssignmentPlannedTimePhasedDataId

Show Source

• date(required): string (date-time)
  Date used for updating the dates of scope assignments and work packages when they are not linked to activities.
• plannedHours(required): number (double)
  Expected hours needed to complete all the work on a scope item.
• plannedUnits(required): number (double)
  Expected amount of material or product required for a scope item.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• scopeAssignmentPlannedTimePhasedCostData: scopeAssignmentPlannedTimePhasedCostData
  An object containing the cost fields associated with the planned time phased data.
• scopeAssignmentPlannedTimePhasedDataId: integer (int64)
  The unique identifier of scope assignment plan data. This value should not be provided in create operation request data, however, it is required for update requests.
• scopeItemAssignCode: string
  Minimum Length: 1

  Maximum Length: 60

  The user-specified unique identifier for the scope assignment.
• scopeItemAssignmentId(required): integer (int64)
  The unique identifier of a work package.
• workPackageCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for the work package.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityScopeAssignmentPlannedTimePhasedDataInput",
    "required":[
        "date",
        "plannedHours",
        "plannedUnits",
        "scopeItemAssignmentId"
    ],
    "type":"object",
    "properties":{
        "date":{
            "type":"string",
            "description":"Date used for updating the dates of scope assignments and work packages when they are not linked to activities.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "scopeAssignmentPlannedTimePhasedDataId":{
            "type":"integer",
            "description":"The unique identifier of scope assignment plan data. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scopeAssignmentPlannedTimePhasedCostData":{
            "description":"An object containing the cost fields associated with the planned time phased data.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityScopeAssignmentPlannedTimePhasedCostDataInput"
                }
            ]
        },
        "scopeItemAssignCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The user-specified unique identifier for the scope assignment.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "scopeItemAssignmentId":{
            "type":"integer",
            "description":"The unique identifier of a work package.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "plannedUnits":{
            "type":"number",
            "description":"Expected amount of material or product required for a scope item.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedHours":{
            "type":"number",
            "description":"Expected hours needed to complete all the work on a scope item.",
            "format":"double",
            "exampleSetFlag":false
        },
        "projectCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workPackageCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The unique identifier for the work package.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a ScopeAssignmentPlannedTimePhasedData object, a unique ScopeAssignmentPlannedTimePhasedData object can be identified by the following combinations of the fields.<ul><li>scopeAssignmentPlannedTimePhasedDataId</li>",
    "exampleSetFlag":false
}

Nested Schema : scopeAssignmentPlannedTimePhasedCostData

An object containing the cost fields associated with the planned time phased data.

Match All

An object containing the cost fields associated with the planned time phased data.

Show Source

• object ApiEntityScopeAssignmentPlannedTimePhasedCostDataInput
  Title: ApiEntityScopeAssignmentPlannedTimePhasedCostDataInput

{
    "description":"An object containing the cost fields associated with the planned time phased data.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityScopeAssignmentPlannedTimePhasedCostDataInput"
        }
    ]
}

Nested Schema : ApiEntityScopeAssignmentPlannedTimePhasedCostDataInput

Type: object

Title: ApiEntityScopeAssignmentPlannedTimePhasedCostDataInput

Show Source

• plannedCost(required): number (double)
  Original cost for the scope item. This field is in base currency and is calculated from plannedCostProject field based on the specified exchange rate.
• plannedCostProject: number (double)
  Original cost for the project scope item. This value is based on the project currency.
• scopeAssignmentPlannedTimePhasedDataId(required): integer (int64)
  The unique identifier of scope item planned cost data.

{
    "title":"ApiEntityScopeAssignmentPlannedTimePhasedCostDataInput",
    "required":[
        "plannedCost",
        "scopeAssignmentPlannedTimePhasedDataId"
    ],
    "type":"object",
    "properties":{
        "plannedCostProject":{
            "type":"number",
            "description":"Original cost for the project scope item. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "scopeAssignmentPlannedTimePhasedDataId":{
            "type":"integer",
            "description":"The unique identifier of scope item planned cost data.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "plannedCost":{
            "type":"number",
            "description":"Original cost for the scope item. This field is in base currency and is calculated from plannedCostProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        }
    },
    "exampleSetFlag":false
}

Examples

Select an example Batch Create Scope Assignment Original Time Phased Data

Back to Top

Response

Supported Media Types

• application/json

201 Response

The object was successfully created.

Body ()

Root Schema : List<ApiEntityScopeAssignmentPlannedTimePhasedData>

Type: array

Title: List<ApiEntityScopeAssignmentPlannedTimePhasedData>

Show Source

• Array of: object ApiEntityScopeAssignmentPlannedTimePhasedData
  Title: ApiEntityScopeAssignmentPlannedTimePhasedData

{
    "title":"List<ApiEntityScopeAssignmentPlannedTimePhasedData>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityScopeAssignmentPlannedTimePhasedData",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityScopeAssignmentPlannedTimePhasedData

Type: object

Title: ApiEntityScopeAssignmentPlannedTimePhasedData

Show Source

• date: string (date-time)
  Date used for updating the dates of scope assignments and work packages when they are not linked to activities.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• plannedHours: number (double)
  Expected hours needed to complete all the work on a scope item.
• plannedUnits: number (double)
  Expected amount of material or product required for a scope item.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• scopeAssignmentPlannedTimePhasedCostData: scopeAssignmentPlannedTimePhasedCostData
  An object containing the cost fields associated with the planned time phased data.
• scopeAssignmentPlannedTimePhasedDataId: integer (int64)
  The unique identifier of scope assignment plan data. This value should not be provided in create operation request data, however, it is required for update requests.
• scopeItemAssignCode: string
  Minimum Length: 1

  Maximum Length: 60

  The user-specified unique identifier for the scope assignment.
• scopeItemAssignmentId: integer (int64)
  The unique identifier of a work package.
• updateDate: string (date-time)
  Date when the record was last updated.
• workPackageCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for the work package.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityScopeAssignmentPlannedTimePhasedData",
    "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"
            ]
        },
        "date":{
            "type":"string",
            "description":"Date used for updating the dates of scope assignments and work packages when they are not linked to activities.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "scopeAssignmentPlannedTimePhasedDataId":{
            "type":"integer",
            "description":"The unique identifier of scope assignment plan data. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scopeAssignmentPlannedTimePhasedCostData":{
            "description":"An object containing the cost fields associated with the planned time phased data.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityScopeAssignmentPlannedTimePhasedCostData"
                }
            ]
        },
        "scopeItemAssignCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The user-specified unique identifier for the scope assignment.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "scopeItemAssignmentId":{
            "type":"integer",
            "description":"The unique identifier of a work package.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "plannedUnits":{
            "type":"number",
            "description":"Expected amount of material or product required for a scope item.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedHours":{
            "type":"number",
            "description":"Expected hours needed to complete all the work on a scope item.",
            "format":"double",
            "exampleSetFlag":false
        },
        "projectCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workPackageCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The unique identifier for the work package.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "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 : scopeAssignmentPlannedTimePhasedCostData

An object containing the cost fields associated with the planned time phased data.

Match All

An object containing the cost fields associated with the planned time phased data.

Show Source

• object ApiEntityScopeAssignmentPlannedTimePhasedCostData
  Title: ApiEntityScopeAssignmentPlannedTimePhasedCostData

{
    "description":"An object containing the cost fields associated with the planned time phased data.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityScopeAssignmentPlannedTimePhasedCostData"
        }
    ]
}

Nested Schema : ApiEntityScopeAssignmentPlannedTimePhasedCostData

Type: object

Title: ApiEntityScopeAssignmentPlannedTimePhasedCostData

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.
• plannedCost: number (double)
  Original cost for the scope item. This field is in base currency and is calculated from plannedCostProject field based on the specified exchange rate.
• plannedCostProject: number (double)
  Original cost for the project scope item. This value is based on the project currency.
• scopeAssignmentPlannedTimePhasedDataId: integer (int64)
  The unique identifier of scope item planned cost data.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityScopeAssignmentPlannedTimePhasedCostData",
    "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"
            ]
        },
        "plannedCostProject":{
            "type":"number",
            "description":"Original cost for the project scope item. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "scopeAssignmentPlannedTimePhasedDataId":{
            "type":"integer",
            "description":"The unique identifier of scope item planned cost data.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "plannedCost":{
            "type":"number",
            "description":"Original cost for the scope item. This field is in base currency and is calculated from plannedCostProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

400 Response

Invalid input.

Back to Top