1. REST API for Oracle Fusion Cloud Project Management
  2. Tasks
  3. Deliverables

Get all deliverables

get

/fscmRestApi/resources/11.13.18.05/deliverables

Request

Query Parameters
  • 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).
  • 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
  • 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 deliverable with the specified deliverable ID.
      Finder Variables:
      • DeliverableId; integer; Identifier for the deliverable associated to the task.
    • findByDeliverableName: Finds the deliverable with the specified deliverable name.
      Finder Variables:
      • DeliverableName; string; Name of the deliverable.
    • findByPrimaryKey: Finds the deliverable with the specified deliverable's primary key.
      Finder Variables:
      • DeliverableId; integer; Identifier for the deliverable associated to the task.
    • findCreatedDeliverables: Finds all deliverables created by the specified creator ID.
      Finder Variables:
      • CreatedById; integer; Identifier of the creator of the deliverable.
    • findDeliverablesByDate: Finds all deliverables due within next 7 days
      Finder Variables:
      • findDeliverablesByNeedByDate: Finds all deliverables by the need-by date.
        Finder Variables:
        • NeedByDate; string; Date when the deliverable is due.
      • findDeliverablesByPriority: Finds all deliverables by priority.
        Finder Variables:
        • Priority; string; Priority assigned to the deliverable.
        • PriorityCode; string; Internal code of the priority assigned to the deliverable.
      • findDeliverablesByStatus: Finds all deliverables by status.
        Finder Variables:
        • Status; string; Current status of the deliverable.
        • StatusCode; string; Internal code of the status for the deliverable.
      • findDeliverablesByType: Finds all deliverables by type.
        Finder Variables:
        • Type; string; Type of deliverable.
      • findDeliverablesOverdue: Finds deliverables for which need-by date is earlier than the current date.
        Finder Variables:
        • NeedByDate; string; Date when the deliverable is due.
      • findMyDeliverables: Finds all the deliverables owned by the specified owner ID.
        Finder Variables:
        • OwnerId; integer; Identifier of the owner of the deliverable.
    • 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.
    • 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
    • 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.
    • The resource item payload will be filtered in order to contain only data (no links section, for example).
    • 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
    • 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:
      • CreatedByEmail; string; Email address of the person who created the deliverable.
      • CreatedById; integer; Identifier of the person who created the deliverable.
      • CreatedByName; string; Name of the person who created the deliverable. It is automatically populated as the name of the user who creates the deliverable.
      • CreationDate; string; Date when the deliverable is created. It is automatically populated as the current date.
      • DeliverableId; integer; Identifier of the deliverable. This field is mandatory for PATCH and DELETE operations.
      • DeliverableName; string; Name of the deliverable. This field is mandatory for POST operation.
      • Description; string; Description of the deliverable.
      • NeedByDate; string; Due date of the deliverable. If provided, it must be a valid date.
      • OwnerEmail; string; Email address of the person who owns the deliverable.
      • OwnerId; integer; Identifier of the person who owns the deliverable.
      • OwnerName; string; Name of the person who owns the deliverable.
      • Priority; string; Priority of the deliverable. The LOV resource name is DeliverablePriority, and the choices are High, Medium, and Low. The default value is Medium. This field is mandatory for POST operation.
      • PriorityCode; string; Internal code of the priority assigned to the deliverable.
      • ShortName; string; Short name of the deliverable. This field is mandatory for POST operation.
      • Status; string; Status of the deliverable. The LOV resource name is DeliverableStatus and the choices are New, In progress, and Completed. The default value is New. This field is mandatory for POST operation.
      • StatusCode; string; Internal code of the status for the deliverable.
      • Type; string; The type of deliverable. It is selected from a list of values configured by the customer. The LOV resource name is DeliverableType. The default value is General. This is a mandatory field for POST operation.
      • TypeId; integer; Identifier of the deliverable type.
    • 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
    • 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".
    • 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

    Default Response

    The following table describes the default response for this task.
    Headers
    • 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".
    • 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 : deliverables
    Type: object
    Show Source
    Nested Schema : Items
    Type: array
    Title: Items
    The items in the collection.
    Show Source
    Nested Schema : deliverables-item-response
    Type: object
    Show Source
    Nested Schema : Attachment to a Deliverable
    Type: array
    Title: Attachment to a Deliverable
    The attachment resource is used to create, view, update, or delete an attachment to a project deliverable.
    Show Source
    Nested Schema : Deliverable and Project Task Associations
    Type: array
    Title: Deliverable and Project Task Associations
    The project task association resource is used to create, view, update, or delete an association between a deliverable and a project task. The project tasks associated with a deliverable.
    Show Source
    Nested Schema : Deliverable and Requirement Associations
    Type: array
    Title: Deliverable and Requirement Associations
    The requirement association resource is used to create, view, update, or delete an association between a deliverable and a requirement. The requirements associated with a deliverable.
    Show Source
    Nested Schema : deliverables-Attachment-item-response
    Type: object
    Show Source
    • Title: Asynchronous Upload Tracker Id
      Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
    • Title: Attached Document Id
      Identifier of the attachment.
    • Title: Category
      Maximum Length: 30
      Category of the attachment. For POST or PATCH operations, the value must be Project Deliverable.
    • Title: Shared
      Indicates if a file is shared.
    • Title: Created By
      Read Only: true
      Maximum Length: 255
      Name of the person who originally created the attachment. In POST or PATCH operation it is automatically populated as the name of the user who creates the attachment.
    • Title: Created By User Name
      Read Only: true
      Name of the person who created the record.
    • Title: Creation Date
      Read Only: true
      Date when the attachment was originally created. It is automatically populated as the date attachment was created.
    • Title: Type
      Maximum Length: 30
      Default Value: FILE
      Type of attachment. Values are FILE, WEB_PAGE, or TEXT. Default value is TEXT. It is mandatory in POST operations.
    • Title: Description
      Maximum Length: 255
      Description of the attachment.
    • Maximum Length: 255
      The unique identifier of the attachment.
    • Title: Dm Folder Path
      Maximum Length: 1000
      The path to the folder where the uploaded file is stored.
    • Maximum Length: 255
      The version number of the attachment.
    • Title: DownloadInfo
      JSON object represented as a string containing information used to programmatically retrieve a file attachment.
    • Title: Error Status Code
      Error code, if the operation returns an error.
    • Title: Error Status Message
      Error message, if the operation returns an error.
    • Title: Expiration Date
      Expiration date of the file on the file content server.
    • Title: File Contents
      Contents of the attachment. This attribute is not being used.
    • Title: File Name
      Maximum Length: 2048
      Name of the file if the attachment type is File, or the text itself if the attachment type is File. It is mandatory in POST operations if the attachment type is File or Text.
    • Title: File Url
      Location on the file content server of the attached document or text. This is null if the attachment type is URL.
    • Title: File Web Image
      Read Only: true
      The base64 encoded image of the file displayed in .png format if the source is a convertible image.
    • Title: Last Update Date
      Read Only: true
      Date when the attachment was last updated. In POST or PATCH operation it is automatically populated as the current date.
    • Title: Last Updated By
      Read Only: true
      Maximum Length: 255
      Name of the person who last updated the attachment. In POST or PATCH operation it is automatically populated as the name of the user who updates the attachment.
    • Title: Last Updated By User
      Read Only: true
      Name of the person who last updated the record.
    • Links
    • Title: PostProcessingAction
      The name of the action that can be performed after an attachment is uploaded.
    • Title: Title
      Title of the attachment.
    • Title: Uploaded File Content Type
      Type of file uploaded as attachment, such as text, or Excel document. It is mandatory in POST operations if the attachment type is File.
    • Title: File Size
      Size of the file uploaded as attachment. This is null if the attachment type is URL.
    • Title: Uploaded File Name
      Name of the attachment file. This attribute is not being used.
    • Title: Uploaded Text
      Text of the attachment. This attribute is not being used.
    • Title: Uri
      Maximum Length: 4000
      Universal resource identifier, which is a unique identifier of the location on the Internet.
    • Title: Url
      Maximum Length: 4000
      Universal Resource Locator, if the attachment type is URL. It is mandatory in POST operations if the attachment type is URL.
    • Title: User Name
      Read Only: true
      Maximum Length: 255
      Category code of the attachment. For POST or PATCH operations, the value must be PROJECT_DELIVERABLE.
    Nested Schema : deliverables-ProjectTaskAssociation-item-response
    Type: object
    Show Source
    • Links
    • Identifier of the association between task and deliverable. This field is mandatory for DELETE operations to remove the association.
    • Identifier of the project associated with the deliverable.
    • Name of the project associated with the deliverable. The Project Name or Project Number is mandatory for POST operation if the deliverable is associated with a project task.
    • Number of the project associated with the deliverable. The Project Name or Project Number is mandatory for POST operation if the deliverable is associated with a project task.
    • Identifier of the task associated with the deliverable.
    • Name of the task associated with the deliverable. The Task Name or Task Number is mandatory for POST operation if the deliverable is associated with a project task.
    • Number of the task associated with the deliverable. The Task Name or Task Number is mandatory for POST operation if the deliverable is associated with a project task.
    Nested Schema : deliverables-RequirementAssociation-item-response
    Type: object
    Show Source
    Back to Top

    Examples

    The following example shows how to get all deliverables 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/deliverables

    Example of Response Body

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

     {
"DeliverableId": 300100069943249,
"ShortName": "88W49BAT Without Proj",
"OwnerName": "Mark Taylor",
"OwnerEmail": "prj_mark_taylor_in_grp@oracle.com",
"PriorityCode": "HIGH",
"StatusCode": "WORKING",
"CreationDate": "2015-03-29T22:52:04+00:00",
"NeedByDate": "2015-12-07",
"Priority": "High",
"Status": "In progress",
"CreatedById": 300100023180811,
"CreatedByName": "Mark Taylor",
"CreatedByEmail": "prj_mark_taylor_in_grp@oracle.com",
"OwnerId": 300100023180811,
"DeliverableName": "88W49BAT Deliverable Without Project",
"Type": "General",
"TypeId": 1,
"Description": "88W49BAT Deliverable Without Project"
}
    Back to Top