Jump to

• Request
• Response
• Examples

Create requirements

post

/fscmRestApi/resources/11.13.18.05/requirements

Request

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.
• Upsert-Mode: string
  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

• BacklogItems: array BacklogItems
  Title: BacklogItems

  The backlog item resource is used to view,create, or modify backlog items. A backlog item represents a unit of work that can be accomplished within a sprint.
• ChildRequirements: array ChildRequirements
  Title: ChildRequirements

  The requirements resource is used to view,create, or modify a requirement. A requirement can be a functionality or a feature planned to be delivered in a product.
• Owner: string
  Title: Requirement Owner

  Name of the requirement owner.
• OwnerEmail: string
  Title: Requirement Owner E-Mail

  Email of the requirement owner.
• ParentRqmtCode: string
  Title: Parent Requirement Code

  Unique code of the parent requirement.
• ParentRqmtId: integer (int64)
  Title: Parent Requirement ID

  Default Value: 111

  Unique identifier of the parent requirement.
• ParentRqmtName: string
  Title: Parent Requirement Name

  Name of the parent requirement.
• Priority: string
  Title: Requirement Priority

  Priority of the requirement.
• PriorityCode: string
  Title: Requirement Priority Code

  Maximum Length: 30

  Default Value: MEDIUM

  Unique code of the requirement priority.
• ProductName: string
  Title: Product Name

  Name of the product.
• RqmtCode: string
  Title: Requirement Code

  Maximum Length: 30

  Unique code of the requirement in the requirement hierarchy.
• RqmtName(required): string
  Title: Requirement Name

  Maximum Length: 100

  Name of the requirement.
• Status: string
  Title: Requirement Status

  Status of the requirement.
• StatusCode: string
  Title: Requirement Status Code

  Maximum Length: 30

  Default Value: DRAFT

  Unique code of the requirement status.

{ "required":[ "RqmtName" ], "type":"object", "properties":{ "Status":{ "title":"Requirement Status", "type":"string", "description":"Status of the requirement.", "nullable":true }, "Owner":{ "title":"Requirement Owner", "type":"string", "description":"Name of the requirement owner.", "nullable":true }, "ParentRqmtCode":{ "title":"Parent Requirement Code", "type":"string", "description":"Unique code of the parent requirement.", "nullable":true }, "ProductName":{ "title":"Product Name", "type":"string", "description":"Name of the product.", "nullable":true }, "BacklogItems":{ "title":"BacklogItems", "type":"array", "description":"The backlog item resource is used to view,create, or modify backlog items. A backlog item represents a unit of work that can be accomplished within a sprint.", "items":{ "$ref":"#/components/schemas/requirements-BacklogItems-item-post-request" } }, "Priority":{ "title":"Requirement Priority", "type":"string", "description":"Priority of the requirement.", "nullable":true }, "PriorityCode":{ "title":"Requirement Priority Code", "maxLength":30, "type":"string", "description":"Unique code of the requirement priority.", "nullable":true, "default":"MEDIUM", "x-hints":{ "DISPLAYHINT":"Hide" } }, "ParentRqmtId":{ "title":"Parent Requirement ID", "type":"integer", "description":"Unique identifier of the parent requirement.", "format":"int64", "nullable":true, "default":111, "x-hints":{ "DISPLAYHINT":"Hide", "precision":18 } }, "StatusCode":{ "title":"Requirement Status Code", "maxLength":30, "type":"string", "description":"Unique code of the requirement status.", "nullable":true, "default":"DRAFT", "x-hints":{ "DISPLAYHINT":"Hide" } }, "RqmtCode":{ "title":"Requirement Code", "maxLength":30, "type":"string", "description":"Unique code of the requirement in the requirement hierarchy.", "nullable":true }, "ParentRqmtName":{ "title":"Parent Requirement Name", "type":"string", "description":"Name of the parent requirement.", "nullable":true }, "RqmtName":{ "title":"Requirement Name", "maxLength":100, "type":"string", "description":"Name of the requirement.", "nullable":false }, "OwnerEmail":{ "title":"Requirement Owner E-Mail", "type":"string", "description":"Email of the requirement owner.", "nullable":true }, "ChildRequirements":{ "title":"ChildRequirements", "type":"array", "description":"The requirements resource is used to view,create, or modify a requirement. A requirement can be a functionality or a feature planned to be delivered in a product.", "items":{ "$ref":"#/components/schemas/requirements-ChildRequirements-item-post-request" } } } }

Nested Schema : BacklogItems

Type: array

Title: BacklogItems

The backlog item resource is used to view,create, or modify backlog items. A backlog item represents a unit of work that can be accomplished within a sprint.

Show Source

• Array of: object schema

{ "title":"BacklogItems", "type":"array", "description":"The backlog item resource is used to view,create, or modify backlog items. A backlog item represents a unit of work that can be accomplished within a sprint.", "items":{ "$ref":"#/components/schemas/requirements-BacklogItems-item-post-request" } }

Nested Schema : ChildRequirements

Type: array

Title: ChildRequirements

The requirements resource is used to view,create, or modify a requirement. A requirement can be a functionality or a feature planned to be delivered in a product.

Show Source

• Array of: object schema

{ "title":"ChildRequirements", "type":"array", "description":"The requirements resource is used to view,create, or modify a requirement. A requirement can be a functionality or a feature planned to be delivered in a product.", "items":{ "$ref":"#/components/schemas/requirements-ChildRequirements-item-post-request" } }

Nested Schema : schema

Type: object

Show Source

• AcceptanceCriteria: array AcceptanceCriterions
  Title: AcceptanceCriterions

  The acceptance criteria resource is used to view,create, or modify acceptance criteria of a backlogitem. Acceptance criteria is a condition that must be fulfilled for a backlog item to be complete.
• AdditionalDetails: string
  Title: Additional Details

  Maximum Length: 2000

  Additional description for the backlog item.
• BacklogItemCode: string
  Title: Backlog Item Code

  Maximum Length: 30

  Unique code of the backlog item.
• BacklogItemName(required): string
  Title: Backlog Item Name

  Maximum Length: 100

  Name of the backlog item.
• BacklogOwner: string
  Title: Backlog Item Owner

  Name of the backlog item owner.
• BacklogOwnerEmail: string
  Title: Backlog Item Owner E-Mail

  Email of the backlog item owner.
• BacklogPriority: string
  Title: Backlog Item Priority

  Name of the backlog item priority.
• BacklogPriorityCode: string
  Title: Backlog Item Priority Code

  Maximum Length: 30

  Default Value: MEDIUM

  Unique code of the backlog item priority.
• BacklogProductCode: string
  Title: Product Code

  Unique code of the product assigned to the backlog item.
• BacklogProductName: string
  Title: Product

  Maximum Length: 255

  Name of the product assigned to the backlog item.
• BacklogReleaseName: string
  Title: Release Name

  Name of the product release.
• BacklogReleaseNumber: string
  Title: Release Number

  Unique number of the product release assigned to the backlog item.
• BacklogStatus: string
  Title: Backlog Item Status

  Name of the backlog item status.
• BacklogStatusCode: string
  Title: Backlog Item Status Code

  Maximum Length: 30

  Default Value: DRAFT

  Unique code of the backlog item status.
• BacklogStorypoints: integer (int64)
  Title: Story Points

  A measure to determine the complexity of a backlog item.
• Effort: integer (int64)
  Title: Effort

  Effort in days to complete the backlog item.
• Rank: integer (int32)
  Title: Rank

  Number assigned to the backlog item to maintain a prioritized list of backlog items.
• RequirementCode: string
  Title: Requirement Code

  Unique code of the requirement.
• RequirementName: string
  Title: Requirement Name

  Name of the requirement.
• ScrumMasterEmail: string
  Title: Scrum Master E-Mail

  Email of the scrum master.
• ScrumMasterName: string
  Title: Scrum Master

  Name of the backlog item scrum master.
• Sprint: string
  Title: Sprint

  Maximum Length: 255

  Name of the sprint associated with the backlog item.
• UserStory: string
  Title: User Story

  Maximum Length: 2000

  An informative definition of the backlog item which helps to estimate the effort.

