Create Scope Item Assignment Transfer Requests
post
/primeapi/restapi/scopeItemAssignmentTransferRequest/batch
Send a request to this endpoint to create one or more scope item assignment transfer requests.
Request
Supported Media Types
- application/json
A scope item assignment transfer request object.S
Root Schema : List<ApiEntityScopeItemAssignmentTransferRequest>
Type:
array
Title:
Show Source
List<ApiEntityScopeItemAssignmentTransferRequest>
Nested Schema : ApiEntityScopeItemAssignmentTransferRequest
Type:
Show Source
object
-
changeRequestId(optional):
integer(int64)
The unique identifier for a work package change when a work package is transferred.
-
costImpact(optional):
boolean
Indicates whether the transfer will impact the cost of the work package.
-
description(optional):
string
Details supporting the transfer request.
-
finishDate(optional):
string(date-time)
The date the transfer will no longer take effect.
-
itemCode(optional):
string
The identifier for the work package change when a work package is transferred.
-
itemPrefix(optional):
string
The auto numbering prefix of a code.
-
itemSuffix(optional):
integer(int64)
The auto numbering suffix of a code.
-
link(optional):
string(url)
Read Only:
true
-
parentScopeItemAssignmentTransferRequestId(optional):
integer(int64)
The transfer item that is part of a source transfer group.
-
scheduleImpact(optional):
boolean
Indicates whether the change will impact the schedule of the work package.
-
scopeItemAssignmentId(optional):
integer(int64)
The unique identifier of a work package.
-
scopeItemAssignmentTransferRequestId(optional):
integer(int64)
The unique identifier of a work package transfer.
-
startDate(optional):
string(date-time)
The date the transfer will start to take effect.
-
status(optional):
string
Allowed Values:
[ "PENDING", "APPROVED", "REJECTED" ]
The state of the scope assignment transfer request.
Pending: The change request is awaiting a decision.
Approved: The change request was approved.
Rejected: The change request was not approved. -
transferCost(optional):
object Cost
-
transferCostProject(optional):
object Cost
-
transferHours(optional):
object Hour
-
transferUnits(optional):
object Quantity
-
type(optional):
string
Allowed Values:
[ "NEW", "QUANTITY", "HOURS" ]
The type of transfer to be made on the scope assignment.
New: To add a new scope assignment for the destination.
Update: To update an existing scope assignment for the destination. -
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : Cost
Type:
object
Nested Schema : Quantity
Type:
object
Response
Supported Media Types
- application/json
201 Response
The object was successfully created.
Nested Schema : ApiEntityScopeItemAssignmentTransferRequest
Type:
Show Source
object
-
changeRequestId(optional):
integer(int64)
The unique identifier for a work package change when a work package is transferred.
-
costImpact(optional):
boolean
Indicates whether the transfer will impact the cost of the work package.
-
description(optional):
string
Details supporting the transfer request.
-
finishDate(optional):
string(date-time)
The date the transfer will no longer take effect.
-
itemCode(optional):
string
The identifier for the work package change when a work package is transferred.
-
itemPrefix(optional):
string
The auto numbering prefix of a code.
-
itemSuffix(optional):
integer(int64)
The auto numbering suffix of a code.
-
link(optional):
string(url)
Read Only:
true
-
parentScopeItemAssignmentTransferRequestId(optional):
integer(int64)
The transfer item that is part of a source transfer group.
-
scheduleImpact(optional):
boolean
Indicates whether the change will impact the schedule of the work package.
-
scopeItemAssignmentId(optional):
integer(int64)
The unique identifier of a work package.
-
scopeItemAssignmentTransferRequestId(optional):
integer(int64)
The unique identifier of a work package transfer.
-
startDate(optional):
string(date-time)
The date the transfer will start to take effect.
-
status(optional):
string
Allowed Values:
[ "PENDING", "APPROVED", "REJECTED" ]
The state of the scope assignment transfer request.
Pending: The change request is awaiting a decision.
Approved: The change request was approved.
Rejected: The change request was not approved. -
transferCost(optional):
object Cost
-
transferCostProject(optional):
object Cost
-
transferHours(optional):
object Hour
-
transferUnits(optional):
object Quantity
-
type(optional):
string
Allowed Values:
[ "NEW", "QUANTITY", "HOURS" ]
The type of transfer to be made on the scope assignment.
New: To add a new scope assignment for the destination.
Update: To update an existing scope assignment for the destination. -
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : Cost
Type:
object
Nested Schema : Quantity
Type:
object
400 Response
Invalid input.