Jump to

• Request
• Response

Create a Scope Item Assignment Activity

post

/api/restapi/scopeItemAssignmentActivity

Send a request to this endpoint to create a scope item assignment.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ApiEntityScopeItemAssignmentActivityInput

Type: object

Title: ApiEntityScopeItemAssignmentActivityInput

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

• scopeItemAssignmentActivityId
• activityId,scopeItemAssignmentId
• activityId,projectCode,workspaceCode,scopeItemCode,workPackageCode,scopeItemAssignmentCode
• activityCode,projectCode,workspaceCode,scopeItemCode,workPackageCode,scopeItemAssignmentCode

Show Source

• activityCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of the activity.
• activityId(required): integer (int64)
  The system-generated identifier of an activity.
• link: string (url)
  Read Only: true

  Deprecated. As of 24.5.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• manualWeight: number (double)
  Calculated as Scope Percent Complete multiplied by Manual Weight.
• manualWeightFactor: number (double)
  The value used to calculate manual completed weight when progress needs to be weighted against a factor other than quantity, hours, or cost.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• scopeItemAssignmentActivityId: integer (int64)
  The system-generated identifier of an activity. This value should not be provided in create operation request data, however, it is required for update requests.
• scopeItemAssignmentCode: string
  Minimum Length: 1

  Maximum Length: 60

  The user-specified unique identifier for the scope assignment.
• scopeItemAssignmentId(required): integer (int64)
  The unique identifier of the scope assignment that is linked to the activity.
• scopeItemCode: string
  Minimum Length: 1

  Maximum Length: 60

  The user-specified unique identifier for the scope item.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 24.5.
  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":"ApiEntityScopeItemAssignmentActivityInput",
    "required":[
        "activityId",
        "scopeItemAssignmentId"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.5</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.5</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "activityCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of the activity.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "activityId":{
            "type":"integer",
            "description":"The system-generated identifier of an activity.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scopeItemAssignmentId":{
            "type":"integer",
            "description":"The unique identifier of the scope assignment that is linked to the activity.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scopeItemCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified unique identifier for the scope item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "scopeItemAssignmentCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified unique identifier for the scope assignment.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "manualWeightFactor":{
            "type":"number",
            "description":"The value used to calculate manual completed weight when progress needs to be weighted against a factor other than quantity, hours, or cost.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "manualWeight":{
            "type":"number",
            "description":"Calculated as Scope Percent Complete multiplied by Manual Weight.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "scopeItemAssignmentActivityId":{
            "type":"integer",
            "description":"The system-generated identifier of an activity. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "description":"This entity represents a ScopeItemAssignmentActivity object, a unique ScopeItemAssignmentActivity object can be identified by the following combinations of the fields.<ul><li>scopeItemAssignmentActivityId</li><li>activityId,scopeItemAssignmentId</li><li>activityId,projectCode,workspaceCode,scopeItemCode,workPackageCode,scopeItemAssignmentCode</li><li>activityCode,projectCode,workspaceCode,scopeItemCode,workPackageCode,scopeItemAssignmentCode</li>",
    "exampleSetFlag":false
}

Examples

Select an example Create a Scope Item Assignment Activity

Back to Top

Response

Supported Media Types

• application/json

201 Response

The object was successfully created.

Body ()

Root Schema : ApiEntityScopeItemAssignmentActivity

Type: object

Title: ApiEntityScopeItemAssignmentActivity

Show Source

• activityCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of the activity.
• activityId: integer (int64)
  The system-generated identifier of an activity.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• manualWeight: number (double)
  Calculated as Scope Percent Complete multiplied by Manual Weight.
• manualWeightFactor: number (double)
  The value used to calculate manual completed weight when progress needs to be weighted against a factor other than quantity, hours, or cost.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• scopeItemAssignmentActivityId: integer (int64)
  The system-generated identifier of an activity. This value should not be provided in create operation request data, however, it is required for update requests.
• scopeItemAssignmentCode: string
  Minimum Length: 1

  Maximum Length: 60

  The user-specified unique identifier for the scope assignment.
• scopeItemAssignmentId: integer (int64)
  The unique identifier of the scope assignment that is linked to the activity.
• scopeItemCode: string
  Minimum Length: 1

  Maximum Length: 60

  The user-specified unique identifier for the scope item.
• 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":"ApiEntityScopeItemAssignmentActivity",
    "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"
            ]
        },
        "activityCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of the activity.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "activityId":{
            "type":"integer",
            "description":"The system-generated identifier of an activity.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scopeItemAssignmentId":{
            "type":"integer",
            "description":"The unique identifier of the scope assignment that is linked to the activity.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scopeItemCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified unique identifier for the scope item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "scopeItemAssignmentCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified unique identifier for the scope assignment.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "manualWeightFactor":{
            "type":"number",
            "description":"The value used to calculate manual completed weight when progress needs to be weighted against a factor other than quantity, hours, or cost.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "manualWeight":{
            "type":"number",
            "description":"Calculated as Scope Percent Complete multiplied by Manual Weight.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "scopeItemAssignmentActivityId":{
            "type":"integer",
            "description":"The system-generated identifier of an activity. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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