Get the status history of a project
get
/fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/ProjectStatusHistory
Request
Path Parameters
-
ProjectId(required): integer(int64)
Unique identifier of the project.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds the status history of a project.
Finder Variables:- StatusHistoryId; integer; The unique identifier of the status history of a project.
- PrimaryKey: Finds the status history of a project.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- CreatedBy; string; The user who created the record.
- CreationDate; string; The date when the record was created.
- LastUpdateDate; string; The date when the record was last updated.
- LastUpdatedBy; string; The user who last updated the record.
- NewStatus; string; The new status of the object, such as milestone or project.
- NewStatusClassification; string; The new internal status classification of the object, such as milestone or project. Status classifications are predefined groupings of statuses for each status object which typically govern delivered application behavior. Status classification attributes also control extensibility.
- NewStatusClassificationCode; string; The new internal status classification code of the object, such as milestone or project. Status classifications are predefined groupings of statuses for each status object which typically govern delivered application behavior. Status classification attributes also control extensibility.
- NewStatusCode; string; The new status code of the object, such as milestone or project.
- ObjectId; integer; The unique identifier of the object, such as Milestone ID or Project ID.
- OldStatus; string; The old status of the object, such as milestone or project.
- OldStatusClassification; string; The old internal status classification of the object, such as milestone or project. Status classifications are predefined groupings of statuses for each status object which typically govern delivered application behavior. Status classification attributes also control extensibility.
- OldStatusClassificationCode; string; The old internal status classification code of the object, such as milestone or project. Status classifications are predefined groupings of statuses for each status object which typically govern delivered application behavior. Status classification attributes also control extensibility.
- OldStatusCode; string; The old status code of the object, such as milestone or project.
- StatusChangeComments; string; The comments entered when the status of the object, such as milestone or project, is changed.
- StatusHistoryId; integer; Unique identifier of the status change record.
- StatusObject; string; Type of the object that's undergoing the status change. For example, project or milestone.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : projects-ProjectStatusHistory
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : projects-ProjectStatusHistory-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NewStatus: string
Title:
New Status
Read Only:true
Maximum Length:80
The new status of the object, such as milestone or project. -
NewStatusClassification: string
Title:
New Status Classification
Read Only:true
Maximum Length:240
The new internal status classification of the object, such as milestone or project. Status classifications are predefined groupings of statuses for each status object which typically govern delivered application behavior. Status classification attributes also control extensibility. -
NewStatusClassificationCode: string
Title:
New Status Classification Code
Read Only:true
Maximum Length:30
The new internal status classification code of the object, such as milestone or project. Status classifications are predefined groupings of statuses for each status object which typically govern delivered application behavior. Status classification attributes also control extensibility. -
NewStatusCode: string
Title:
New Status Code
Read Only:true
Maximum Length:30
The new status code of the object, such as milestone or project. -
ObjectId: integer
(int64)
Title:
Object ID
Read Only:true
The unique identifier of the object, such as Milestone ID or Project ID. -
OldStatus: string
Title:
Old Status
Read Only:true
Maximum Length:80
The old status of the object, such as milestone or project. -
OldStatusClassification: string
Title:
Old Status Classification
Read Only:true
Maximum Length:240
The old internal status classification of the object, such as milestone or project. Status classifications are predefined groupings of statuses for each status object which typically govern delivered application behavior. Status classification attributes also control extensibility. -
OldStatusClassificationCode: string
Title:
Old Status Classification Code
Read Only:true
Maximum Length:30
The old internal status classification code of the object, such as milestone or project. Status classifications are predefined groupings of statuses for each status object which typically govern delivered application behavior. Status classification attributes also control extensibility. -
OldStatusCode: string
Title:
Old Status Code
Read Only:true
Maximum Length:30
The old status code of the object, such as milestone or project. -
StatusChangeComments: string
Title:
Status Change Comments
Read Only:true
Maximum Length:4000
The comments entered when the status of the object, such as milestone or project, is changed. -
StatusHistoryId: integer
(int64)
Title:
Status History ID
Read Only:true
Unique identifier of the status change record. -
StatusObject: string
Title:
Status Object
Read Only:true
Maximum Length:30
Type of the object that's undergoing the status change. For example, project or milestone.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
Example
The following example shows how to get the status history of all projects by submitting a GET request on the REST resource using cURL.
curl --user ppm_cloud_user -X GET https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projects/<projectId>/child/ProjectStatusHistory
Response Body
The following shows an example of the response body in JSON
format.
{ "items": [ { "StatusChangeComments": null, "CreatedBy": "Bill.Green", "CreationDate": "2017-02-26T17:38:36+00:00", "LastUpdateDate": "2017-02-26T17:38:50.800+00:00", "LastUpdatedBy": "Bill.Green", "NewStatusCode": "CLOSED", "NewStatusClassificationCode": "CLOSED", "StatusHistoryId": 300100095525291, "ObjectId": 300100017445261, "OldStatusCode": "300100007483088", "OldStatusClassificationCode": "ACTIVE", "StatusObject": "PROJECT", "NewStatusClassification": "Closed", "OldStatusClassification": "Active", "NewStatus": "Closed", "OldStatus": "UE_Approved", "links": [ { "rel": "self", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projects/300100017445261/child/ProjectStatusHistory/300100095525291", "name": "ProjectStatusHistory", "kind": "item" }, { "rel": "canonical", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projects/300100017445261/child/ProjectStatusHistory/300100095525291", "name": "ProjectStatusHistory", "kind": "item" }, { "rel": "parent", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projects/300100017445261", "name": "projects", "kind": "item" } ] } ], "count": 1, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projects/300100017445261/child/ProjectStatusHistory", "name": "ProjectStatusHistory", "kind": "collection" } ] }