Jump to

• Request
• Response

Create deliverables

post

/fscmRestApi/resources/11.13.18.05/deliverables

Request

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Attachment: array 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.
• DeliverableName(required): string
  Title: Name

  Maximum Length: 150

  Name of the deliverable. This field is mandatory for POST operation.
• Description: string
  Title: Description

  Maximum Length: 1000

  Description of the deliverable.
• NeedByDate: string (date)
  Title: Need-by Date

  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 (int64)
  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(required): string
  Maximum Length: 30

  Internal code of the priority assigned to the deliverable.
• ProjectTaskAssociation: array 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.
• RequirementAssociation: array 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.
• ShortName(required): string
  Title: Short Name

  Maximum Length: 30

  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(required): string
  Maximum Length: 30

  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(required): integer (int64)
  Identifier of the deliverable type.

{
    "required":[
        "DeliverableName",
        "PriorityCode",
        "ShortName",
        "StatusCode",
        "TypeId"
    ],
    "type":"object",
    "properties":{
        "Status":{
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "TypeId":{
            "type":"integer",
            "description":"Identifier of the deliverable type.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "OwnerName":{
            "type":"string",
            "description":"Name of the person who owns the deliverable.",
            "nullable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"Description of the deliverable.",
            "nullable":true
        },
        "Priority":{
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "PriorityCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Internal code of the priority assigned to the deliverable.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ShortName":{
            "title":"Short Name",
            "maxLength":"30",
            "type":"string",
            "description":"Short name of the deliverable. This field is mandatory for POST operation.",
            "nullable":false
        },
        "Attachment":{
            "title":"Attachment to a Deliverable",
            "type":"array",
            "description":"The attachment resource is used to create, view, update, or delete an attachment to a project deliverable.",
            "items":{
                "$ref":"#/components/schemas/deliverables-Attachment-item-post-request"
            }
        },
        "StatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Internal code of the status for the deliverable.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ProjectTaskAssociation":{
            "title":"Deliverable and Project Task Associations",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/deliverables-ProjectTaskAssociation-item-post-request"
            }
        },
        "RequirementAssociation":{
            "title":"Deliverable and Requirement Associations",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/deliverables-RequirementAssociation-item-post-request"
            }
        },
        "Type":{
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "NeedByDate":{
            "title":"Need-by Date",
            "type":"string",
            "description":"Due date of the deliverable. If provided, it must be a valid date.",
            "format":"date",
            "nullable":true
        },
        "OwnerId":{
            "type":"integer",
            "description":"Identifier of the person who owns the deliverable.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "DeliverableName":{
            "title":"Name",
            "maxLength":"150",
            "type":"string",
            "description":"Name of the deliverable. This field is mandatory for POST operation.",
            "nullable":false
        },
        "OwnerEmail":{
            "type":"string",
            "description":"Email address of the person who owns the deliverable.",
            "nullable":true
        }
    }
}

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

• Array of: object schema

{
    "title":"Attachment to a Deliverable",
    "type":"array",
    "description":"The attachment resource is used to create, view, update, or delete an attachment to a project deliverable.",
    "items":{
        "$ref":"#/components/schemas/deliverables-Attachment-item-post-request"
    }
}

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

• Array of: object schema

{
    "title":"Deliverable and Project Task Associations",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/deliverables-ProjectTaskAssociation-item-post-request"
    }
}

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

• Array of: object deliverables-RequirementAssociation-item-post-request

