Jump to

• Request
• Response

View all Period Closeout by Project

get

/api/restapi/periodCloseoutRecord/project/{projectId}

This endpoint returns period closeouts that meet the following requirements:

• The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.

Request

Path Parameters

• projectId(required): integer(int64)
  ID of the project for which period closeout has to be found.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : List<ApiEntityPeriodCloseOutRecord>

Type: array

Title: List<ApiEntityPeriodCloseOutRecord>

Show Source

• Array of: object ApiEntityPeriodCloseOutRecord
  Title: ApiEntityPeriodCloseOutRecord

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

Nested Schema : ApiEntityPeriodCloseOutRecord

Type: object

Title: ApiEntityPeriodCloseOutRecord

Show Source

• link: string (url)
  Read Only: true

  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• periodCloseOutRecordId: integer (int64)
  Unique identifier of a cost record. This value should not be provided in create operation request data, however, it is required for update requests.
• periodItemId: integer (int64)
  The unique identifier of a period item.
• projectId: integer (int64)
  The unique identifier of a project.
• updateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.

{
    "title":"ApiEntityPeriodCloseOutRecord",
    "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",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier of a project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "periodItemId":{
            "type":"integer",
            "description":"The unique identifier of a period item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "periodCloseOutRecordId":{
            "type":"integer",
            "description":"Unique identifier of a cost record. 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",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

204 Response

Successful operation with no content.

404 Response

The requested period closeout does not exist, or you do not have access to it.

Back to Top