Jump to

• Request
• Response
• Examples

Create child requirements

post

/fscmRestApi/resources/11.13.18.05/requirements/{RqmtId}/child/ChildRequirements/{RqmtId2}/child/ChildRequirements

Request

Path Parameters

• RqmtId(required): integer(int64)
  Unique identifier of the project requirement in the requirement hierarchy.
• RqmtId2(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:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

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

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

Examples

The following example shows how to create a child 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/{RqmtId}/child/ChildRequirements/{RqmtId2}/child/ChildRequirements

Example of Request Body

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

{
  
  "RqmtName": "Requirement_433",
  "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": "Requirement_433",
  "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