Jump to

• Request
• Response

View Snapshots by Project ID

get

/api/restapi/action/snapshot/project/{id}

Send a request to this endpoint to view Cash Flow snapshots associated to a project with an ID value matching the value of the {id} path parameter. Cash Flow snapshots capture the state of project cash flow at a particular point in time. Use project snapshots to monitor changes to cash flow data over time.

Request

Path Parameters

• id(required): integer(int64)
  Returns the snapshots for project id.

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<ApiEntityProjectSnapshot>

Type: array

Title: List<ApiEntityProjectSnapshot>

Show Source

• Array of: object ApiEntityProjectSnapshot
  Title: ApiEntityProjectSnapshot

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

Nested Schema : ApiEntityProjectSnapshot

Type: object

Title: ApiEntityProjectSnapshot

Show Source

• description: string
  Minimum Length: 0

  Maximum Length: 4000

  A detailed summary for the baseline or snapshot.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• name: string
  Maximum Length: 255

  Name for the baseline or snapshot.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• snapshotCode: string
  Maximum Length: 60

  Code for the baseline or snapshot.
• snapshotId: integer (int64)
  The unique identifier for a baseline or snapshot.
• time: string (date-time)
  The time at which the snapshot was generated.
• type: string
  Allowed Values: [ "CAPITAL_PLAN", "PROJECT", "PROGRAM", "IDEA" ]

  Identifies the type of the baseline. Valid values are Original, Current, or Blank. Original baselines mark the starting point for recurring change requests for modifications to Scope Items, Work Packages, and Scope Assignments. Current baselines indicate the latest set baseline when a related original baseline exists. Blank baselines indicate the baseline is a snapshot.
• updateDate: string (date-time)
  Date when the record was last updated.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityProjectSnapshot",
    "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"
            ]
        },
        "name":{
            "maxLength":"255",
            "type":"string",
            "description":"Name for the baseline or snapshot.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "type":{
            "type":"string",
            "description":"Identifies the type of the baseline. Valid values are Original, Current, or Blank. Original baselines mark the starting point for recurring change requests for modifications to Scope Items, Work Packages, and Scope Assignments. Current baselines indicate the latest set baseline when a related original baseline exists. Blank baselines indicate the baseline is a snapshot.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "CAPITAL_PLAN",
                "PROJECT",
                "PROGRAM",
                "IDEA"
            ]
        },
        "time":{
            "type":"string",
            "description":"The time at which the snapshot was generated.",
            "format":"date-time",
            "exampleSetFlag":false
        },
        "description":{
            "maxLength":"4000",
            "minLength":"0",
            "type":"string",
            "description":"A detailed summary for the baseline or snapshot.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "snapshotId":{
            "type":"integer",
            "description":"The unique identifier for a baseline or snapshot.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "snapshotCode":{
            "maxLength":"60",
            "type":"string",
            "description":"Code for the baseline or snapshot.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

204 Response

Successful operation with no content.

404 Response

The requested project snapshot does not exist or you do not have access to it.

Back to Top