{ "required":[ "BacklogItemName" ], "type":"object", "properties":{ "AdditionalDetails":{ "title":"Additional Details", "maxLength":2000, "type":"string", "description":"Additional description for the backlog item.", "nullable":true, "x-queryable":false }, "BacklogOwnerEmail":{ "title":"Backlog Item Owner E-Mail", "type":"string", "description":"Email of the backlog item owner.", "nullable":true }, "BacklogPriority":{ "title":"Backlog Item Priority", "type":"string", "description":"Name of the backlog item priority.", "nullable":true }, "BacklogReleaseName":{ "title":"Release Name", "type":"string", "description":"Name of the product release.", "nullable":true, "x-queryable":false }, "Effort":{ "title":"Effort", "type":"integer", "description":"Effort in days to complete the backlog item.", "format":"int64", "nullable":true, "x-queryable":false, "x-hints":{ "precision":18 } }, "BacklogOwner":{ "title":"Backlog Item Owner", "type":"string", "description":"Name of the backlog item owner.", "nullable":true, "x-queryable":false }, "Rank":{ "title":"Rank", "type":"integer", "description":"Number assigned to the backlog item to maintain a prioritized list of backlog items.", "format":"int32", "nullable":true, "x-queryable":false, "x-hints":{ "precision":9 } }, "BacklogPriorityCode":{ "title":"Backlog Item Priority Code", "maxLength":30, "type":"string", "description":"Unique code of the backlog item priority.", "nullable":true, "default":"MEDIUM", "x-queryable":false }, "RequirementName":{ "title":"Requirement Name", "type":"string", "description":"Name of the requirement.", "nullable":true, "x-queryable":false }, "RequirementCode":{ "title":"Requirement Code", "type":"string", "description":"Unique code of the requirement.", "nullable":true }, "BacklogProductName":{ "title":"Product", "maxLength":255, "type":"string", "description":"Name of the product assigned to the backlog item.", "nullable":true, "x-queryable":false }, "ScrumMasterEmail":{ "title":"Scrum Master E-Mail", "type":"string", "description":"Email of the scrum master.", "nullable":true }, "UserStory":{ "title":"User Story", "maxLength":2000, "type":"string", "description":"An informative definition of the backlog item which helps to estimate the effort.", "nullable":true, "x-queryable":false }, "BacklogItemName":{ "title":"Backlog Item Name", "maxLength":100, "type":"string", "description":"Name of the backlog item.", "nullable":false }, "ScrumMasterName":{ "title":"Scrum Master", "type":"string", "description":"Name of the backlog item scrum master.", "nullable":true, "x-queryable":false }, "BacklogStorypoints":{ "title":"Story Points", "type":"integer", "description":"A measure to determine the complexity of a backlog item.", "format":"int64", "nullable":true, "x-queryable":false, "x-hints":{ "precision":18 } }, "BacklogProductCode":{ "title":"Product Code", "type":"string", "description":"Unique code of the product assigned to the backlog item.", "nullable":true }, "BacklogReleaseNumber":{ "title":"Release Number", "type":"string", "description":"Unique number of the product release assigned to the backlog item.", "nullable":true }, "BacklogItemCode":{ "title":"Backlog Item Code", "maxLength":30, "type":"string", "description":"Unique code of the backlog item.", "nullable":true }, "Sprint":{ "title":"Sprint", "maxLength":255, "type":"string", "description":"Name of the sprint associated with the backlog item.", "nullable":true, "x-queryable":false }, "BacklogStatusCode":{ "title":"Backlog Item Status Code", "maxLength":30, "type":"string", "description":"Unique code of the backlog item status.", "nullable":false, "default":"DRAFT" }, "AcceptanceCriteria":{ "title":"AcceptanceCriterions", "type":"array", "description":"The acceptance criteria resource is used to view,create, or modify acceptance criteria of a backlogitem. Acceptance criteria is a condition that must be fulfilled for a backlog item to be complete.", "items":{ "$ref":"#/components/schemas/requirements-BacklogItems-AcceptanceCriteria-item-post-request" } }, "BacklogStatus":{ "title":"Backlog Item Status", "type":"string", "description":"Name of the backlog item status.", "nullable":true } } }

Nested Schema : AcceptanceCriterions

Type: array

Title: AcceptanceCriterions

The acceptance criteria resource is used to view,create, or modify acceptance criteria of a backlogitem. Acceptance criteria is a condition that must be fulfilled for a backlog item to be complete.

Show Source

• Array of: object schema

{ "title":"AcceptanceCriterions", "type":"array", "description":"The acceptance criteria resource is used to view,create, or modify acceptance criteria of a backlogitem. Acceptance criteria is a condition that must be fulfilled for a backlog item to be complete.", "items":{ "$ref":"#/components/schemas/requirements-BacklogItems-AcceptanceCriteria-item-post-request" } }

Nested Schema : schema

Type: object

Show Source

• CriteriaName: string
  Title: Acceptance Criteria

  Maximum Length: 140

  Condition that must be fulfilled for considering the backlog item to be complete.

{ "type":"object", "properties":{ "CriteriaName":{ "title":"Acceptance Criteria", "maxLength":140, "type":"string", "description":"Condition that must be fulfilled for considering the backlog item to be complete.", "nullable":false } } }

Nested Schema : schema

Type: object

Show Source

• BacklogItems: array BacklogItems
  Title: BacklogItems

  The backlog item resource is used to view,create, or modify backlog items. A backlog item represents a unit of work that can be accomplished within a sprint.
• ChildRequirements: array ChildRequirements
  Title: ChildRequirements

  The requirements resource is used to view,create, or modify a requirement. A requirement can be a functionality or a feature planned to be delivered in a product.
• Owner: string
  Title: Requirement Owner

  Name of the requirement owner.
• OwnerEmail: string
  Title: Requirement Owner E-Mail

  Email of the requirement owner.
• ParentRqmtCode: string
  Title: Parent Requirement Code

  Unique code of the parent requirement.
• ParentRqmtId: integer (int64)
  Title: Parent Requirement ID

  Default Value: 111

  Unique identifier of the parent requirement.
• ParentRqmtName: string
  Title: Parent Requirement Name

  Name of the parent requirement.
• Priority: string
  Title: Requirement Priority

  Priority of the requirement.
• PriorityCode: string
  Title: Requirement Priority Code

  Maximum Length: 30

  Default Value: MEDIUM

  Unique code of the requirement priority.
• ProductName: string
  Title: Product Name

  Name of the product.
• RqmtCode: string
  Title: Requirement Code

  Maximum Length: 30

  Unique code of the requirement in the requirement hierarchy.
• RqmtName(required): string
  Title: Requirement Name

  Maximum Length: 100

  Name of the requirement.
• Status: string
  Title: Requirement Status

  Status of the requirement.
• StatusCode: string
  Title: Requirement Status Code

  Maximum Length: 30

  Default Value: DRAFT

  Unique code of the requirement status.

{ "required":[ "RqmtName" ], "type":"object", "properties":{ "Status":{ "title":"Requirement Status", "type":"string", "description":"Status of the requirement.", "nullable":true }, "Owner":{ "title":"Requirement Owner", "type":"string", "description":"Name of the requirement owner.", "nullable":true }, "ParentRqmtCode":{ "title":"Parent Requirement Code", "type":"string", "description":"Unique code of the parent requirement.", "nullable":true }, "ProductName":{ "title":"Product Name", "type":"string", "description":"Name of the product.", "nullable":true }, "BacklogItems":{ "title":"BacklogItems", "type":"array", "description":"The backlog item resource is used to view,create, or modify backlog items. A backlog item represents a unit of work that can be accomplished within a sprint.", "items":{ "$ref":"#/components/schemas/requirements-ChildRequirements-BacklogItems-item-post-request" } }, "Priority":{ "title":"Requirement Priority", "type":"string", "description":"Priority of the requirement.", "nullable":true }, "PriorityCode":{ "title":"Requirement Priority Code", "maxLength":30, "type":"string", "description":"Unique code of the requirement priority.", "nullable":true, "default":"MEDIUM", "x-hints":{ "DISPLAYHINT":"Hide" } }, "ParentRqmtId":{ "title":"Parent Requirement ID", "type":"integer", "description":"Unique identifier of the parent requirement.", "format":"int64", "nullable":true, "default":111, "x-hints":{ "DISPLAYHINT":"Hide", "precision":18 } }, "StatusCode":{ "title":"Requirement Status Code", "maxLength":30, "type":"string", "description":"Unique code of the requirement status.", "nullable":true, "default":"DRAFT", "x-hints":{ "DISPLAYHINT":"Hide" } }, "RqmtCode":{ "title":"Requirement Code", "maxLength":30, "type":"string", "description":"Unique code of the requirement in the requirement hierarchy.", "nullable":true }, "ParentRqmtName":{ "title":"Parent Requirement Name", "type":"string", "description":"Name of the parent requirement.", "nullable":true }, "RqmtName":{ "title":"Requirement Name", "maxLength":100, "type":"string", "description":"Name of the requirement.", "nullable":false }, "OwnerEmail":{ "title":"Requirement Owner E-Mail", "type":"string", "description":"Email of the requirement owner.", "nullable":true }, "ChildRequirements":{ "title":"ChildRequirements", "type":"array", "description":"The requirements resource is used to view,create, or modify a requirement. A requirement can be a functionality or a feature planned to be delivered in a product.", "items":{ "$ref":"#/components/schemas/requirements-ChildRequirements-ChildRequirements-item-post-request" } } } }

