Jump to

• Request
• Response

Update an association between a deliverable and a requirement

patch

/fscmRestApi/resources/11.13.18.05/deliverables/{DeliverableId}/child/RequirementAssociation/{ObjectAssociationId}

Request

Path Parameters

• DeliverableId(required): integer(int64)
  Identifier of the deliverable. This field is mandatory for PATCH and DELETE operations.
• ObjectAssociationId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• Metadata-Context: string
  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: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

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

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

Back to Top