Jump to

• Request
• Response
• Examples

Get an assignment

get

/fscmRestApi/resources/11.13.18.05/projectInsights/{ProjectId}/child/Assignments/{AssignmentId}

Request

Path Parameters

• AssignmentId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• ProjectId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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 : projectInsights-Assignments-item-response

Type: object

Show Source

• AssignmentEndDate: string (date)
  Title: Assignment End Date

  The date when the resource assignment to the project is scheduled to end.
• AssignmentId: integer (int64)
  Title: Assignment ID

  The unique identifier of the project resource assignment.
• AssignmentStartDate: string (date)
  Title: Start Date

  The date when the resource assignment to the project is scheduled to start.
• AssignmentStatus: string
  Title: Assignment Status

  Read Only: true

  Maximum Length: 80

  The project assignment status for a resource, such as reserved or pending adjustment. A list of values is defined in the lookup type PJR_ASSIGN_STATUS. Review the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task.
• AssignmentStatusCode: string
  Title: Assignment Status Code

  Maximum Length: 30

  The code representing the project assignment status for a resource, such as RESERVED and PENDING_ADJUSTMENT. A list of values is defined in the lookup type PJR_ASSIGN_STATUS. Review the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task.
• CreatedBy: string
  Title: Created By

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  The date when the record was created.
• EarliestTaskDate: string (date)
  Title: Earliest Task Start Date

  The earliest start date for the set of tasks that are assigned to the labor resource for the project.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Maximum Length: 64

  The user who last updated the record.
• LatestTaskDate: string (date)
  Title: Latest Task Finish Date

  The latest finish date for the set of tasks that are assigned to the labor resource.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ResourceId: integer (int64)
  Title: Resource ID

  The unique identifier of the project enterprise labor resource.
• ResourceName: string
  Title: Resource

  Read Only: true

  Maximum Length: 240

  The name of the project enterprise labor resource.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "x-queryable":true
        },
        "ResourceName":{
            "title":"Resource",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the project enterprise labor resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignmentStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the resource assignment to the project is scheduled to start.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LatestTaskDate":{
            "title":"Latest Task Finish Date",
            "type":"string",
            "description":"The latest finish date for the set of tasks that are assigned to the labor resource.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "EarliestTaskDate":{
            "title":"Earliest Task Start Date",
            "type":"string",
            "description":"The earliest start date for the set of tasks that are assigned to the labor resource for the project.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"The unique identifier of the project enterprise labor resource.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssignmentEndDate":{
            "title":"Assignment End Date",
            "type":"string",
            "description":"The date when the resource assignment to the project is scheduled to end.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AssignmentId":{
            "title":"Assignment ID",
            "type":"integer",
            "description":"The unique identifier of the project resource assignment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "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":"The code representing the project assignment status for a resource, such as RESERVED and PENDING_ADJUSTMENT. A list of values is defined in the lookup type PJR_ASSIGN_STATUS. Review the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task.",
            "nullable":true,
            "x-queryable":true
        },
        "AssignmentStatus":{
            "title":"Assignment Status",
            "maxLength":"80",
            "type":"string",
            "description":"The project assignment status for a resource, such as reserved or pending adjustment. A list of values is defined in the lookup type PJR_ASSIGN_STATUS. Review the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "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 an assignment 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/projectInsights/300100061807448/child/Assignments/300100120614974

Response Body Example

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

{
  "AssignmentId": 300100120614974,
  "ResourceId": 300100024326747,
  "ResourceName": "Cathy Price",
  "AssignmentStatusCode": "RESERVED",
  "AssignmentStatus": "Reserved",
  "AssignmentStartDate": "2019-10-11",
  "AssignmentEndDate": "2020-03-27",
  "EarliestTaskDate": "2019-10-14",
  "LatestTaskDate": "2020-03-27",
  "CreatedBy": "Lisa.Williams",
  "CreationDate": "2019-09-08T00:28:29+00:00",
  "LastUpdateDate": "2019-09-08T00:28:29+00:00",
  "LastUpdatedBy": "Lisa.Williams",
  "links": [
     …
  ]
}

Back to Top