Assign or remove a document from a project control task.
Supported HTTPS Methods: GET, PUT, PATCH, POST
Request URLs:
-
Assign a document to a project control task - <HOSTNAME>/sc/datalake/v1/Instances(2)/
Projects(294)/ProjectControlTaskss(242597)/ProjectControlTasksDocuments -
Remove a document from a project control task - <HOSTNAME>/sc/datalake/v1/Instances(2)/Projects(294)/
ProjectControlTaskss(242597)/ProjectControlTasksDocuments(36063)
Header parameters:
|
Header Parameter |
Description |
|---|---|
|
Authorization |
A token required for authenticating a request. The bearer token is a string, usually generated by the server in response to a login request. You must include this header in every request. |
|
Content-Type |
The request format or the original media type of the resource. |
Sample request payload to add a document to a project control task (POST only):
{
"ProjectControlTaskId": 242597,
"DocumentId": 36063
}
Sample request payload to remove a document from a project control task (PUT or PATCH only):
{
"dtRemoved": "2023-07-14T16:09:13-06:00"
}
Request payload parameters:
|
|
|
Required, Optional, |
|
|---|---|---|---|
|
ProjectControlTaskId |
Integer |
GET - Required PUT - Required PATCH - Required POST - Required |
Smart Completions ID of the project control task that the document is being assigned to or removed from. |
|
DocumentId |
Integer |
GET - Required PUT - Required PATCH - Required POST - Required |
Smart Completions ID of the document to assign to or remove from the project control task. |
|
dtRemoved |
String (Date) |
GET - Optional PUT - Optional PATCH - Optional POST - Unused |
Date on which the document was removed from the project control task. |
Sample response:
{
"@odata.context": "https://sc-master.intergraph.com/SC/DataLake/v1/$metadata#Instances(2)/
Projects(294)/ProjectControlTaskss(242597)/ProjectControlTasksDocuments/$entity",
"Id": 1,
"ProjectControlTaskId": 242597,
"DocumentId": 36063,
"RecordCreated": "2023-11-06T11:34:33.354Z",
"RecordCreatedBy": "Sai Sai",
"RecordCreatedById": 1039,
"RecordLastModified": null,
"RecordLastModifiedBy": null,
"RecordLastModifiedById": null,
"dtRemoved": null,
"RecordRemovedBy": null
"RecordRemovedById": null,
}
Response parameters:
|
|
|
|
|---|---|---|
|
@odata.context |
String |
Request URL. |
|
Id |
Integer |
Smart Completions ID assigned to the document upon linking to the Project Control Task Asset. |
|
ProjectControlTaskId |
Integer |
Smart Completions ID of the project control task that the document is being assigned to or removed from. |
|
DocumentId |
Integer |
Smart Completions ID of the document to assign to or remove from the project control task. |
|
RecordCreated |
String (Date) |
Read only. Date when the document was assigned to the project control task in Smart Completions. Captured by Smart Completions. |
|
RecordCreatedBy |
String |
Read only. Smart Completions name for the user who assigned the document to the project control task in Smart Completions. Captured by Smart Completions. |
|
RecordCreatedById |
Integer |
Read only. Smart Completions ID for the user who assigned the document to the project control task in Smart Completions. Captured by Smart Completions. |
|
RecordLastModified |
String (Date) |
Read only. Date when the document assignment to a project control task was last updated in Smart Completions. Captured by Smart Completions. If the assignment has not been updated since creation, this is the date the assignment was created. |
|
RecordLastModifiedBy |
String |
Read only. Smart Completions name for the user who last changed which project control task the document was associated to in Smart Completions. Captured by Smart Completions. If the assignment has not been updated since creation, this is the user who created the assignment. |
|
RecordLastModifiedById |
Integer |
Read only. Smart Completions ID for the user who last updated which project control task the document was associated to in Smart Completions. Captured by Smart Completions. |
|
dtRemoved |
String (Date) |
Read only. Date when the document was removed from a project control task in Smart Completions. Captured by Smart Completions. |
|
RecordRemovedBy |
String |
Read only. Smart Completions user who removed the document assignment to a project control task in Smart Completions. Captured by Smart Completions. |
|
RecordRemovedById |
Integer |
Read only. User ID of the Smart Completions user who removed the document assignment to a project control task in Smart Completions. Captured by Smart Completions. |