Jump to

• Request
• Response
• Examples

Get the status change history of a project by StatusHistoryID

get

/fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/ProjectStatusHistory/{StatusHistoryId}

Request

Path Parameters

• ProjectId(required): integer(int64)
  Unique identifier of the project.
• StatusHistoryId(required): integer(int64)
  Unique identifier of the status change record.

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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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 Top

Response

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.

Body ()

Root Schema : projects-ProjectStatusHistory-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OldStatusClassificationCode":{
            "title":"Old Status Classification Code",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NewStatusClassificationCode":{
            "title":"New Status Classification Code",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectId":{
            "title":"Object ID",
            "type":"integer",
            "description":"The unique identifier of the object, such as Milestone ID or Project ID.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OldStatus":{
            "title":"Old Status",
            "maxLength":"80",
            "type":"string",
            "description":"The old status of the object, such as milestone or project.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusHistoryId":{
            "title":"Status History ID",
            "type":"integer",
            "description":"Unique identifier of the status change record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "NewStatusClassification":{
            "title":"New Status Classification",
            "maxLength":"240",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OldStatusClassification":{
            "title":"Old Status Classification",
            "maxLength":"240",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OldStatusCode":{
            "title":"Old Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"The old status code of the object, such as milestone or project.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusChangeComments":{
            "title":"Status Change Comments",
            "maxLength":"4000",
            "type":"string",
            "description":"The comments entered when the status of the object, such as milestone or project, is changed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "StatusObject":{
            "title":"Status Object",
            "maxLength":"30",
            "type":"string",
            "description":"Type of the object that's undergoing the status change. For example, project or milestone.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NewStatus":{
            "title":"New Status",
            "maxLength":"80",
            "type":"string",
            "description":"The new status of the object, such as milestone or project.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NewStatusCode":{
            "title":"New Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"The new status code of the object, such as milestone or project.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

Example

The following example shows how to get the status history of a project 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/<StatusHistoryId>

Response Body

The following shows an example of the response body in JSON format.

{
    "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"
        }
    ]
}

Back to Top