Nested Schema : BacklogItems

Type: array

Title: BacklogItems

The backlog item resource is used to view,create, or modify backlog items. A backlog item represents a unit of work that can be accomplished within a sprint.

Show Source

• Array of: object schema

{ "title":"BacklogItems", "type":"array", "description":"The backlog item resource is used to view,create, or modify backlog items. A backlog item represents a unit of work that can be accomplished within a sprint.", "items":{ "$ref":"#/components/schemas/requirements-ChildRequirements-BacklogItems-item-post-request" } }

Nested Schema : ChildRequirements

Type: array

Title: ChildRequirements

The requirements resource is used to view,create, or modify a requirement. A requirement can be a functionality or a feature planned to be delivered in a product.

Show Source

• Array of: object schema

{ "title":"ChildRequirements", "type":"array", "description":"The requirements resource is used to view,create, or modify a requirement. A requirement can be a functionality or a feature planned to be delivered in a product.", "items":{ "$ref":"#/components/schemas/requirements-ChildRequirements-ChildRequirements-item-post-request" } }

Nested Schema : schema

Type: object

Show Source

• AcceptanceCriteria: array AcceptanceCriterions
  Title: AcceptanceCriterions

  The acceptance criteria resource is used to view,create, or modify acceptance criteria of a backlogitem. Acceptance criteria is a condition that must be fulfilled for a backlog item to be complete.
• AdditionalDetails: string
  Title: Additional Details

  Maximum Length: 2000

  Additional description for the backlog item.
• BacklogItemCode: string
  Title: Backlog Item Code

  Maximum Length: 30

  Unique code of the backlog item.
• BacklogItemName(required): string
  Title: Backlog Item Name

  Maximum Length: 100

  Name of the backlog item.
• BacklogOwner: string
  Title: Backlog Item Owner

  Name of the backlog item owner.
• BacklogOwnerEmail: string
  Title: Backlog Item Owner E-Mail

  Email of the backlog item owner.
• BacklogPriority: string
  Title: Backlog Item Priority

  Name of the backlog item priority.
• BacklogPriorityCode: string
  Title: Backlog Item Priority Code

  Maximum Length: 30

  Default Value: MEDIUM

  Unique code of the backlog item priority.
• BacklogProductCode: string
  Title: Product Code

  Unique code of the product assigned to the backlog item.
• BacklogProductName: string
  Title: Product

  Maximum Length: 255

  Name of the product assigned to the backlog item.
• BacklogReleaseName: string
  Title: Release Name

  Name of the product release.
• BacklogReleaseNumber: string
  Title: Release Number

  Unique number of the product release assigned to the backlog item.
• BacklogStatus: string
  Title: Backlog Item Status

  Name of the backlog item status.
• BacklogStatusCode: string
  Title: Backlog Item Status Code

  Maximum Length: 30

  Default Value: DRAFT

  Unique code of the backlog item status.
• BacklogStorypoints: integer (int64)
  Title: Story Points

  A measure to determine the complexity of a backlog item.
• Effort: integer (int64)
  Title: Effort

  Effort in days to complete the backlog item.
• Rank: integer (int32)
  Title: Rank

  Number assigned to the backlog item to maintain a prioritized list of backlog items.
• RequirementCode: string
  Title: Requirement Code

  Unique code of the requirement.
• RequirementName: string
  Title: Requirement Name

  Name of the requirement.
• ScrumMasterEmail: string
  Title: Scrum Master E-Mail

  Email of the scrum master.
• ScrumMasterName: string
  Title: Scrum Master

  Name of the backlog item scrum master.
• Sprint: string
  Title: Sprint

  Maximum Length: 255

  Name of the sprint associated with the backlog item.
• UserStory: string
  Title: User Story

  Maximum Length: 2000

  An informative definition of the backlog item which helps to estimate the effort.

{ "required":[ "BacklogItemName" ], "type":"object", "properties":{ "AdditionalDetails":{ "title":"Additional Details", "maxLength":2000, "type":"string", "description":"Additional description for the backlog item.", "nullable":true, "x-queryable":false }, "BacklogOwnerEmail":{ "title":"Backlog Item Owner E-Mail", "type":"string", "description":"Email of the backlog item owner.", "nullable":true }, "BacklogPriority":{ "title":"Backlog Item Priority", "type":"string", "description":"Name of the backlog item priority.", "nullable":true }, "BacklogReleaseName":{ "title":"Release Name", "type":"string", "description":"Name of the product release.", "nullable":true, "x-queryable":false }, "Effort":{ "title":"Effort", "type":"integer", "description":"Effort in days to complete the backlog item.", "format":"int64", "nullable":true, "x-queryable":false, "x-hints":{ "precision":18 } }, "BacklogOwner":{ "title":"Backlog Item Owner", "type":"string", "description":"Name of the backlog item owner.", "nullable":true, "x-queryable":false }, "Rank":{ "title":"Rank", "type":"integer", "description":"Number assigned to the backlog item to maintain a prioritized list of backlog items.", "format":"int32", "nullable":true, "x-queryable":false, "x-hints":{ "precision":9 } }, "BacklogPriorityCode":{ "title":"Backlog Item Priority Code", "maxLength":30, "type":"string", "description":"Unique code of the backlog item priority.", "nullable":true, "default":"MEDIUM", "x-queryable":false }, "RequirementName":{ "title":"Requirement Name", "type":"string", "description":"Name of the requirement.", "nullable":true, "x-queryable":false }, "RequirementCode":{ "title":"Requirement Code", "type":"string", "description":"Unique code of the requirement.", "nullable":true }, "BacklogProductName":{ "title":"Product", "maxLength":255, "type":"string", "description":"Name of the product assigned to the backlog item.", "nullable":true, "x-queryable":false }, "ScrumMasterEmail":{ "title":"Scrum Master E-Mail", "type":"string", "description":"Email of the scrum master.", "nullable":true }, "UserStory":{ "title":"User Story", "maxLength":2000, "type":"string", "description":"An informative definition of the backlog item which helps to estimate the effort.", "nullable":true, "x-queryable":false }, "BacklogItemName":{ "title":"Backlog Item Name", "maxLength":100, "type":"string", "description":"Name of the backlog item.", "nullable":false }, "ScrumMasterName":{ "title":"Scrum Master", "type":"string", "description":"Name of the backlog item scrum master.", "nullable":true, "x-queryable":false }, "BacklogStorypoints":{ "title":"Story Points", "type":"integer", "description":"A measure to determine the complexity of a backlog item.", "format":"int64", "nullable":true, "x-queryable":false, "x-hints":{ "precision":18 } }, "BacklogProductCode":{ "title":"Product Code", "type":"string", "description":"Unique code of the product assigned to the backlog item.", "nullable":true }, "BacklogReleaseNumber":{ "title":"Release Number", "type":"string", "description":"Unique number of the product release assigned to the backlog item.", "nullable":true }, "BacklogItemCode":{ "title":"Backlog Item Code", "maxLength":30, "type":"string", "description":"Unique code of the backlog item.", "nullable":true }, "Sprint":{ "title":"Sprint", "maxLength":255, "type":"string", "description":"Name of the sprint associated with the backlog item.", "nullable":true, "x-queryable":false }, "BacklogStatusCode":{ "title":"Backlog Item Status Code", "maxLength":30, "type":"string", "description":"Unique code of the backlog item status.", "nullable":false, "default":"DRAFT" }, "AcceptanceCriteria":{ "title":"AcceptanceCriterions", "type":"array", "description":"The acceptance criteria resource is used to view,create, or modify acceptance criteria of a backlogitem. Acceptance criteria is a condition that must be fulfilled for a backlog item to be complete.", "items":{ "$ref":"#/components/schemas/requirements-ChildRequirements-BacklogItems-AcceptanceCriteria-item-post-request" } }, "BacklogStatus":{ "title":"Backlog Item Status", "type":"string", "description":"Name of the backlog item status.", "nullable":true } } }

Nested Schema : AcceptanceCriterions

Type: array

Title: AcceptanceCriterions

The acceptance criteria resource is used to view,create, or modify acceptance criteria of a backlogitem. Acceptance criteria is a condition that must be fulfilled for a backlog item to be complete.

