Create associations between a deliverable and requirements
post
/fscmRestApi/resources/11.13.18.05/deliverables/{DeliverableId}/child/RequirementAssociation
Request
Path Parameters
-
DeliverableId(required): integer(int64)
Identifier of the deliverable. This field is mandatory for PATCH and DELETE operations.
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
-
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-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
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.