Jump to

• Request
• Response

Create a requirement line item

post

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

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:
  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

• 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(required): 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.
• RequirementId: integer
  Value that uniquely identifies the requirement.
• RequirementLineItemId: integer (int64)
  Value that uniquely identifies the requirement line item.
• RequirementVersionId(required): integer (int64)
  Title: Requirement Version ID

  Value that uniquely identifies the requirement version.
• 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.

{
    "required":[
        "Name",
        "RequirementVersionId"
    ],
    "type":"object",
    "properties":{
        "ParentSectionNumber":{
            "type":"string",
            "description":"Number that identifies the section of the parent line item.",
            "nullable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"Description of the requirement line item.",
            "nullable":true
        },
        "Priority":{
            "title":"Priority",
            "maxLength":"30",
            "type":"string",
            "description":"Priority 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
        },
        "Estimates":{
            "title":"Estimates",
            "type":"number",
            "description":"Estimates needed to complete the requirement line item.",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "scale":"8"
            }
        },
        "Attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The Attachments resource manages the attachments of a requirement.",
            "items":{
                "$ref":"#/components/schemas/requirementSpecifications-RequirementVersion-RequirementLineItem-Attachments-item-post-request"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "Scope":{
            "title":"In Scope",
            "maxLength":"30",
            "type":"string",
            "description":"Scope of the requirement line item.",
            "nullable":true
        },
        "Content":{
            "title":"Content",
            "type":"string",
            "description":"Details of the requirement line item.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "Fulfilled":{
            "title":"Fulfilled",
            "maxLength":"30",
            "type":"string",
            "description":"Value that indicates whether the requirement line item has been fulfilled.",
            "nullable":true
        },
        "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"
            }
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The Attachments resource manages the attachments of a requirement.

Show Source

• Array of: object schema

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

Nested Schema : schema

Type: object

Show Source

• AttachedDocumentId: integer (int64)
  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.
• 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
  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
  Abbreviation that identifies the error code, if any, for the attachment.
• ErrorStatusMessage: string
  Text of the error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Date when the attachment is no longer valid.
• FileContents: string (byte)
  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
  Content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  Length of the attached file.
• UploadedFileName: string
  Name of the attached file.
• UploadedText: string
  Text of the attachment.
• Uri: string
  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":{
        "ErrorStatusMessage":{
            "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "UploadedFileName":{
            "type":"string",
            "description":"Name of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "AttachedDocumentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            }
        },
        "FileContents":{
            "type":"string",
            "description":"Contents of the file attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "UploadedFileContentType":{
            "type":"string",
            "description":"Content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "type":"string",
            "description":"Date when the attachment is no longer valid.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ErrorStatusCode":{
            "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"
            }
        },
        "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"
            }
        },
        "DmFolderPath":{
            "maxLength":"1000",
            "type":"string",
            "description":"Repository folder path of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedText":{
            "type":"string",
            "description":"Text of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"Category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "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"
            }
        }
    }
}

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-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":{
        "ParentSectionNumber":{
            "type":"string",
            "description":"Number that identifies the section of the parent line item.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"Description of the requirement 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
        },
        "SectionNumber":{
            "title":"Number",
            "maxLength":"400",
            "type":"string",
            "description":"Number that identifies the section of the requirement line item.",
            "nullable":true,
            "x-queryable":true
        },
        "RequirementName":{
            "type":"string",
            "description":"Name of the requirement.",
            "nullable":true,
            "readOnly":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
        },
        "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"
            }
        },
        "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
        },
        "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
        },
        "Impacts":{
            "type":"integer",
            "description":"Number of objects impacted by the requirement line item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PriorityName":{
            "type":"string",
            "description":"Name of the priority.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ScopeName":{
            "type":"string",
            "description":"Name of the scope.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Scope":{
            "title":"In Scope",
            "maxLength":"30",
            "type":"string",
            "description":"Scope of the requirement line item.",
            "nullable":true,
            "x-queryable":true
        },
        "Content":{
            "title":"Content",
            "type":"string",
            "description":"Details of the requirement line item.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RequirementVersionNumber":{
            "type":"integer",
            "description":"Number that identifies the version of the requirement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "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
        }
    }
}

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)
  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
  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)
  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
  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
  Abbreviation that identifies the error code, if any, for the attachment.
• ErrorStatusMessage: string
  Text of the error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Date when the attachment is no longer valid.
• FileContents: string (byte)
  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
  Content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  Length of the attached file.
• UploadedFileName: string
  Name of the attached file.
• UploadedText: string
  Text of the attachment.
• Uri: string
  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
  Read Only: true

  Maximum Length: 255

  Login that the user used when adding the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date when the attachment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":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"
            }
        },
        "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
        },
        "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":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "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
        },
        "AttachedDocumentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "type":"string",
            "description":"Content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "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"
            }
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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"
            }
        },
        "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
        },
        "ErrorStatusMessage":{
            "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"
            }
        },
        "UserName":{
            "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
        },
        "CreatedBy":{
            "maxLength":"255",
            "type":"string",
            "description":"User who created the attachment.",
            "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
        },
        "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"
            }
        },
        "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
        },
        "UploadedFileName":{
            "type":"string",
            "description":"Name of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "FileContents":{
            "type":"string",
            "description":"Contents of the file attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "type":"string",
            "description":"Date when the attachment is no longer valid.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "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"
            }
        },
        "DmFolderPath":{
            "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
        },
        "UploadedText":{
            "type":"string",
            "description":"Text of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "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
        },
        "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
        }
    }
}

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

Links

Attachments

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

Parameters:

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

The Attachments resource manages the attachments of a requirement.

Back to Top