Close a Project Current Period Item
post
/primeapi/restapi/action/periodCloseout
Send a request to this endpoint to close a project current period item. This endpoint returns a job ID upon execution of the request. Send a request to the View Job Status endpoint to monitor the status of scheduled jobs.
Request
Supported Media Types
- application/json
A period closeout object specifying a target project.
Root Schema : ApiEntityPeriodCloseout
Type:
Show Source
object
-
projectId:
integer(int64)
The unique identifier for the project.
Response
Supported Media Types
- application/json
201 Response
The object was successfully created.
Root Schema : ApiEntityPeriodItem
Type:
Show Source
object
-
dayDate(optional):
string(date-time)
The day date of a period item.
-
displayDate(optional):
string(date-time)
The display date of a period item.
-
displayName(optional):
string
Allowed Values:
[ "Length[1-255]" ]
The name of a period item. -
endDate(optional):
string(date-time)
The date on which the period item ends.
-
link(optional):
string(url)
Read Only:
true
-
periodCode(optional):
string
Allowed Values:
[ "Length[1-20]" ]
The code of a period item. -
periodId(optional):
integer(int64)
The unique identifier for a project period.
-
periodItemId(optional):
integer(int64)
The unique identifier for a project current period item.
-
startDate(optional):
string(date-time)
The date on which the period item begins.
-
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.
400 Response
Invalid input for the Action service.