Jump to

• Request
• Response
• Examples

Update a requirement version

patch

/fscmRestApi/resources/11.13.18.05/requirementSpecifications/{RequirementId}/child/RequirementVersion/{RequirementVersionId}

Request

Path Parameters

• RequirementId(required): integer
  Value that uniquely identifies the requirement specification.
• RequirementVersionId(required): integer(int64)
  Value that uniquely identifies the requirement version.

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Attachments: array Attachments
  Title: Attachments

  The Attachments resource manages the attachments of a requirement.
• Description: string
  Title: Description

  Maximum Length: 1000

  Description of the requirement specification.
• Product: string
  Title: Product

  Maximum Length: 30

  Product associated with the requirement specification.
• RequirementLineItem: array Requirement Line Items
  Title: Requirement Line Items

  The Requirement Line Items resource manages the requirements within a requirement specification. Each requirement line has priority and estimates. The estimates roll up to the top-level requirement.
• Status: string
  Title: Status

  Maximum Length: 30

  Default Value: PENDING

  Status of the requirement specification.
• TotalEstimates: number
  Title: Total Estimates

  Total estimates required to complete the requirement specification.

{
    "type":"object",
    "properties":{
        "Attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The Attachments resource manages the attachments of a requirement.",
            "items":{
                "$ref":"#/components/schemas/requirementSpecifications-RequirementVersion-Attachments-item-patch-request"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"Description of the requirement specification.",
            "nullable":true
        },
        "Product":{
            "title":"Product",
            "maxLength":30,
            "type":"string",
            "description":"Product associated with the requirement specification.",
            "nullable":true
        },
        "RequirementLineItem":{
            "title":"Requirement Line Items",
            "type":"array",
            "description":"The Requirement Line Items resource manages the requirements within a requirement specification. Each requirement line has priority and estimates. The estimates roll up to the top-level requirement.",
            "items":{
                "$ref":"#/components/schemas/requirementSpecifications-RequirementVersion-RequirementLineItem-item-patch-request"
            }
        },
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"Status of the requirement specification.",
            "nullable":false,
            "default":"PENDING",
            "x-hints":{
                "DONT_COPY":"YES"
            }
        },
        "TotalEstimates":{
            "title":"Total Estimates",
            "type":"number",
            "description":"Total estimates required to complete the requirement specification.",
            "nullable":true
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The Attachments resource manages the attachments of a requirement.

Show Source

• Array of: object requirementSpecifications-RequirementVersion-Attachments-item-patch-request

{
    "title":"Attachments",
    "type":"array",
    "description":"The Attachments resource manages the attachments of a requirement.",
    "items":{
        "$ref":"#/components/schemas/requirementSpecifications-RequirementVersion-Attachments-item-patch-request"
    }
}

Nested Schema : Requirement Line Items

Type: array

Title: Requirement Line Items

The Requirement Line Items resource manages the requirements within a requirement specification. Each requirement line has priority and estimates. The estimates roll up to the top-level requirement.

Show Source

• Array of: object schema

{
    "title":"Requirement Line Items",
    "type":"array",
    "description":"The Requirement Line Items resource manages the requirements within a requirement specification. Each requirement line has priority and estimates. The estimates roll up to the top-level requirement.",
    "items":{
        "$ref":"#/components/schemas/requirementSpecifications-RequirementVersion-RequirementLineItem-item-patch-request"
    }
}

Nested Schema : requirementSpecifications-RequirementVersion-Attachments-item-patch-request

Type: object

Show Source

• CategoryName: string
  Title: Category

  Maximum Length: 30

  Category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Contains one of the following values: true or false. If true, then the attachment is shared. If false, then the attachment is not shared. The default value is false.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Abbreviation that identifies the data type of the attachment.
• Description: string
  Title: Description

  Maximum Length: 255

  Description of the attachment.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Repository folder path of the attachment.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  Abbreviation that identifies the error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  Text of the error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  Date when the attachment is no longer valid.
• FileContents: string (byte)
  Title: File Contents

  Contents of the file attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  File name of the attachment.
• FileUrl: string
  Title: File Url

  URL (Uniform Resource Locator) of the attached file.
• PostProcessingAction: string
  Title: PostProcessingAction

  Name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  Title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  Content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  Length of the attached file.
• UploadedFileName: string
  Title: Uploaded File Name

  Name of the attached file.
• UploadedText: string
  Title: Uploaded Text

  Text of the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  URI (Uniform Resource Identifier) of the attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  URL (Uniform Resource Locator) of the attachment.

{
    "type":"object",
    "properties":{
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the attachment is shared. If false, then the attachment is not shared. The default value is false.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the data type of the attachment.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"Repository folder path of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Abbreviation that identifies the error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Text of the error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Date when the attachment is no longer valid.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the file attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"File name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL (Uniform Resource Locator) of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"Name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Length of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Name of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"URI (Uniform Resource Identifier) of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"URL (Uniform Resource Locator) of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• Attachments: array Attachments
  Title: Attachments

  The Attachments resource manages the attachments of a requirement.
• Content: string (byte)
  Title: Content

  Details of the requirement line item.
• Description: string
  Title: Description

  Maximum Length: 1000

  Description of the requirement line item.
• Estimates: number
  Title: Estimates

  Estimates needed to complete the requirement line item.
• Fulfilled: string
  Title: Fulfilled

  Maximum Length: 30

  Value that indicates whether the requirement line item has been fulfilled.
• Name: string
  Title: Requirement

  Maximum Length: 400

  Name of the requirement specification.
• ParentLineItemId: integer (int64)
  Value that uniquely identifies parent line item.
• Priority: string
  Title: Priority

  Maximum Length: 30

  Priority of the requirement line item.
• RequirementId: integer
  Value that uniquely identifies the requirement.
• Scope: string
  Title: In Scope

  Maximum Length: 30

  Scope of the requirement line item.
• SectionNumber: string
  Title: Number

  Maximum Length: 400

  Number that identifies the section of the requirement line item.

{
    "type":"object",
    "properties":{
        "Attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The Attachments resource manages the attachments of a requirement.",
            "items":{
                "$ref":"#/components/schemas/requirementSpecifications-RequirementVersion-RequirementLineItem-Attachments-item-patch-request"
            }
        },
        "Content":{
            "title":"Content",
            "type":"string",
            "description":"Details of the requirement line item.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"Description of the requirement line item.",
            "nullable":true
        },
        "Estimates":{
            "title":"Estimates",
            "type":"number",
            "description":"Estimates needed to complete the requirement line item.",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "scale":8
            }
        },
        "Fulfilled":{
            "title":"Fulfilled",
            "maxLength":30,
            "type":"string",
            "description":"Value that indicates whether the requirement line item has been fulfilled.",
            "nullable":true
        },
        "Name":{
            "title":"Requirement",
            "maxLength":400,
            "type":"string",
            "description":"Name of the requirement specification.",
            "nullable":false,
            "x-hints":{
                "DONT_COPY":"YES"
            }
        },
        "ParentLineItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies parent line item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DONT_COPY":"YES",
                "precision":18
            }
        },
        "Priority":{
            "title":"Priority",
            "maxLength":30,
            "type":"string",
            "description":"Priority of the requirement line item.",
            "nullable":true
        },
        "RequirementId":{
            "type":"integer",
            "description":"Value that uniquely identifies the requirement.",
            "nullable":true,
            "x-queryable":false
        },
        "Scope":{
            "title":"In Scope",
            "maxLength":30,
            "type":"string",
            "description":"Scope of the requirement line item.",
            "nullable":true
        },
        "SectionNumber":{
            "title":"Number",
            "maxLength":400,
            "type":"string",
            "description":"Number that identifies the section of the requirement line item.",
            "nullable":true
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The Attachments resource manages the attachments of a requirement.

Show Source

• Array of: object requirementSpecifications-RequirementVersion-RequirementLineItem-Attachments-item-patch-request

{
    "title":"Attachments",
    "type":"array",
    "description":"The Attachments resource manages the attachments of a requirement.",
    "items":{
        "$ref":"#/components/schemas/requirementSpecifications-RequirementVersion-RequirementLineItem-Attachments-item-patch-request"
    }
}

Nested Schema : requirementSpecifications-RequirementVersion-RequirementLineItem-Attachments-item-patch-request

Type: object

Show Source

• CategoryName: string
  Title: Category

  Maximum Length: 30

  Category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Contains one of the following values: true or false. If true, then the attachment is shared. If false, then the attachment is not shared. The default value is false.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Abbreviation that identifies the data type of the attachment.
• Description: string
  Title: Description

  Maximum Length: 255

  Description of the attachment.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Repository folder path of the attachment.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  Abbreviation that identifies the error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  Text of the error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  Date when the attachment is no longer valid.
• FileContents: string (byte)
  Title: File Contents

  Contents of the file attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  File name of the attachment.
• FileUrl: string
  Title: File Url

  URL (Uniform Resource Locator) of the attached file.
• PostProcessingAction: string
  Title: PostProcessingAction

  Name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  Title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  Content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  Length of the attached file.
• UploadedFileName: string
  Title: Uploaded File Name

  Name of the attached file.
• UploadedText: string
  Title: Uploaded Text

  Text of the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  URI (Uniform Resource Identifier) of the attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  URL (Uniform Resource Locator) of the attachment.

{
    "type":"object",
    "properties":{
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the attachment is shared. If false, then the attachment is not shared. The default value is false.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the data type of the attachment.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"Repository folder path of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Abbreviation that identifies the error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Text of the error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Date when the attachment is no longer valid.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the file attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"File name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL (Uniform Resource Locator) of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"Name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Length of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Name of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"URI (Uniform Resource Identifier) of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"URL (Uniform Resource Locator) of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"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 : requirementSpecifications-RequirementVersion-item-response

Type: object

Show Source

• Attachments: array Attachments
  Title: Attachments

  The Attachments resource manages the attachments of a requirement.
• Description: string
  Title: Description

  Maximum Length: 1000

  Description of the requirement specification.
• links: array Links
  Title: Links

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

  Maximum Length: 30

  Product associated with the requirement specification.
• ProductName: string
  Read Only: true

  Name of the product.
• RequirementId: integer (int64)
  Value that uniquely identifies the requirement.
• RequirementLineItem: array Requirement Line Items
  Title: Requirement Line Items

  The Requirement Line Items resource manages the requirements within a requirement specification. Each requirement line has priority and estimates. The estimates roll up to the top-level requirement.
• RequirementName: string
  Read Only: true

  Name of the requirement.
• RequirementVersionId: integer (int64)
  Value that uniquely identifies the requirement version.
• Status: string
  Title: Status

  Maximum Length: 30

  Default Value: PENDING

  Status of the requirement specification.
• StatusName: string
  Read Only: true

  Name of the status.
• TotalDependsOn: integer
  Read Only: true

  Number of dependencies on this requirement specification.
• TotalEstimates: number
  Title: Total Estimates

  Total estimates required to complete the requirement specification.
• TotalImpacts: integer
  Read Only: true

  Number of objects impacted by this requirement specification.
• VersionNumber: integer (int32)
  Title: Version

  Default Value: 1

  Version number of the requirement specification.

{
    "type":"object",
    "properties":{
        "Attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The Attachments resource manages the attachments of a requirement.",
            "items":{
                "$ref":"#/components/schemas/requirementSpecifications-RequirementVersion-Attachments-item-response"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"Description of the requirement specification.",
            "nullable":true,
            "x-queryable":true
        },
        "Product":{
            "title":"Product",
            "maxLength":30,
            "type":"string",
            "description":"Product associated with the requirement specification.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductName":{
            "type":"string",
            "description":"Name of the product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RequirementId":{
            "type":"integer",
            "description":"Value that uniquely identifies the requirement.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DONT_COPY":"YES",
                "precision":18
            },
            "x-queryable":true
        },
        "RequirementLineItem":{
            "title":"Requirement Line Items",
            "type":"array",
            "description":"The Requirement Line Items resource manages the requirements within a requirement specification. Each requirement line has priority and estimates. The estimates roll up to the top-level requirement.",
            "items":{
                "$ref":"#/components/schemas/requirementSpecifications-RequirementVersion-RequirementLineItem-item-response"
            }
        },
        "RequirementName":{
            "type":"string",
            "description":"Name of the requirement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequirementVersionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the requirement version.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"Status of the requirement specification.",
            "nullable":false,
            "default":"PENDING",
            "x-hints":{
                "DONT_COPY":"YES"
            },
            "x-queryable":true
        },
        "StatusName":{
            "type":"string",
            "description":"Name of the status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TotalDependsOn":{
            "type":"integer",
            "description":"Number of dependencies on this requirement specification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TotalEstimates":{
            "title":"Total Estimates",
            "type":"number",
            "description":"Total estimates required to complete the requirement specification.",
            "nullable":true,
            "x-queryable":true
        },
        "TotalImpacts":{
            "type":"integer",
            "description":"Number of objects impacted by this requirement specification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "VersionNumber":{
            "title":"Version",
            "type":"integer",
            "description":"Version number of the requirement specification.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "DONT_COPY":"YES",
                "precision":8
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The Attachments resource manages the attachments of a requirement.

Show Source

• Array of: object requirementSpecifications-RequirementVersion-Attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The Attachments resource manages the attachments of a requirement.",
    "items":{
        "$ref":"#/components/schemas/requirementSpecifications-RequirementVersion-Attachments-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 : Requirement Line Items

Type: array

Title: Requirement Line Items

The Requirement Line Items resource manages the requirements within a requirement specification. Each requirement line has priority and estimates. The estimates roll up to the top-level requirement.

Show Source

• Array of: object requirementSpecifications-RequirementVersion-RequirementLineItem-item-response

{
    "title":"Requirement Line Items",
    "type":"array",
    "description":"The Requirement Line Items resource manages the requirements within a requirement specification. Each requirement line has priority and estimates. The estimates roll up to the top-level requirement.",
    "items":{
        "$ref":"#/components/schemas/requirementSpecifications-RequirementVersion-RequirementLineItem-item-response"
    }
}

Nested Schema : requirementSpecifications-RequirementVersion-Attachments-item-response

Type: object

Show Source

• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  Value that uniquely identifies the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  Category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Contains one of the following values: true or false. If true, then the attachment is shared. If false, then the attachment is not shared. The default value is false.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  User who created the attachment.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  Login that the user used when creating the attachment for the affected item.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date when the attachment was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Abbreviation that identifies the data type of the attachment.
• Description: string
  Title: Description

  Maximum Length: 255

  Description of the attachment.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Repository folder path of the attachment.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  Abbreviation that identifies the error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  Text of the error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  Date when the attachment is no longer valid.
• FileContents: string (byte)
  Title: File Contents

  Contents of the file attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  File name of the attachment.
• FileUrl: string
  Title: File Url

  URL (Uniform Resource Locator) of the attached file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date and time when the user most recently updated the attachment.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  User who most recently updated the attachment.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  Login that the user used when updating the attachment for the affected item.
• links: array Links
  Title: Links

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

  Name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  Title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  Content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  Length of the attached file.
• UploadedFileName: string
  Title: Uploaded File Name

  Name of the attached file.
• UploadedText: string
  Title: Uploaded Text

  Text of the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  URI (Uniform Resource Identifier) of the attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  URL (Uniform Resource Locator) of the attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  Login that the user used when adding the attachment.

{
    "type":"object",
    "properties":{
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"Value that uniquely identifies the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the attachment is shared. If false, then the attachment is not shared. The default value is false.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"User who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"Login that the user used when creating the attachment for the affected item.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the attachment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the data type of the attachment.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"Repository folder path of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Abbreviation that identifies the error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Text of the error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Date when the attachment is no longer valid.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the file attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"File name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL (Uniform Resource Locator) of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"The base64 encoded image of the file displayed in .png format if the source is a convertible image."
                },
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date and time when the user most recently updated the attachment.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"User who most recently updated the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"Login that the user used when updating the attachment for the affected item.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"Name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Length of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Name of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"URI (Uniform Resource Identifier) of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"URL (Uniform Resource Locator) of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"Login that the user used when adding the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : requirementSpecifications-RequirementVersion-RequirementLineItem-item-response

Type: object

Show Source

• Attachments: array Attachments
  Title: Attachments

  The Attachments resource manages the attachments of a requirement.
• Content: string (byte)
  Title: Content

  Details of the requirement line item.
• Description: string
  Title: Description

  Maximum Length: 1000

  Description of the requirement line item.
• Estimates: number
  Title: Estimates

  Estimates needed to complete the requirement line item.
• Fulfilled: string
  Title: Fulfilled

  Maximum Length: 30

  Value that indicates whether the requirement line item has been fulfilled.
• FulfilledName: string
  Read Only: true

  Name of the fulfilled flag.
• Impacts: integer
  Read Only: true

  Number of objects impacted by the requirement line item.
• links: array Links
  Title: Links

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

  Maximum Length: 400

  Name of the requirement specification.
• ParentLineItemId: integer (int64)
  Value that uniquely identifies parent line item.
• ParentSectionNumber: string
  Number that identifies the section of the parent line item.
• Priority: string
  Title: Priority

  Maximum Length: 30

  Priority of the requirement line item.
• PriorityName: string
  Read Only: true

  Name of the priority.
• RequirementId: integer
  Value that uniquely identifies the requirement.
• RequirementLineItemId: integer (int64)
  Value that uniquely identifies the requirement line item.
• RequirementName: string
  Read Only: true

  Name of the requirement.
• RequirementVersionId: integer (int64)
  Title: Requirement Version ID

  Value that uniquely identifies the requirement version.
• RequirementVersionNumber: integer
  Read Only: true

  Number that identifies the version of the requirement.
• Scope: string
  Title: In Scope

  Maximum Length: 30

  Scope of the requirement line item.
• ScopeName: string
  Read Only: true

  Name of the scope.
• SectionNumber: string
  Title: Number

  Maximum Length: 400

  Number that identifies the section of the requirement line item.

{
    "type":"object",
    "properties":{
        "Attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The Attachments resource manages the attachments of a requirement.",
            "items":{
                "$ref":"#/components/schemas/requirementSpecifications-RequirementVersion-RequirementLineItem-Attachments-item-response"
            }
        },
        "Content":{
            "title":"Content",
            "type":"string",
            "description":"Details of the requirement line item.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"Description of the requirement line item.",
            "nullable":true,
            "x-queryable":true
        },
        "Estimates":{
            "title":"Estimates",
            "type":"number",
            "description":"Estimates needed to complete the requirement line item.",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "scale":8
            },
            "x-queryable":true
        },
        "Fulfilled":{
            "title":"Fulfilled",
            "maxLength":30,
            "type":"string",
            "description":"Value that indicates whether the requirement line item has been fulfilled.",
            "nullable":true,
            "x-queryable":true
        },
        "FulfilledName":{
            "type":"string",
            "description":"Name of the fulfilled flag.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Impacts":{
            "type":"integer",
            "description":"Number of objects impacted by the requirement line item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Name":{
            "title":"Requirement",
            "maxLength":400,
            "type":"string",
            "description":"Name of the requirement specification.",
            "nullable":false,
            "x-hints":{
                "DONT_COPY":"YES"
            },
            "x-queryable":true
        },
        "ParentLineItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies parent line item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DONT_COPY":"YES",
                "precision":18
            },
            "x-queryable":true
        },
        "ParentSectionNumber":{
            "type":"string",
            "description":"Number that identifies the section of the parent line item.",
            "nullable":true,
            "x-queryable":true
        },
        "Priority":{
            "title":"Priority",
            "maxLength":30,
            "type":"string",
            "description":"Priority of the requirement line item.",
            "nullable":true,
            "x-queryable":true
        },
        "PriorityName":{
            "type":"string",
            "description":"Name of the priority.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RequirementId":{
            "type":"integer",
            "description":"Value that uniquely identifies the requirement.",
            "nullable":true,
            "x-queryable":false
        },
        "RequirementLineItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the requirement line item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "RequirementName":{
            "type":"string",
            "description":"Name of the requirement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequirementVersionId":{
            "title":"Requirement Version ID",
            "type":"integer",
            "description":"Value that uniquely identifies the requirement version.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DONT_COPY":"YES",
                "precision":18
            },
            "x-queryable":true
        },
        "RequirementVersionNumber":{
            "type":"integer",
            "description":"Number that identifies the version of the requirement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Scope":{
            "title":"In Scope",
            "maxLength":30,
            "type":"string",
            "description":"Scope of the requirement line item.",
            "nullable":true,
            "x-queryable":true
        },
        "ScopeName":{
            "type":"string",
            "description":"Name of the scope.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SectionNumber":{
            "title":"Number",
            "maxLength":400,
            "type":"string",
            "description":"Number that identifies the section of the requirement line 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"
            }
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The Attachments resource manages the attachments of a requirement.

Show Source

• Array of: object requirementSpecifications-RequirementVersion-RequirementLineItem-Attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The Attachments resource manages the attachments of a requirement.",
    "items":{
        "$ref":"#/components/schemas/requirementSpecifications-RequirementVersion-RequirementLineItem-Attachments-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 : requirementSpecifications-RequirementVersion-RequirementLineItem-Attachments-item-response

Type: object

Show Source

• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  Value that uniquely identifies the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  Category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Contains one of the following values: true or false. If true, then the attachment is shared. If false, then the attachment is not shared. The default value is false.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  User who created the attachment.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  Login that the user used when creating the attachment for the affected item.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date when the attachment was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Abbreviation that identifies the data type of the attachment.
• Description: string
  Title: Description

  Maximum Length: 255

  Description of the attachment.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Repository folder path of the attachment.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  Abbreviation that identifies the error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  Text of the error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  Date when the attachment is no longer valid.
• FileContents: string (byte)
  Title: File Contents

  Contents of the file attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  File name of the attachment.
• FileUrl: string
  Title: File Url

  URL (Uniform Resource Locator) of the attached file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date and time when the user most recently updated the attachment.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  User who most recently updated the attachment.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  Login that the user used when updating the attachment for the affected item.
• links: array Links
  Title: Links

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

  Name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  Title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  Content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  Length of the attached file.
• UploadedFileName: string
  Title: Uploaded File Name

  Name of the attached file.
• UploadedText: string
  Title: Uploaded Text

  Text of the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  URI (Uniform Resource Identifier) of the attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  URL (Uniform Resource Locator) of the attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  Login that the user used when adding the attachment.

{
    "type":"object",
    "properties":{
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"Value that uniquely identifies the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the attachment is shared. If false, then the attachment is not shared. The default value is false.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"User who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"Login that the user used when creating the attachment for the affected item.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the attachment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the data type of the attachment.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"Repository folder path of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Abbreviation that identifies the error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Text of the error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Date when the attachment is no longer valid.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the file attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"File name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL (Uniform Resource Locator) of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"The base64 encoded image of the file displayed in .png format if the source is a convertible image."
                },
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date and time when the user most recently updated the attachment.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"User who most recently updated the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"Login that the user used when updating the attachment for the affected item.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"Name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Length of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Name of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"URI (Uniform Resource Identifier) of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"URL (Uniform Resource Locator) of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"Login that the user used when adding the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

Attachments

Operation: /fscmRestApi/resources/11.13.18.05/requirementSpecifications/{RequirementId}/child/RequirementVersion/{RequirementVersionId}/child/Attachments

Parameters:

• RequirementId: $request.path.RequirementId
• RequirementVersionId: $request.path.RequirementVersionId

The Attachments resource manages the attachments of a requirement.

RequirementLineItem

Operation: /fscmRestApi/resources/11.13.18.05/requirementSpecifications/{RequirementId}/child/RequirementVersion/{RequirementVersionId}/child/RequirementLineItem

Parameters:

• RequirementId: $request.path.RequirementId
• RequirementVersionId: $request.path.RequirementVersionId

The Requirement Line Items resource manages the requirements within a requirement specification. Each requirement line has priority and estimates. The estimates roll up to the top-level requirement.

Back to Top

Examples

This example describes how to update a requirement version.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/requirementSpecifications/RequirementId/child/RequirementVersion/RequirementVersionId"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

{
	"Description" : "Technical Requirements"
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
	"Status": "PENDING",
	"StatusName": "Draft",
	"RequirementVersionId": 300100240957740,
	"TotalEstimates": 0,
	"RequirementId": 300100240957736,
	"Description": "Technical Requirements",
	"TotalDependsOn": null,
	"TotalImpacts": null,
	"VersionNumber": 2,
	"Product": null,
	"ProductName": null,
	"RequirementName": "Flying-Bike-Requirements-New",
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/requirementSpecifications/300100240957736/child/RequirementVersion/300100240957740",
		"name": "RequirementVersion",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/requirementSpecifications/300100240957736/child/RequirementVersion/300100240957740",
		"name": "RequirementVersion",
		"kind": "item"
	},
	{
		"rel": "parent",
		"href": "https://servername/fscmRestApi/resources/version/requirementSpecifications/300100240957736",
		"name": "requirementSpecifications",
		"kind": "item"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/requirementSpecifications/300100240957736/child/RequirementVersion/300100240957740/child/Attachments",
		"name": "Attachments",
		"kind": "collection"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/requirementSpecifications/300100240957736/child/RequirementVersion/300100240957740/child/RequirementLineItem",
		"name": "RequirementLineItem",
		"kind": "collection"
	}
	]
}

Back to Top