Show Source

• Array of: object requirements-ChildRequirements-BacklogItems-AcceptanceCriteria-item-post-request

{ "title":"AcceptanceCriterions", "type":"array", "description":"The acceptance criteria resource is used to view,create, or modify acceptance criteria of a backlogitem. Acceptance criteria is a condition that must be fulfilled for a backlog item to be complete.", "items":{ "$ref":"#/components/schemas/requirements-ChildRequirements-BacklogItems-AcceptanceCriteria-item-post-request" } }

Nested Schema : requirements-ChildRequirements-BacklogItems-AcceptanceCriteria-item-post-request

Type: object

Show Source

• CriteriaName: string
  Title: Acceptance Criteria

  Maximum Length: 140

  Condition that must be fulfilled for considering the backlog item to be complete.

{ "type":"object", "properties":{ "CriteriaName":{ "title":"Acceptance Criteria", "maxLength":140, "type":"string", "description":"Condition that must be fulfilled for considering the backlog item to be complete.", "nullable":false } } }

Nested Schema : schema

Type: object

Show Source

• Owner: string
  Title: Requirement Owner

  Name of the requirement owner.
• OwnerEmail: string
  Title: Requirement Owner E-Mail

  Email of the requirement owner.
• ParentRqmtCode: string
  Title: Parent Requirement Code

  Unique code of the parent requirement.
• ParentRqmtId: integer (int64)
  Title: Parent Requirement ID

  Default Value: 111

  Unique identifier of the parent requirement.
• ParentRqmtName: string
  Title: Parent Requirement Name

  Name of the parent requirement.
• Priority: string
  Title: Requirement Priority

  Priority of the requirement.
• PriorityCode: string
  Title: Requirement Priority Code

  Maximum Length: 30

  Default Value: MEDIUM

  Unique code of the requirement priority.
• ProductName: string
  Title: Product Name

  Name of the product.
• RqmtCode: string
  Title: Requirement Code

  Maximum Length: 30

  Unique code of the requirement in the requirement hierarchy.
• RqmtName: string
  Title: Requirement Name

  Maximum Length: 100

  Name of the requirement.
• Status: string
  Title: Requirement Status

  Status of the requirement.
• StatusCode: string
  Title: Requirement Status Code

  Maximum Length: 30

  Default Value: DRAFT

  Unique code of the requirement status.

