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

Update a deliverable

patch

/fscmRestApi/resources/11.13.18.05/deliverables/{DeliverableId}

Request

Path Parameters
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.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Attachment to a Deliverable
    Title: Attachment to a Deliverable
    The attachment resource is used to create, view, update, or delete an attachment to a project deliverable.
  • Title: Name
    Maximum Length: 150
    Name of the deliverable. This field is mandatory for POST operation.
  • Title: Description
    Maximum Length: 1000
    Description of the deliverable.
  • Title: Need-by Date
    Due date of the deliverable. If provided, it must be a valid date.
  • Email address of the person who owns the deliverable.
  • Identifier of the person who owns the deliverable.
  • Name of the person who owns the deliverable.
  • 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.
  • Maximum Length: 30
    Internal code of the priority assigned to the deliverable.
  • Deliverable and Project Task Associations
    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.
  • Deliverable and Requirement Associations
    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.
  • Title: Short Name
    Maximum Length: 30
    Short name of the deliverable. This field is mandatory for POST operation.
  • 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.
  • Maximum Length: 30
    Internal code of the status for the deliverable.
  • 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.
  • Identifier of the deliverable type.
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-patch-request
Type: object
Show Source
  • 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: 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: 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.
Nested Schema : deliverables-ProjectTaskAssociation-item-patch-request
Type: object
Show Source
  • 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-patch-request
Type: object
Show Source
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-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
Links
Attachment
Parameters:
  • DeliverableId: $request.path.DeliverableId
The attachment resource is used to create, view, update, or delete an attachment to a project deliverable.
ProjectTaskAssociation
Parameters:
  • DeliverableId: $request.path.DeliverableId
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.
RequirementAssociation
Parameters:
  • DeliverableId: $request.path.DeliverableId
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.
Back to Top