Jump to

• Request
• Response
• Examples

Get a request line associated to the project resource request

get

/fscmRestApi/resources/11.13.18.05/projectPlanResourceRequests/{ResourceRequestId}/child/ProjectPlanResourceRequestLines/{RequestLineId}

Request

Path Parameters

• RequestLineId(required): integer(int64)
  Unique identifier of the request line under the project resource request.
• ResourceRequestId(required): integer(int64)
  Identifier of the project resource request.

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 : projectPlanResourceRequests-ProjectPlanResourceRequestLines-item-response

Type: object

Show Source

• AssignedHours: number
  Title: Assigned Hours

  Read Only: true

  Assigned hours per day when the specify hours per day is selected for use project calendar flag.
• AssignmentFinishDate: string (date)
  Title: Assignment Finish Date

  Assignment finish date for the resource.
• AssignmentId: integer
  Title: Assignment ID

  Identifier of the assignment created for the resource, if an assignment is created for the resource on the request line.
• AssignmentStartDate: string (date)
  Title: Assignment Start Date

  Assignment start date for the resource.
• AssignmentStatus: string
  Title: Resource Staffing Status

  Read Only: true

  Maximum Length: 80

  Status of the assignment created for the resource to fulfill the request.
• AssignmentStatusCode: string
  Title: Assignment Status Code

  Maximum Length: 30

  Code of the assignment created for the resource to fulfill the request.
• CurrentFlag: boolean
  Title: Current Indicator

  Read Only: true

  Maximum Length: 1

  Indicates whether the project resource request is the most recent request for the assignment. Valid values are Y and N.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProjectRole: string
  Title: Project Role

  Resource role for the project assignment.
• RejectionReason: string
  Maximum Length: 80

  Reason the nominated resource is rejected for the project resource assignment.
• RejectionReasonCode: string
  Title: Rejection Reason Code

  Maximum Length: 30

  Code to indicate the reason the nominated resource is rejected for the project resource assigment.
• RequestLineId: integer (int64)
  Title: Request Line ID

  Unique identifier of the request line under the project resource request.
• ReservationExpirationDate: string (date)
  Title: Reservation Expiration Date

  Read Only: true

  Reservation expiration date for the resource if the assignment status is reserved.
• ReservationReason: string
  Title: Reservation Reason

  Read Only: true

  Reservation reason for the resource if the assignment status is reserved.
• ResourceEmail: string
  Title: Resource Email

  Maximum Length: 240

  Name of the project enterprise resource associated to the project resource request.
• ResourceFulfilledDate: string (date)
  Title: Request Fulfilled Date

  The date the resource on the request line is approved to fulfill the project resource request.
• ResourceId: integer (int64)
  Title: Resource ID

  Identifier of the project enterprise resource associated to the project resource request.
• ResourceName: string
  Title: Resource Name

  Read Only: true

  Maximum Length: 240

  Email of the project enterprise resource associated to the project resource request.
• ResourcePersonId: integer (int64)
  Title: Resource HCM Person ID

  Read Only: true

  HCM person identifier of the project enterprise resource associated to the project resource request.
• ResourceProposedDate: string (date)
  Title: Resource Proposed Date

  The date when the resource is proposed or nominated to fulfill the project resource request.
• ResourceStatus: string
  Title: Resource Staffing Status

  Maximum Length: 80

  Status of the resource associated to the project resource request.
• ResourceStatusCode: string
  Title: Resource Status Code

  Maximum Length: 20

  Default Value: NEW_LINE

  Status code for the resource associated to the project resource request.
• ResourceSystemStatus: string
  Title: Resource System Status

  Read Only: true

  Resource system status based on the seeded values.
• UseProjectCalendarFlag: boolean
  Title: Use Project Calendar Indicator

  Read Only: true

  Indicates whether to use project calendar hours or specific hours per day.