{ "type":"object", "properties":{ "Status":{ "title":"Requirement Status", "type":"string", "description":"Status of the requirement.", "nullable":true }, "Owner":{ "title":"Requirement Owner", "type":"string", "description":"Name of the requirement owner.", "nullable":true }, "ParentRqmtCode":{ "title":"Parent Requirement Code", "type":"string", "description":"Unique code of the parent requirement.", "nullable":true }, "ProductName":{ "title":"Product Name", "type":"string", "description":"Name of the product.", "nullable":true }, "Priority":{ "title":"Requirement Priority", "type":"string", "description":"Priority of the requirement.", "nullable":true }, "PriorityCode":{ "title":"Requirement Priority Code", "maxLength":30, "type":"string", "description":"Unique code of the requirement priority.", "nullable":true, "default":"MEDIUM", "x-hints":{ "DISPLAYHINT":"Hide" } }, "ParentRqmtId":{ "title":"Parent Requirement ID", "type":"integer", "description":"Unique identifier of the parent requirement.", "format":"int64", "nullable":true, "default":111, "x-hints":{ "DISPLAYHINT":"Hide", "precision":18 } }, "StatusCode":{ "title":"Requirement Status Code", "maxLength":30, "type":"string", "description":"Unique code of the requirement status.", "nullable":true, "default":"DRAFT", "x-hints":{ "DISPLAYHINT":"Hide" } }, "RqmtCode":{ "title":"Requirement Code", "maxLength":30, "type":"string", "description":"Unique code of the requirement in the requirement hierarchy.", "nullable":true }, "ParentRqmtName":{ "title":"Parent Requirement Name", "type":"string", "description":"Name of the parent requirement.", "nullable":true }, "RqmtName":{ "title":"Requirement Name", "maxLength":100, "type":"string", "description":"Name of the requirement.", "nullable":false }, "OwnerEmail":{ "title":"Requirement Owner E-Mail", "type":"string", "description":"Email of the requirement owner.", "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 : requirements-item-response

Type: object

Show Source

• BacklogItems: array BacklogItems
  Title: BacklogItems

  The backlog item resource is used to view,create, or modify backlog items. A backlog item represents a unit of work that can be accomplished within a sprint.
• ChildRequirements: array ChildRequirements
  Title: ChildRequirements

  The requirements resource is used to view,create, or modify a requirement. A requirement can be a functionality or a feature planned to be delivered in a product.
• links: array Links
  Title: Links

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

  Name of the requirement owner.
• OwnerEmail: string
  Title: Requirement Owner E-Mail

  Email of the requirement owner.
• ParentRqmtCode: string
  Title: Parent Requirement Code

  Unique code of the parent requirement.
• ParentRqmtId: integer (int64)
  Title: Parent Requirement ID

  Default Value: 111

  Unique identifier of the parent requirement.
• ParentRqmtName: string
  Title: Parent Requirement Name

  Name of the parent requirement.
• Priority: string
  Title: Requirement Priority

  Priority of the requirement.
• PriorityCode: string
  Title: Requirement Priority Code

  Maximum Length: 30

  Default Value: MEDIUM

  Unique code of the requirement priority.
• ProductCode: string
  Title: Product Code

  Read Only: true

  Maximum Length: 30

  Unique code of the product.
• ProductName: string
  Title: Product Name

  Name of the product.
• ReleaseName: string
  Title: Release Name

  Read Only: true

  Maximum Length: 50

  Name of the product release.
• ReleaseNumber: string
  Title: Release Number

  Read Only: true

  Maximum Length: 30

  Unique number of the product release.
• RqmtCode: string
  Title: Requirement Code

  Maximum Length: 30

  Unique code of the requirement in the requirement hierarchy.
• RqmtId: integer (int64)
  Title: Requirement ID

  Read Only: true

  Unique identifier of the project requirement in the requirement hierarchy.
• RqmtName: string
  Title: Requirement Name

  Maximum Length: 100

  Name of the requirement.
• Status: string
  Title: Requirement Status

  Status of the requirement.
• StatusCode: string
  Title: Requirement Status Code

  Maximum Length: 30

  Default Value: DRAFT

  Unique code of the requirement status.

{ "type":"object", "properties":{ "Status":{ "title":"Requirement Status", "type":"string", "description":"Status of the requirement.", "nullable":true, "x-queryable":true }, "Owner":{ "title":"Requirement Owner", "type":"string", "description":"Name of the requirement owner.", "nullable":true, "x-queryable":true }, "ParentRqmtCode":{ "title":"Parent Requirement Code", "type":"string", "description":"Unique code of the parent requirement.", "nullable":true, "x-queryable":true }, "ProductName":{ "title":"Product Name", "type":"string", "description":"Name of the product.", "nullable":true, "x-queryable":true }, "ProductCode":{ "title":"Product Code", "maxLength":30, "type":"string", "description":"Unique code of the product.", "nullable":false, "readOnly":true, "x-queryable":true }, "BacklogItems":{ "title":"BacklogItems", "type":"array", "description":"The backlog item resource is used to view,create, or modify backlog items. A backlog item represents a unit of work that can be accomplished within a sprint.", "items":{ "$ref":"#/components/schemas/requirements-BacklogItems-item-response" } }, "Priority":{ "title":"Requirement Priority", "type":"string", "description":"Priority of the requirement.", "nullable":true, "x-queryable":true }, "PriorityCode":{ "title":"Requirement Priority Code", "maxLength":30, "type":"string", "description":"Unique code of the requirement priority.", "nullable":true, "default":"MEDIUM", "x-hints":{ "DISPLAYHINT":"Hide" }, "x-queryable":true }, "ParentRqmtId":{ "title":"Parent Requirement ID", "type":"integer", "description":"Unique identifier of the parent requirement.", "format":"int64", "nullable":true, "default":111, "x-hints":{ "DISPLAYHINT":"Hide", "precision":18 }, "x-queryable":true }, "ReleaseName":{ "title":"Release Name", "maxLength":50, "type":"string", "description":"Name of the product release.", "nullable":false, "readOnly":true, "x-hints":{ "dependencies":[ "ReleaseId" ] }, "x-queryable":true }, "StatusCode":{ "title":"Requirement Status Code", "maxLength":30, "type":"string", "description":"Unique code of the requirement status.", "nullable":true, "default":"DRAFT", "x-hints":{ "DISPLAYHINT":"Hide" }, "x-queryable":true }, "RqmtCode":{ "title":"Requirement Code", "maxLength":30, "type":"string", "description":"Unique code of the requirement in the requirement hierarchy.", "nullable":true, "x-queryable":true }, "RqmtId":{ "title":"Requirement ID", "type":"integer", "description":"Unique identifier of the project requirement in the requirement hierarchy.", "format":"int64", "nullable":false, "readOnly":true, "x-hints":{ "precision":18 }, "x-queryable":true }, "ParentRqmtName":{ "title":"Parent Requirement Name", "type":"string", "description":"Name of the parent requirement.", "nullable":true, "x-queryable":true }, "RqmtName":{ "title":"Requirement Name", "maxLength":100, "type":"string", "description":"Name of the requirement.", "nullable":false, "x-queryable":true }, "links":{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }, "ReleaseNumber":{ "title":"Release Number", "maxLength":30, "type":"string", "description":"Unique number of the product release.", "nullable":false, "readOnly":true, "x-queryable":true }, "OwnerEmail":{ "title":"Requirement Owner E-Mail", "type":"string", "description":"Email of the requirement owner.", "nullable":true, "x-queryable":true }, "ChildRequirements":{ "title":"ChildRequirements", "type":"array", "description":"The requirements resource is used to view,create, or modify a requirement. A requirement can be a functionality or a feature planned to be delivered in a product.", "items":{ "$ref":"#/components/schemas/requirements-ChildRequirements-item-response" } } } }

Nested Schema : BacklogItems

Type: array

Title: BacklogItems

The backlog item resource is used to view,create, or modify backlog items. A backlog item represents a unit of work that can be accomplished within a sprint.

Show Source

• Array of: object requirements-BacklogItems-item-response

{ "title":"BacklogItems", "type":"array", "description":"The backlog item resource is used to view,create, or modify backlog items. A backlog item represents a unit of work that can be accomplished within a sprint.", "items":{ "$ref":"#/components/schemas/requirements-BacklogItems-item-response" } }

Nested Schema : ChildRequirements

Type: array

Title: ChildRequirements

The requirements resource is used to view,create, or modify a requirement. A requirement can be a functionality or a feature planned to be delivered in a product.

Show Source

• Array of: object requirements-ChildRequirements-item-response

{ "title":"ChildRequirements", "type":"array", "description":"The requirements resource is used to view,create, or modify a requirement. A requirement can be a functionality or a feature planned to be delivered in a product.", "items":{ "$ref":"#/components/schemas/requirements-ChildRequirements-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 : requirements-BacklogItems-item-response

Type: object

Show Source

• AcceptanceCriteria: array AcceptanceCriterions
  Title: AcceptanceCriterions

  The acceptance criteria resource is used to view,create, or modify acceptance criteria of a backlogitem. Acceptance criteria is a condition that must be fulfilled for a backlog item to be complete.
• AdditionalDetails: string
  Title: Additional Details

  Maximum Length: 2000

  Additional description for the backlog item.
• BacklogItemCode: string
  Title: Backlog Item Code

  Maximum Length: 30

  Unique code of the backlog item.
• BacklogItemId: integer (int64)
  Title: Backlog Item ID

  Read Only: true

  Unique identifier of the backlog item.
• BacklogItemName: string
  Title: Backlog Item Name

  Maximum Length: 100

  Name of the backlog item.
• BacklogOwner: string
  Title: Backlog Item Owner

  Name of the backlog item owner.
• BacklogOwnerEmail: string
  Title: Backlog Item Owner E-Mail

  Email of the backlog item owner.
• BacklogPriority: string
  Title: Backlog Item Priority

  Name of the backlog item priority.
• BacklogPriorityCode: string
  Title: Backlog Item Priority Code

  Maximum Length: 30

  Default Value: MEDIUM

  Unique code of the backlog item priority.
• BacklogProductCode: string
  Title: Product Code

  Unique code of the product assigned to the backlog item.
• BacklogProductName: string
  Title: Product

  Maximum Length: 255

  Name of the product assigned to the backlog item.
• BacklogReleaseName: string
  Title: Release Name

  Name of the product release.
• BacklogReleaseNumber: string
  Title: Release Number

  Unique number of the product release assigned to the backlog item.
• BacklogStatus: string
  Title: Backlog Item Status

  Name of the backlog item status.
• BacklogStatusCode: string
  Title: Backlog Item Status Code

  Maximum Length: 30

  Default Value: DRAFT

  Unique code of the backlog item status.
• BacklogStorypoints: integer (int64)
  Title: Story Points

  A measure to determine the complexity of a backlog item.
• Effort: integer (int64)
  Title: Effort

  Effort in days to complete the backlog item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Rank: integer (int32)
  Title: Rank

  Number assigned to the backlog item to maintain a prioritized list of backlog items.
• RequirementCode: string
  Title: Requirement Code

  Unique code of the requirement.
• RequirementName: string
  Title: Requirement Name

  Name of the requirement.
• ScrumMasterEmail: string
  Title: Scrum Master E-Mail

  Email of the scrum master.
• ScrumMasterName: string
  Title: Scrum Master

  Name of the backlog item scrum master.
• Sprint: string
  Title: Sprint

  Maximum Length: 255

  Name of the sprint associated with the backlog item.
• UserStory: string
  Title: User Story

  Maximum Length: 2000

  An informative definition of the backlog item which helps to estimate the effort.

{ "type":"object", "properties":{ "AdditionalDetails":{ "title":"Additional Details", "maxLength":2000, "type":"string", "description":"Additional description for the backlog item.", "nullable":true, "x-queryable":false }, "BacklogReleaseName":{ "title":"Release Name", "type":"string", "description":"Name of the product release.", "nullable":true, "x-queryable":false }, "Effort":{ "title":"Effort", "type":"integer", "description":"Effort in days to complete the backlog item.", "format":"int64", "nullable":true, "x-queryable":false, "x-hints":{ "precision":18 } }, "BacklogItemId":{ "title":"Backlog Item ID", "type":"integer", "description":"Unique identifier of the backlog item.", "format":"int64", "nullable":false, "readOnly":true, "x-hints":{ "precision":18 }, "x-queryable":true }, "BacklogOwner":{ "title":"Backlog Item Owner", "type":"string", "description":"Name of the backlog item owner.", "nullable":true, "x-queryable":false }, "BacklogPriorityCode":{ "title":"Backlog Item Priority Code", "maxLength":30, "type":"string", "description":"Unique code of the backlog item priority.", "nullable":true, "default":"MEDIUM", "x-queryable":false }, "RequirementName":{ "title":"Requirement Name", "type":"string", "description":"Name of the requirement.", "nullable":true, "x-queryable":false }, "RequirementCode":{ "title":"Requirement Code", "type":"string", "description":"Unique code of the requirement.", "nullable":true, "x-queryable":true }, "BacklogProductName":{ "title":"Product", "maxLength":255, "type":"string", "description":"Name of the product assigned to the backlog item.", "nullable":true, "x-queryable":false }, "ScrumMasterEmail":{ "title":"Scrum Master E-Mail", "type":"string", "description":"Email of the scrum master.", "nullable":true, "x-queryable":true }, "UserStory":{ "title":"User Story", "maxLength":2000, "type":"string", "description":"An informative definition of the backlog item which helps to estimate the effort.", "nullable":true, "x-queryable":false }, "BacklogItemName":{ "title":"Backlog Item Name", "maxLength":100, "type":"string", "description":"Name of the backlog item.", "nullable":false, "x-queryable":true }, "ScrumMasterName":{ "title":"Scrum Master", "type":"string", "description":"Name of the backlog item scrum master.", "nullable":true, "x-queryable":false }, "BacklogReleaseNumber":{ "title":"Release Number", "type":"string", "description":"Unique number of the product release assigned to the backlog item.", "nullable":true, "x-queryable":true }, "links":{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }, "BacklogOwnerEmail":{ "title":"Backlog Item Owner E-Mail", "type":"string", "description":"Email of the backlog item owner.", "nullable":true, "x-queryable":true }, "BacklogPriority":{ "title":"Backlog Item Priority", "type":"string", "description":"Name of the backlog item priority.", "nullable":true, "x-queryable":true }, "Rank":{ "title":"Rank", "type":"integer", "description":"Number assigned to the backlog item to maintain a prioritized list of backlog items.", "format":"int32", "nullable":true, "x-queryable":false, "x-hints":{ "precision":9 } }, "BacklogStorypoints":{ "title":"Story Points", "type":"integer", "description":"A measure to determine the complexity of a backlog item.", "format":"int64", "nullable":true, "x-queryable":false, "x-hints":{ "precision":18 } }, "BacklogProductCode":{ "title":"Product Code", "type":"string", "description":"Unique code of the product assigned to the backlog item.", "nullable":true, "x-queryable":true }, "BacklogItemCode":{ "title":"Backlog Item Code", "maxLength":30, "type":"string", "description":"Unique code of the backlog item.", "nullable":true, "x-queryable":true }, "Sprint":{ "title":"Sprint", "maxLength":255, "type":"string", "description":"Name of the sprint associated with the backlog item.", "nullable":true, "x-queryable":false }, "BacklogStatusCode":{ "title":"Backlog Item Status Code", "maxLength":30, "type":"string", "description":"Unique code of the backlog item status.", "nullable":false, "default":"DRAFT", "x-queryable":true }, "AcceptanceCriteria":{ "title":"AcceptanceCriterions", "type":"array", "description":"The acceptance criteria resource is used to view,create, or modify acceptance criteria of a backlogitem. Acceptance criteria is a condition that must be fulfilled for a backlog item to be complete.", "items":{ "$ref":"#/components/schemas/requirements-BacklogItems-AcceptanceCriteria-item-response" } }, "BacklogStatus":{ "title":"Backlog Item Status", "type":"string", "description":"Name of the backlog item status.", "nullable":true, "x-queryable":true } } }

Nested Schema : AcceptanceCriterions

Type: array

Title: AcceptanceCriterions

The acceptance criteria resource is used to view,create, or modify acceptance criteria of a backlogitem. Acceptance criteria is a condition that must be fulfilled for a backlog item to be complete.

Show Source

• Array of: object requirements-BacklogItems-AcceptanceCriteria-item-response

{ "title":"AcceptanceCriterions", "type":"array", "description":"The acceptance criteria resource is used to view,create, or modify acceptance criteria of a backlogitem. Acceptance criteria is a condition that must be fulfilled for a backlog item to be complete.", "items":{ "$ref":"#/components/schemas/requirements-BacklogItems-AcceptanceCriteria-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 : requirements-BacklogItems-AcceptanceCriteria-item-response

Type: object

Show Source

• CriteriaId: integer (int64)
  Title: Acceptance Criteria ID

  Read Only: true

  Unique identifier of the acceptance criteria under the backlog item.
• CriteriaName: string
  Title: Acceptance Criteria

  Maximum Length: 140

  Condition that must be fulfilled for considering the backlog item to be complete.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{ "type":"object", "properties":{ "links":{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }, "CriteriaId":{ "title":"Acceptance Criteria ID", "type":"integer", "description":"Unique identifier of the acceptance criteria under the backlog item.", "format":"int64", "nullable":false, "readOnly":true, "x-hints":{ "precision":18 }, "x-queryable":true }, "CriteriaName":{ "title":"Acceptance Criteria", "maxLength":140, "type":"string", "description":"Condition that must be fulfilled for considering the backlog item to be complete.", "nullable":false, "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." } } }

Nested Schema : requirements-ChildRequirements-item-response

Type: object

Show Source

• BacklogItems: array BacklogItems
  Title: BacklogItems

  The backlog item resource is used to view,create, or modify backlog items. A backlog item represents a unit of work that can be accomplished within a sprint.
• ChildRequirements: array ChildRequirements
  Title: ChildRequirements

  The requirements resource is used to view,create, or modify a requirement. A requirement can be a functionality or a feature planned to be delivered in a product.
• links: array Links
  Title: Links

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

  Name of the requirement owner.
• OwnerEmail: string
  Title: Requirement Owner E-Mail

  Email of the requirement owner.
• ParentRqmtCode: string
  Title: Parent Requirement Code

  Unique code of the parent requirement.
• ParentRqmtId: integer (int64)
  Title: Parent Requirement ID

  Default Value: 111

  Unique identifier of the parent requirement.
• ParentRqmtName: string
  Title: Parent Requirement Name

  Name of the parent requirement.
• Priority: string
  Title: Requirement Priority

  Priority of the requirement.
• PriorityCode: string
  Title: Requirement Priority Code

  Maximum Length: 30

  Default Value: MEDIUM

  Unique code of the requirement priority.
• ProductCode: string
  Title: Product Code

  Read Only: true

  Maximum Length: 30

  Unique code of the product.
• ProductName: string
  Title: Product Name

  Name of the product.
• ReleaseName: string
  Title: Release Name

  Read Only: true

  Maximum Length: 50

  Name of the product release.
• ReleaseNumber: string
  Title: Release Number

  Read Only: true

  Maximum Length: 30

  Unique number of the product release.
• RqmtCode: string
  Title: Requirement Code

  Maximum Length: 30

  Unique code of the requirement in the requirement hierarchy.
• RqmtId: integer (int64)
  Title: Requirement ID

  Read Only: true

  Unique identifier of the project requirement in the requirement hierarchy.
• RqmtName: string
  Title: Requirement Name

  Maximum Length: 100

  Name of the requirement.
• Status: string
  Title: Requirement Status

  Status of the requirement.
• StatusCode: string
  Title: Requirement Status Code

  Maximum Length: 30

  Default Value: DRAFT

  Unique code of the requirement status.

{ "type":"object", "properties":{ "Status":{ "title":"Requirement Status", "type":"string", "description":"Status of the requirement.", "nullable":true, "x-queryable":true }, "Owner":{ "title":"Requirement Owner", "type":"string", "description":"Name of the requirement owner.", "nullable":true, "x-queryable":true }, "ParentRqmtCode":{ "title":"Parent Requirement Code", "type":"string", "description":"Unique code of the parent requirement.", "nullable":true, "x-queryable":true }, "ProductName":{ "title":"Product Name", "type":"string", "description":"Name of the product.", "nullable":true, "x-queryable":true }, "ProductCode":{ "title":"Product Code", "maxLength":30, "type":"string", "description":"Unique code of the product.", "nullable":false, "readOnly":true, "x-queryable":true }, "BacklogItems":{ "title":"BacklogItems", "type":"array", "description":"The backlog item resource is used to view,create, or modify backlog items. A backlog item represents a unit of work that can be accomplished within a sprint.", "items":{ "$ref":"#/components/schemas/requirements-ChildRequirements-BacklogItems-item-response" } }, "Priority":{ "title":"Requirement Priority", "type":"string", "description":"Priority of the requirement.", "nullable":true, "x-queryable":true }, "PriorityCode":{ "title":"Requirement Priority Code", "maxLength":30, "type":"string", "description":"Unique code of the requirement priority.", "nullable":true, "default":"MEDIUM", "x-hints":{ "DISPLAYHINT":"Hide" }, "x-queryable":true }, "ParentRqmtId":{ "title":"Parent Requirement ID", "type":"integer", "description":"Unique identifier of the parent requirement.", "format":"int64", "nullable":true, "default":111, "x-hints":{ "DISPLAYHINT":"Hide", "precision":18 }, "x-queryable":true }, "ReleaseName":{ "title":"Release Name", "maxLength":50, "type":"string", "description":"Name of the product release.", "nullable":false, "readOnly":true, "x-hints":{ "dependencies":[ "ReleaseId" ] }, "x-queryable":true }, "StatusCode":{ "title":"Requirement Status Code", "maxLength":30, "type":"string", "description":"Unique code of the requirement status.", "nullable":true, "default":"DRAFT", "x-hints":{ "DISPLAYHINT":"Hide" }, "x-queryable":true }, "RqmtCode":{ "title":"Requirement Code", "maxLength":30, "type":"string", "description":"Unique code of the requirement in the requirement hierarchy.", "nullable":true, "x-queryable":true }, "RqmtId":{ "title":"Requirement ID", "type":"integer", "description":"Unique identifier of the project requirement in the requirement hierarchy.", "format":"int64", "nullable":false, "readOnly":true, "x-hints":{ "precision":18 }, "x-queryable":true }, "ParentRqmtName":{ "title":"Parent Requirement Name", "type":"string", "description":"Name of the parent requirement.", "nullable":true, "x-queryable":true }, "RqmtName":{ "title":"Requirement Name", "maxLength":100, "type":"string", "description":"Name of the requirement.", "nullable":false, "x-queryable":true }, "links":{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }, "ReleaseNumber":{ "title":"Release Number", "maxLength":30, "type":"string", "description":"Unique number of the product release.", "nullable":false, "readOnly":true, "x-queryable":true }, "OwnerEmail":{ "title":"Requirement Owner E-Mail", "type":"string", "description":"Email of the requirement owner.", "nullable":true, "x-queryable":true }, "ChildRequirements":{ "title":"ChildRequirements", "type":"array", "description":"The requirements resource is used to view,create, or modify a requirement. A requirement can be a functionality or a feature planned to be delivered in a product.", "items":{ "$ref":"#/components/schemas/requirements-ChildRequirements-ChildRequirements-item-response" } } } }

Nested Schema : BacklogItems

Type: array

Title: BacklogItems

The backlog item resource is used to view,create, or modify backlog items. A backlog item represents a unit of work that can be accomplished within a sprint.

Show Source

• Array of: object requirements-ChildRequirements-BacklogItems-item-response

{ "title":"BacklogItems", "type":"array", "description":"The backlog item resource is used to view,create, or modify backlog items. A backlog item represents a unit of work that can be accomplished within a sprint.", "items":{ "$ref":"#/components/schemas/requirements-ChildRequirements-BacklogItems-item-response" } }

Nested Schema : ChildRequirements

Type: array

Title: ChildRequirements

The requirements resource is used to view,create, or modify a requirement. A requirement can be a functionality or a feature planned to be delivered in a product.

Show Source

• Array of: object requirements-ChildRequirements-ChildRequirements-item-response

{ "title":"ChildRequirements", "type":"array", "description":"The requirements resource is used to view,create, or modify a requirement. A requirement can be a functionality or a feature planned to be delivered in a product.", "items":{ "$ref":"#/components/schemas/requirements-ChildRequirements-ChildRequirements-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 : requirements-ChildRequirements-BacklogItems-item-response

Type: object

Show Source

• AcceptanceCriteria: array AcceptanceCriterions
  Title: AcceptanceCriterions

  The acceptance criteria resource is used to view,create, or modify acceptance criteria of a backlogitem. Acceptance criteria is a condition that must be fulfilled for a backlog item to be complete.
• AdditionalDetails: string
  Title: Additional Details

  Maximum Length: 2000

  Additional description for the backlog item.
• BacklogItemCode: string
  Title: Backlog Item Code

  Maximum Length: 30

  Unique code of the backlog item.
• BacklogItemId: integer (int64)
  Title: Backlog Item ID

  Read Only: true

  Unique identifier of the backlog item.
• BacklogItemName: string
  Title: Backlog Item Name

  Maximum Length: 100

  Name of the backlog item.
• BacklogOwner: string
  Title: Backlog Item Owner

  Name of the backlog item owner.
• BacklogOwnerEmail: string
  Title: Backlog Item Owner E-Mail

  Email of the backlog item owner.
• BacklogPriority: string
  Title: Backlog Item Priority

  Name of the backlog item priority.
• BacklogPriorityCode: string
  Title: Backlog Item Priority Code

  Maximum Length: 30

  Default Value: MEDIUM

  Unique code of the backlog item priority.
• BacklogProductCode: string
  Title: Product Code

  Unique code of the product assigned to the backlog item.
• BacklogProductName: string
  Title: Product

  Maximum Length: 255

  Name of the product assigned to the backlog item.
• BacklogReleaseName: string
  Title: Release Name

  Name of the product release.
• BacklogReleaseNumber: string
  Title: Release Number

  Unique number of the product release assigned to the backlog item.
• BacklogStatus: string
  Title: Backlog Item Status

  Name of the backlog item status.
• BacklogStatusCode: string
  Title: Backlog Item Status Code

  Maximum Length: 30

  Default Value: DRAFT

  Unique code of the backlog item status.
• BacklogStorypoints: integer (int64)
  Title: Story Points

  A measure to determine the complexity of a backlog item.
• Effort: integer (int64)
  Title: Effort

  Effort in days to complete the backlog item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Rank: integer (int32)
  Title: Rank

  Number assigned to the backlog item to maintain a prioritized list of backlog items.
• RequirementCode: string
  Title: Requirement Code

  Unique code of the requirement.
• RequirementName: string
  Title: Requirement Name

  Name of the requirement.
• ScrumMasterEmail: string
  Title: Scrum Master E-Mail

  Email of the scrum master.
• ScrumMasterName: string
  Title: Scrum Master

  Name of the backlog item scrum master.
• Sprint: string
  Title: Sprint

  Maximum Length: 255

  Name of the sprint associated with the backlog item.
• UserStory: string
  Title: User Story

  Maximum Length: 2000

  An informative definition of the backlog item which helps to estimate the effort.

{ "type":"object", "properties":{ "AdditionalDetails":{ "title":"Additional Details", "maxLength":2000, "type":"string", "description":"Additional description for the backlog item.", "nullable":true, "x-queryable":false }, "BacklogReleaseName":{ "title":"Release Name", "type":"string", "description":"Name of the product release.", "nullable":true, "x-queryable":false }, "Effort":{ "title":"Effort", "type":"integer", "description":"Effort in days to complete the backlog item.", "format":"int64", "nullable":true, "x-queryable":false, "x-hints":{ "precision":18 } }, "BacklogItemId":{ "title":"Backlog Item ID", "type":"integer", "description":"Unique identifier of the backlog item.", "format":"int64", "nullable":false, "readOnly":true, "x-hints":{ "precision":18 }, "x-queryable":true }, "BacklogOwner":{ "title":"Backlog Item Owner", "type":"string", "description":"Name of the backlog item owner.", "nullable":true, "x-queryable":false }, "BacklogPriorityCode":{ "title":"Backlog Item Priority Code", "maxLength":30, "type":"string", "description":"Unique code of the backlog item priority.", "nullable":true, "default":"MEDIUM", "x-queryable":false }, "RequirementName":{ "title":"Requirement Name", "type":"string", "description":"Name of the requirement.", "nullable":true, "x-queryable":false }, "RequirementCode":{ "title":"Requirement Code", "type":"string", "description":"Unique code of the requirement.", "nullable":true, "x-queryable":true }, "BacklogProductName":{ "title":"Product", "maxLength":255, "type":"string", "description":"Name of the product assigned to the backlog item.", "nullable":true, "x-queryable":false }, "ScrumMasterEmail":{ "title":"Scrum Master E-Mail", "type":"string", "description":"Email of the scrum master.", "nullable":true, "x-queryable":true }, "UserStory":{ "title":"User Story", "maxLength":2000, "type":"string", "description":"An informative definition of the backlog item which helps to estimate the effort.", "nullable":true, "x-queryable":false }, "BacklogItemName":{ "title":"Backlog Item Name", "maxLength":100, "type":"string", "description":"Name of the backlog item.", "nullable":false, "x-queryable":true }, "ScrumMasterName":{ "title":"Scrum Master", "type":"string", "description":"Name of the backlog item scrum master.", "nullable":true, "x-queryable":false }, "BacklogReleaseNumber":{ "title":"Release Number", "type":"string", "description":"Unique number of the product release assigned to the backlog item.", "nullable":true, "x-queryable":true }, "links":{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }, "BacklogOwnerEmail":{ "title":"Backlog Item Owner E-Mail", "type":"string", "description":"Email of the backlog item owner.", "nullable":true, "x-queryable":true }, "BacklogPriority":{ "title":"Backlog Item Priority", "type":"string", "description":"Name of the backlog item priority.", "nullable":true, "x-queryable":true }, "Rank":{ "title":"Rank", "type":"integer", "description":"Number assigned to the backlog item to maintain a prioritized list of backlog items.", "format":"int32", "nullable":true, "x-queryable":false, "x-hints":{ "precision":9 } }, "BacklogStorypoints":{ "title":"Story Points", "type":"integer", "description":"A measure to determine the complexity of a backlog item.", "format":"int64", "nullable":true, "x-queryable":false, "x-hints":{ "precision":18 } }, "BacklogProductCode":{ "title":"Product Code", "type":"string", "description":"Unique code of the product assigned to the backlog item.", "nullable":true, "x-queryable":true }, "BacklogItemCode":{ "title":"Backlog Item Code", "maxLength":30, "type":"string", "description":"Unique code of the backlog item.", "nullable":true, "x-queryable":true }, "Sprint":{ "title":"Sprint", "maxLength":255, "type":"string", "description":"Name of the sprint associated with the backlog item.", "nullable":true, "x-queryable":false }, "BacklogStatusCode":{ "title":"Backlog Item Status Code", "maxLength":30, "type":"string", "description":"Unique code of the backlog item status.", "nullable":false, "default":"DRAFT", "x-queryable":true }, "AcceptanceCriteria":{ "title":"AcceptanceCriterions", "type":"array", "description":"The acceptance criteria resource is used to view,create, or modify acceptance criteria of a backlogitem. Acceptance criteria is a condition that must be fulfilled for a backlog item to be complete.", "items":{ "$ref":"#/components/schemas/requirements-ChildRequirements-BacklogItems-AcceptanceCriteria-item-response" } }, "BacklogStatus":{ "title":"Backlog Item Status", "type":"string", "description":"Name of the backlog item status.", "nullable":true, "x-queryable":true } } }

Nested Schema : AcceptanceCriterions

Type: array

Title: AcceptanceCriterions

The acceptance criteria resource is used to view,create, or modify acceptance criteria of a backlogitem. Acceptance criteria is a condition that must be fulfilled for a backlog item to be complete.

Show Source

• Array of: object requirements-ChildRequirements-BacklogItems-AcceptanceCriteria-item-response

{ "title":"AcceptanceCriterions", "type":"array", "description":"The acceptance criteria resource is used to view,create, or modify acceptance criteria of a backlogitem. Acceptance criteria is a condition that must be fulfilled for a backlog item to be complete.", "items":{ "$ref":"#/components/schemas/requirements-ChildRequirements-BacklogItems-AcceptanceCriteria-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 : requirements-ChildRequirements-BacklogItems-AcceptanceCriteria-item-response

Type: object

Show Source

• CriteriaId: integer (int64)
  Title: Acceptance Criteria ID

  Read Only: true

  Unique identifier of the acceptance criteria under the backlog item.
• CriteriaName: string
  Title: Acceptance Criteria

  Maximum Length: 140

  Condition that must be fulfilled for considering the backlog item to be complete.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{ "type":"object", "properties":{ "links":{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }, "CriteriaId":{ "title":"Acceptance Criteria ID", "type":"integer", "description":"Unique identifier of the acceptance criteria under the backlog item.", "format":"int64", "nullable":false, "readOnly":true, "x-hints":{ "precision":18 }, "x-queryable":true }, "CriteriaName":{ "title":"Acceptance Criteria", "maxLength":140, "type":"string", "description":"Condition that must be fulfilled for considering the backlog item to be complete.", "nullable":false, "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 : requirements-ChildRequirements-ChildRequirements-item-response

Type: object

Show Source

• links: array Links
  Title: Links

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

  Name of the requirement owner.
• OwnerEmail: string
  Title: Requirement Owner E-Mail

  Email of the requirement owner.
• ParentRqmtCode: string
  Title: Parent Requirement Code

  Unique code of the parent requirement.
• ParentRqmtId: integer (int64)
  Title: Parent Requirement ID

  Default Value: 111

  Unique identifier of the parent requirement.
• ParentRqmtName: string
  Title: Parent Requirement Name

  Name of the parent requirement.
• Priority: string
  Title: Requirement Priority

  Priority of the requirement.
• PriorityCode: string
  Title: Requirement Priority Code

  Maximum Length: 30

  Default Value: MEDIUM

  Unique code of the requirement priority.
• ProductCode: string
  Title: Product Code

  Read Only: true

  Maximum Length: 30

  Unique code of the product.
• ProductName: string
  Title: Product Name

  Name of the product.
• ReleaseName: string
  Title: Release Name

  Read Only: true

  Maximum Length: 50

  Name of the product release.
• ReleaseNumber: string
  Title: Release Number

  Read Only: true

  Maximum Length: 30

  Unique number of the product release.
• RqmtCode: string
  Title: Requirement Code

  Maximum Length: 30

  Unique code of the requirement in the requirement hierarchy.
• RqmtId: integer (int64)
  Title: Requirement ID

  Read Only: true

  Unique identifier of the project requirement in the requirement hierarchy.
• RqmtName: string
  Title: Requirement Name

  Maximum Length: 100

  Name of the requirement.
• Status: string
  Title: Requirement Status

  Status of the requirement.
• StatusCode: string
  Title: Requirement Status Code

  Maximum Length: 30

  Default Value: DRAFT

  Unique code of the requirement status.

{ "type":"object", "properties":{ "Status":{ "title":"Requirement Status", "type":"string", "description":"Status of the requirement.", "nullable":true, "x-queryable":true }, "Owner":{ "title":"Requirement Owner", "type":"string", "description":"Name of the requirement owner.", "nullable":true, "x-queryable":true }, "ParentRqmtCode":{ "title":"Parent Requirement Code", "type":"string", "description":"Unique code of the parent requirement.", "nullable":true, "x-queryable":true }, "ProductName":{ "title":"Product Name", "type":"string", "description":"Name of the product.", "nullable":true, "x-queryable":true }, "ProductCode":{ "title":"Product Code", "maxLength":30, "type":"string", "description":"Unique code of the product.", "nullable":false, "readOnly":true, "x-queryable":true }, "Priority":{ "title":"Requirement Priority", "type":"string", "description":"Priority of the requirement.", "nullable":true, "x-queryable":true }, "PriorityCode":{ "title":"Requirement Priority Code", "maxLength":30, "type":"string", "description":"Unique code of the requirement priority.", "nullable":true, "default":"MEDIUM", "x-hints":{ "DISPLAYHINT":"Hide" }, "x-queryable":true }, "ParentRqmtId":{ "title":"Parent Requirement ID", "type":"integer", "description":"Unique identifier of the parent requirement.", "format":"int64", "nullable":true, "default":111, "x-hints":{ "DISPLAYHINT":"Hide", "precision":18 }, "x-queryable":true }, "ReleaseName":{ "title":"Release Name", "maxLength":50, "type":"string", "description":"Name of the product release.", "nullable":false, "readOnly":true, "x-hints":{ "dependencies":[ "ReleaseId" ] }, "x-queryable":true }, "StatusCode":{ "title":"Requirement Status Code", "maxLength":30, "type":"string", "description":"Unique code of the requirement status.", "nullable":true, "default":"DRAFT", "x-hints":{ "DISPLAYHINT":"Hide" }, "x-queryable":true }, "RqmtCode":{ "title":"Requirement Code", "maxLength":30, "type":"string", "description":"Unique code of the requirement in the requirement hierarchy.", "nullable":true, "x-queryable":true }, "RqmtId":{ "title":"Requirement ID", "type":"integer", "description":"Unique identifier of the project requirement in the requirement hierarchy.", "format":"int64", "nullable":false, "readOnly":true, "x-hints":{ "precision":18 }, "x-queryable":true }, "ParentRqmtName":{ "title":"Parent Requirement Name", "type":"string", "description":"Name of the parent requirement.", "nullable":true, "x-queryable":true }, "RqmtName":{ "title":"Requirement Name", "maxLength":100, "type":"string", "description":"Name of the requirement.", "nullable":false, "x-queryable":true }, "links":{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }, "ReleaseNumber":{ "title":"Release Number", "maxLength":30, "type":"string", "description":"Unique number of the product release.", "nullable":false, "readOnly":true, "x-queryable":true }, "OwnerEmail":{ "title":"Requirement Owner E-Mail", "type":"string", "description":"Email of the requirement owner.", "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

BacklogItems

Operation: /fscmRestApi/resources/11.13.18.05/requirements/{RqmtId}/child/BacklogItems

Parameters:

• RqmtId: $request.path.RqmtId

The backlog item resource is used to view,create, or modify backlog items. A backlog item represents a unit of work that can be accomplished within a sprint.

ChildRequirements

Operation: /fscmRestApi/resources/11.13.18.05/requirements/{RqmtId}/child/ChildRequirements

Parameters:

• RqmtId: $request.path.RqmtId

The requirements resource is used to view,create, or modify a requirement. A requirement can be a functionality or a feature planned to be delivered in a product.

Back to Top

Examples

The following example shows how to create a requirement by submitting a POST request on the REST resource using cURL.

curl --user ppm_cloud_user -X POST -d @example_request_payload.json --header "Content-Type: application/json" https://your_organization.com:port/fscmRestApi/resources/11.13.17.08/requirements 

Example of Request Body

The following example shows the contents of the request body in JSON format

{ "RqmtName": "ReqmtExample", "OwnerEmail": "[e-mail]", "Owner": "Mark Taylor", "StatusCode": "DRAFT", "PriorityCode": "MEDIUM" } 

Example of Response Body

The following example shows the contents of the response body in JSON format.

 { "RqmtId": 300100114013930, "RqmtName": "ReqmtExample", "OwnerEmail": "[e-mail]", "Owner": "Mark Taylor", "RqmtCode": "9062", "StatusCode": "DRAFT", "Status": "Draft", "PriorityCode": "MEDIUM", "Priority": "Medium", "ParentRqmtId": 111, "ParentRqmtCode": "1", "ParentRqmtName": "All Requirements", "ReleaseNumber": null, "ReleaseName": null, "ProductCode": null, "ProductName": null, "links": [... ] } 

Back to Top