{
    "title":"Deliverable and Requirement Associations",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/deliverables-RequirementAssociation-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  Identifier of the attachment.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  Category of the attachment. For POST or PATCH operations, the value must be Project Deliverable.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates if a file is shared.
• DatatypeCode: string
  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.
• Description: string
  Title: Description

  Maximum Length: 255

  Description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The unique identifier of the attachment.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The path to the folder where the uploaded file is stored.
• DmVersionNumber: string
  Maximum Length: 255

  The version number of the attachment.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  Error code, if the operation returns an error.
• ErrorStatusMessage: string
  Title: Error Status Message

  Error message, if the operation returns an error.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  Expiration date of the file on the file content server.
• FileContents: string (byte)
  Title: File Contents

  Contents of the attachment. This attribute is not being used.
• FileName: string
  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.
• FileUrl: string
  Title: File Url

  Location on the file content server of the attached document or text. This is null if the attachment type is URL.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  Title of the attachment.
• UploadedFileContentType: string
  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.
• UploadedFileLength: integer
  Title: File Size

  Size of the file uploaded as attachment. This is null if the attachment type is URL.
• UploadedFileName: string
  Title: Uploaded File Name

  Name of the attachment file. This attribute is not being used.
• UploadedText: string
  Title: Uploaded Text

  Text of the attachment. This attribute is not being used.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  Universal resource identifier, which is a unique identifier of the location on the Internet.
• Url: string
  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.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"Description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"Universal resource identifier, which is a unique identifier of the location on the Internet.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"Universal Resource Locator, if the attachment type is URL. It is mandatory in POST operations if the attachment type is URL.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The unique identifier of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"Identifier of the attachment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Type of file uploaded as attachment, such as text, or Excel document. It is mandatory in POST operations if the attachment type is File.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Size of the file uploaded as attachment. This is null if the attachment type is URL.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The version number of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Error message, if the operation returns an error.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Type of attachment. Values are FILE, WEB_PAGE, or TEXT. Default value is TEXT. It is mandatory in POST operations.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Name of the attachment file. This attribute is not being used.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"Location on the file content server of the attached document or text. This is null if the attachment type is URL.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates if a file is shared.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the attachment. This attribute is not being used.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Expiration date of the file on the file content server.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Error code, if the operation returns an error.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"The path to the folder where the uploaded file is stored.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text of the attachment. This attribute is not being used.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"Category of the attachment. For POST or PATCH operations, the value must be Project Deliverable.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• ObjectAssociationId: integer (int64)
  Identifier of the association between task and deliverable. This field is mandatory for DELETE operations to remove the association.
• ProjectId: integer
  Identifier of the project associated with the deliverable.
• ProjectName: string
  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.
• ProjectNumber: string
  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.
• TaskId: integer (int64)
  Identifier of the task associated with the deliverable.
• TaskName: string
  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.
• TaskNumber: string
  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.

{
    "type":"object",
    "properties":{
        "TaskId":{
            "type":"integer",
            "description":"Identifier of the task associated with the deliverable.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ProjectName":{
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "TaskName":{
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "ObjectAssociationId":{
            "type":"integer",
            "description":"Identifier of the association between task and deliverable. This field is mandatory for DELETE operations to remove the association.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "ProjectNumber":{
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "ProjectId":{
            "type":"integer",
            "description":"Identifier of the project associated with the deliverable.",
            "nullable":true
        },
        "TaskNumber":{
            "type":"string",
            "description":"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.",
            "nullable":true
        }
    }
}

Nested Schema : deliverables-RequirementAssociation-item-post-request

Type: object

Show Source

• BacklogItemId: integer (int64)
  Identifier of the backlog item associated with the deliverable.
• BacklogItemName: string
  Name of the backlog item associated with the deliverable. This field is mandatory for POST operation if the deliverable is associated with a backlog item.
• OwnerEmail: string
  Email address of the owner of the backlog item associated with the deliverable.
• OwnerId: integer (int64)
  Owner of the backlog item associated with the deliverable.
• OwnerName: string
  Identifier of the owner of the backlog item associated with the deliverable.
• ProductName: string
  Name of the product that owns the backlog item that is associated with the deliverable.
• ReleaseName: string
  Name of the release that delivers the backlog item associated with the deliverable.
• RequirementCode: string
  Short code of the backlog item associated with the deliverable. This field is mandatory for POST operation if the deliverable is associated with a backlog item.
• ScrumMasterEmail: string
  Email address of the scrum master handling the backlog item associated with the deliverable.
• ScrumMasterId: integer
  Identifier of the scrum master handling the backlog item associated with the deliverable.
• ScrumMasterName: string
  Name of the scrum master handling the backlog item associated with the deliverable.
• SprintName: string
  Name of the sprint when the backlog item associated with the deliverable is completed.

{
    "type":"object",
    "properties":{
        "OwnerName":{
            "type":"string",
            "description":"Identifier of the owner of the backlog item associated with the deliverable.",
            "nullable":true
        },
        "ProductName":{
            "type":"string",
            "description":"Name of the product that owns the backlog item that is associated with the deliverable.",
            "nullable":true
        },
        "BacklogItemId":{
            "type":"integer",
            "description":"Identifier of the backlog item associated with the deliverable.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ReleaseName":{
            "type":"string",
            "description":"Name of the release that delivers the backlog item associated with the deliverable.",
            "nullable":true
        },
        "RequirementCode":{
            "type":"string",
            "description":"Short code of the backlog item associated with the deliverable. This field is mandatory for POST operation if the deliverable is associated with a backlog item.",
            "nullable":true
        },
        "ScrumMasterEmail":{
            "type":"string",
            "description":"Email address of the scrum master handling the backlog item associated with the deliverable.",
            "nullable":true
        },
        "ScrumMasterName":{
            "type":"string",
            "description":"Name of the scrum master handling the backlog item associated with the deliverable.",
            "nullable":true
        },
        "BacklogItemName":{
            "type":"string",
            "description":"Name of the backlog item associated with the deliverable. This field is mandatory for POST operation if the deliverable is associated with a backlog item.",
            "nullable":true
        },
        "OwnerId":{
            "type":"integer",
            "description":"Owner of the backlog item associated with the deliverable.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "SprintName":{
            "type":"string",
            "description":"Name of the sprint when the backlog item associated with the deliverable is completed.",
            "nullable":true
        },
        "ScrumMasterId":{
            "type":"integer",
            "description":"Identifier of the scrum master handling the backlog item associated with the deliverable.",
            "nullable":true
        },
        "OwnerEmail":{
            "type":"string",
            "description":"Email address of the owner of the backlog item associated with the deliverable.",
            "nullable":true
        }
    }
}

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 : deliverables-item-response

Type: object

Show Source

• Attachment: array 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.
• CreatedByEmail: string
  Title: Email

  Read Only: true

  Maximum Length: 240

  Email address of the person who created the deliverable.
• CreatedById: integer (int64)
  Read Only: true

  Identifier of the person who created the deliverable.
• CreatedByName: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  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-time)
  Read Only: true

  Date when the deliverable is created. It is automatically populated as the current date.
• DeliverableId: integer (int64)
  Read Only: true

  Identifier of the deliverable. This field is mandatory for PATCH and DELETE operations.
• DeliverableName: string
  Title: Name

  Maximum Length: 150

  Name of the deliverable. This field is mandatory for POST operation.
• Description: string
  Title: Description

  Maximum Length: 1000

  Description of the deliverable.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NeedByDate: string (date)
  Title: Need-by Date

  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 (int64)
  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
  Maximum Length: 30

  Internal code of the priority assigned to the deliverable.
• ProjectTaskAssociation: array 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.
• RequirementAssociation: array 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.
• ShortName: string
  Title: Short Name

  Maximum Length: 30

  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
  Maximum Length: 30

  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 (int64)
  Identifier of the deliverable type.

{
    "type":"object",
    "properties":{
        "CreatedByName":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the person who created the deliverable. It is automatically populated as the name of the user who creates the deliverable.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the deliverable is created. It is automatically populated as the current date.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TypeId":{
            "type":"integer",
            "description":"Identifier of the deliverable type.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "OwnerName":{
            "type":"string",
            "description":"Name of the person who owns the deliverable.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"Description of the deliverable.",
            "nullable":true,
            "x-queryable":true
        },
        "Priority":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "PriorityCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Internal code of the priority assigned to the deliverable.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedByEmail":{
            "title":"Email",
            "maxLength":"240",
            "type":"string",
            "description":"Email address of the person who created the deliverable.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShortName":{
            "title":"Short Name",
            "maxLength":"30",
            "type":"string",
            "description":"Short name of the deliverable. This field is mandatory for POST operation.",
            "nullable":false,
            "x-queryable":true
        },
        "Attachment":{
            "title":"Attachment to a Deliverable",
            "type":"array",
            "description":"The attachment resource is used to create, view, update, or delete an attachment to a project deliverable.",
            "items":{
                "$ref":"#/components/schemas/deliverables-Attachment-item-response"
            }
        },
        "StatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Internal code of the status for the deliverable.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ProjectTaskAssociation":{
            "title":"Deliverable and Project Task Associations",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/deliverables-ProjectTaskAssociation-item-response"
            }
        },
        "RequirementAssociation":{
            "title":"Deliverable and Requirement Associations",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/deliverables-RequirementAssociation-item-response"
            }
        },
        "Type":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedById":{
            "type":"integer",
            "description":"Identifier of the person who created the deliverable.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "NeedByDate":{
            "title":"Need-by Date",
            "type":"string",
            "description":"Due date of the deliverable. If provided, it must be a valid date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerId":{
            "type":"integer",
            "description":"Identifier of the person who owns the deliverable.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DeliverableName":{
            "title":"Name",
            "maxLength":"150",
            "type":"string",
            "description":"Name of the deliverable. This field is mandatory for POST operation.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DeliverableId":{
            "type":"integer",
            "description":"Identifier of the deliverable. This field is mandatory for PATCH and DELETE operations.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "OwnerEmail":{
            "type":"string",
            "description":"Email address of the person who owns the deliverable.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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

• Array of: object deliverables-Attachment-item-response

{
    "title":"Attachment to a Deliverable",
    "type":"array",
    "description":"The attachment resource is used to create, view, update, or delete an attachment to a project deliverable.",
    "items":{
        "$ref":"#/components/schemas/deliverables-Attachment-item-response"
    }
}

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 : 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

• Array of: object deliverables-ProjectTaskAssociation-item-response

{
    "title":"Deliverable and Project Task Associations",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/deliverables-ProjectTaskAssociation-item-response"
    }
}

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

• Array of: object deliverables-RequirementAssociation-item-response

{
    "title":"Deliverable and Requirement Associations",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/deliverables-RequirementAssociation-item-response"
    }
}

Nested Schema : deliverables-Attachment-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  Identifier of the attachment.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  Category of the attachment. For POST or PATCH operations, the value must be Project Deliverable.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates if a file is shared.
• CreatedBy: string
  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.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  Name of the person who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date when the attachment was originally created. It is automatically populated as the date attachment was created.
• DatatypeCode: string
  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.
• Description: string
  Title: Description

  Maximum Length: 255

  Description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The unique identifier of the attachment.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The path to the folder where the uploaded file is stored.
• DmVersionNumber: string
  Maximum Length: 255

  The version number of the attachment.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  Error code, if the operation returns an error.
• ErrorStatusMessage: string
  Title: Error Status Message

  Error message, if the operation returns an error.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  Expiration date of the file on the file content server.
• FileContents: string (byte)
  Title: File Contents

  Contents of the attachment. This attribute is not being used.
• FileName: string
  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.
• FileUrl: string
  Title: File Url

  Location on the file content server of the attached document or text. This is null if the attachment type is URL.
• FileWebImage: string (byte)
  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.
• LastUpdateDate: string (date-time)
  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.
• LastUpdatedBy: string
  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.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  Name of the person who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  Title of the attachment.
• UploadedFileContentType: string
  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.
• UploadedFileLength: integer
  Title: File Size

  Size of the file uploaded as attachment. This is null if the attachment type is URL.
• UploadedFileName: string
  Title: Uploaded File Name

  Name of the attachment file. This attribute is not being used.
• UploadedText: string
  Title: Uploaded Text

  Text of the attachment. This attribute is not being used.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  Universal resource identifier, which is a unique identifier of the location on the Internet.
• Url: string
  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.
• UserName: string
  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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the attachment was originally created. It is automatically populated as the date attachment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"Description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"Universal resource identifier, which is a unique identifier of the location on the Internet.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"Universal Resource Locator, if the attachment type is URL. It is mandatory in POST operations if the attachment type is URL.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The unique identifier of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"Identifier of the attachment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Type of file uploaded as attachment, such as text, or Excel document. It is mandatory in POST operations if the attachment type is File.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"Name of the person who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Size of the file uploaded as attachment. This is null if the attachment type is URL.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The version number of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Error message, if the operation returns an error.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":"255",
            "type":"string",
            "description":"Category code of the attachment. For POST or PATCH operations, the value must be PROJECT_DELIVERABLE.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Type of attachment. Values are FILE, WEB_PAGE, or TEXT. Default value is TEXT. It is mandatory in POST operations.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"Name of the person who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Name of the attachment file. This attribute is not being used.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"Location on the file content server of the attached document or text. This is null if the attachment type is URL.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates if a file is shared.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the attachment. This attribute is not being used.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Expiration date of the file on the file content server.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Error code, if the operation returns an error.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"The path to the folder where the uploaded file is stored.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text of the attachment. This attribute is not being used.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"Category of the attachment. For POST or PATCH operations, the value must be Project Deliverable.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date when the attachment was last updated. In POST or PATCH operation it is automatically populated as the current date.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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."
        }
    }
}

Nested Schema : deliverables-ProjectTaskAssociation-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectAssociationId: integer (int64)
  Identifier of the association between task and deliverable. This field is mandatory for DELETE operations to remove the association.
• ProjectId: integer
  Identifier of the project associated with the deliverable.
• ProjectName: string
  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.
• ProjectNumber: string
  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.
• TaskId: integer (int64)
  Identifier of the task associated with the deliverable.
• TaskName: string
  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.
• TaskNumber: string
  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.

{
    "type":"object",
    "properties":{
        "TaskId":{
            "type":"integer",
            "description":"Identifier of the task associated with the deliverable.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProjectName":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "TaskName":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectAssociationId":{
            "type":"integer",
            "description":"Identifier of the association between task and deliverable. This field is mandatory for DELETE operations to remove the association.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ProjectNumber":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectId":{
            "type":"integer",
            "description":"Identifier of the project associated with the deliverable.",
            "nullable":true,
            "x-queryable":true
        },
        "TaskNumber":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : deliverables-RequirementAssociation-item-response

Type: object

Show Source

• BacklogItemId: integer (int64)
  Identifier of the backlog item associated with the deliverable.
• BacklogItemName: string
  Name of the backlog item associated with the deliverable. This field is mandatory for POST operation if the deliverable is associated with a backlog item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectAssociationId: integer (int64)
  Read Only: true

  Identifier of the association between backlog item and deliverable. This field is mandatory for DELETE operations to remove the association.
• OwnerEmail: string
  Email address of the owner of the backlog item associated with the deliverable.
• OwnerId: integer (int64)
  Owner of the backlog item associated with the deliverable.
• OwnerName: string
  Identifier of the owner of the backlog item associated with the deliverable.
• ProductName: string
  Name of the product that owns the backlog item that is associated with the deliverable.
• ReleaseName: string
  Name of the release that delivers the backlog item associated with the deliverable.
• RequirementCode: string
  Short code of the backlog item associated with the deliverable. This field is mandatory for POST operation if the deliverable is associated with a backlog item.
• ScrumMasterEmail: string
  Email address of the scrum master handling the backlog item associated with the deliverable.
• ScrumMasterId: integer
  Identifier of the scrum master handling the backlog item associated with the deliverable.
• ScrumMasterName: string
  Name of the scrum master handling the backlog item associated with the deliverable.
• SprintName: string
  Name of the sprint when the backlog item associated with the deliverable is completed.

{
    "type":"object",
    "properties":{
        "OwnerName":{
            "type":"string",
            "description":"Identifier of the owner of the backlog item associated with the deliverable.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductName":{
            "type":"string",
            "description":"Name of the product that owns the backlog item that is associated with the deliverable.",
            "nullable":true,
            "x-queryable":true
        },
        "BacklogItemId":{
            "type":"integer",
            "description":"Identifier of the backlog item associated with the deliverable.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReleaseName":{
            "type":"string",
            "description":"Name of the release that delivers the backlog item associated with the deliverable.",
            "nullable":true,
            "x-queryable":true
        },
        "RequirementCode":{
            "type":"string",
            "description":"Short code of the backlog item associated with the deliverable. This field is mandatory for POST operation if the deliverable is associated with a backlog item.",
            "nullable":true,
            "x-queryable":true
        },
        "ScrumMasterEmail":{
            "type":"string",
            "description":"Email address of the scrum master handling the backlog item associated with the deliverable.",
            "nullable":true,
            "x-queryable":true
        },
        "ScrumMasterName":{
            "type":"string",
            "description":"Name of the scrum master handling the backlog item associated with the deliverable.",
            "nullable":true,
            "x-queryable":true
        },
        "BacklogItemName":{
            "type":"string",
            "description":"Name of the backlog item associated with the deliverable. This field is mandatory for POST operation if the deliverable is associated with a backlog item.",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerId":{
            "type":"integer",
            "description":"Owner of the backlog item associated with the deliverable.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SprintName":{
            "type":"string",
            "description":"Name of the sprint when the backlog item associated with the deliverable is completed.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectAssociationId":{
            "type":"integer",
            "description":"Identifier of the association between backlog item and deliverable. This field is mandatory for DELETE operations to remove the association.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ScrumMasterId":{
            "type":"integer",
            "description":"Identifier of the scrum master handling the backlog item associated with the deliverable.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OwnerEmail":{
            "type":"string",
            "description":"Email address of the owner of the backlog item associated with the deliverable.",
            "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"
    }
}

Links

Attachment

Operation: /fscmRestApi/resources/11.13.18.05/deliverables/{DeliverableId}/child/Attachment

Parameters:

• DeliverableId: $request.path.DeliverableId

The attachment resource is used to create, view, update, or delete an attachment to a project deliverable.

ProjectTaskAssociation

Operation: /fscmRestApi/resources/11.13.18.05/deliverables/{DeliverableId}/child/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

Operation: /fscmRestApi/resources/11.13.18.05/deliverables/{DeliverableId}/child/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