{
    "type":"object",
    "properties":{
        "ResourceProposedDate":{
            "title":"Resource Proposed Date",
            "type":"string",
            "description":"The date when the resource is proposed or nominated to fulfill the project resource request.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceName":{
            "title":"Resource Name",
            "maxLength":"240",
            "type":"string",
            "description":"Email of the project enterprise resource associated to the project resource request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestLineId":{
            "title":"Request Line ID",
            "type":"integer",
            "description":"Unique identifier of the request line under the project resource request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReservationReason":{
            "title":"Reservation Reason",
            "type":"string",
            "description":"Reservation reason for the resource if the assignment status is reserved.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectRole":{
            "title":"Project Role",
            "type":"string",
            "description":"Resource role for the project assignment.",
            "nullable":true,
            "x-queryable":true
        },
        "AssignmentStartDate":{
            "title":"Assignment Start Date",
            "type":"string",
            "description":"Assignment start date for the resource.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "RejectionReason":{
            "maxLength":"80",
            "type":"string",
            "description":"Reason the nominated resource is rejected for the project resource assignment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ResourcePersonId":{
            "title":"Resource HCM Person ID",
            "type":"integer",
            "description":"HCM person identifier of the project enterprise resource associated to the project resource request.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UseProjectCalendarFlag":{
            "title":"Use Project Calendar Indicator",
            "type":"boolean",
            "description":"Indicates whether to use project calendar hours or specific hours per day.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceStatusCode":{
            "title":"Resource Status Code",
            "maxLength":"20",
            "type":"string",
            "description":"Status code for the resource associated to the project resource request.",
            "nullable":true,
            "default":"NEW_LINE",
            "x-queryable":true
        },
        "ReservationExpirationDate":{
            "title":"Reservation Expiration Date",
            "type":"string",
            "description":"Reservation expiration date for the resource if the assignment status is reserved.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"Identifier of the project enterprise resource associated to the project resource request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourceSystemStatus":{
            "title":"Resource System Status",
            "type":"string",
            "description":"Resource system status based on the seeded values.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignmentId":{
            "title":"Assignment ID",
            "type":"integer",
            "description":"Identifier of the assignment created for the resource, if an assignment is created for the resource on the request line.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceStatus":{
            "title":"Resource Staffing Status",
            "maxLength":"80",
            "type":"string",
            "description":"Status of the resource associated to the project resource request.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RejectionReasonCode":{
            "title":"Rejection Reason Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code to indicate the reason the nominated resource is rejected for the project resource assigment.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AssignmentStatusCode":{
            "title":"Assignment Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code of the assignment created for the resource to fulfill the request.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceFulfilledDate":{
            "title":"Request Fulfilled Date",
            "type":"string",
            "description":"The date the resource on the request line is approved to fulfill the project resource request.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AssignmentStatus":{
            "title":"Resource Staffing Status",
            "maxLength":"80",
            "type":"string",
            "description":"Status of the assignment created for the resource to fulfill the request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrentFlag":{
            "title":"Current Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the project resource request is the most recent request for the assignment. Valid values are Y and N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedHours":{
            "title":"Assigned Hours",
            "type":"number",
            "description":"Assigned hours per day when the specify hours per day is selected for use project calendar flag.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceEmail":{
            "title":"Resource Email",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the project enterprise resource associated to the project resource request.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "AssignmentFinishDate":{
            "title":"Assignment Finish Date",
            "type":"string",
            "description":"Assignment finish date for the resource.",
            "format":"date",
            "nullable":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

The following example shows how to get a request line associated to the project resource request by submitting a GET request on the REST resource using cURL.

curl --user ppm_cloud_user https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlanResourceRequests/{ResourceRequestId}/child/ProjectPlanResourceRequestLines/{RequestLineId}

Response Body Example

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

{
            "RequestLineId": 300100169517432,
            "ResourceId": 300100023180874,
            "ResourceName": "Ruby Williams",
            "ResourceEmail": "[e-mail]",
            "ResourcePersonId": 300100007736610,
            "ResourceStatusCode": "REQUESTED",
            "ResourceStatus": "Requested",
            "AssignmentId": null,
            "AssignmentStatusCode": null,
            "AssignmentStatus": null,
            "ResourceProposedDate": null,
            "ResourceFulfilledDate": null
        }

Back to Top