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
Root Schema : schema
Type:
Show Source
object
-
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.
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 : schema
Type:
Show Source
object
-
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
-
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. -
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.
Nested Schema : schema
Type:
Show Source
object
-
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.
Nested Schema : deliverables-RequirementAssociation-item-post-request
Type:
Show Source
object
-
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.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
Root Schema : deliverables-item-response
Type:
Show Source
object
-
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.
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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:
Show Source
object
-
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
-
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. -
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : deliverables-ProjectTaskAssociation-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : deliverables-RequirementAssociation-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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. - DeliverableId:
- ProjectTaskAssociation
-
Operation: /fscmRestApi/resources/11.13.18.05/deliverables/{DeliverableId}/child/ProjectTaskAssociationParameters:
- 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. - DeliverableId:
- RequirementAssociation
-
Operation: /fscmRestApi/resources/11.13.18.05/deliverables/{DeliverableId}/child/RequirementAssociationParameters:
- 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. - DeliverableId: