Jump to

• Request
• Response
• Examples

Get all requirements

get

/fscmRestApi/resources/11.13.18.05/supplierNegotiations/{supplierNegotiationsUniqID}/child/sections/{SectionId}/child/requirements

Request

Path Parameters

• SectionId(required): integer(int64)
  Value that uniquely identifies the section.
• supplierNegotiationsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Supplier Negotiations resource and used to uniquely identify an instance of Supplier Negotiations. The client should not generate the hash key value. Instead, the client should query on the Supplier Negotiations collection resource in order to navigate to a specific instance of Supplier Negotiations to get the hash key.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds the unique requirement for the supplier negotiation section according to the primary key. The primary key is RequirementId.
    Finder Variables:
    • RequirementId; integer; Value that uniquely identifies the requirement.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • PricingRequirementFlag; boolean; Contains one of the following values: true or false. If true, then the response amount requirement is added to the pricing section. If false, then no requirement is added. This is applicable only when if the Overall Ranking Method is Composite Scoring. The default value is false.
  • RequirementId; integer; Value that uniquely identifies the requirement.
  • RequirementNumber; string; Value that uniquely identifies the sequence for the requirement.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

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 : supplierNegotiations-sections-requirements

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/supplierNegotiations-sections-requirements-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object supplierNegotiations-sections-requirements-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/supplierNegotiations-sections-requirements-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 : supplierNegotiations-sections-requirements-item-response

Type: object

Show Source

• acceptableResponseScoreValues: array Acceptable Response Values
  Title: Acceptable Response Values

  The Acceptable Response Values resource manages details about the scoring criteria of each negotiation requirement.
• AllowCommentsFromSuppliersFlag: boolean
  Title: Allow comments from suppliers

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then allow the supplier to provide comments to each requirement. If false, then do not allow. The default value is false.
• attachments: array Attachments
  Title: Attachments

  The Attachments resource manages details about attachments for a requirement.
• AttachmentsFromSuppliers: string
  Title: Attachments from Suppliers

  Maximum Length: 80

  Requirement for each supplier attachment. Values include Not Allowed, Optional, or Required. A list of accepted values is defined in the lookup type PON_REQ_ALLOW_ATTACHMENT.
• AttachmentsFromSuppliersCode: string
  Title: Attachments from Suppliers Code

  Maximum Length: 30

  Abbreviation that uniquely identifies the requirement for each supplier attachment. Values include Not Allowed, Optional, or Required. A list of accepted values is defined in the lookup type PON_REQ_ALLOW_ATTACHMENT.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the requirement.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the requirement.
• DisplayTargetFlag: boolean
  Title: Display target

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then display the target value to the supplier. If false, then do not display. The default value is false.
• Hint: string
  Title: Hint

  Maximum Length: 1000

  Text that the application displays to the supplier to help respond to the requirements.
• KnockoutScore: number
  Title: Knockout Score

  Lowest requirement score that the response can receive and remain part of the shortlist.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the requirement.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the requirement.
• Level: string
  Title: Level

  Maximum Length: 80

  Supplier level for the requirement. Values include Supplier or Supplier site. A list of accepted values is defined in the lookup type PON_SUPPLIER_LEVEL.
• LevelCode: string
  Title: Level Code

  Maximum Length: 30

  Abbreviation that uniquely identifies the supplier level for the requirement. Values include Supplier or Supplier site. A list of accepted values is defined in the lookup type PON_SUPPLIER_LEVEL.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumScore: number
  Title: Maximum Score

  Highest possible score for the requirement response.
• ParentType: string
  Read Only: true

  Maximum Length: 10

  Type of requirement. If the requirement is the parent of any other requirement, then ParentType contains SECTION. If not, then ParentType contains SCORE.
• PricingRequirementFlag: boolean
  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the response amount requirement is added to the pricing section. If false, then no requirement is added. This is applicable only when if the Overall Ranking Method is Composite Scoring. The default value is false.
• QuestionId: integer (int64)
  Read Only: true

  Value that uniquely identifies the requirement for a question.
• QuestionRevisionNumber: integer (int32)
  Title: Revision

  Read Only: true

  Revision number of a predefined question that the application adds to the supplier qualification.
• Requirement: string
  Title: Requirement

  Maximum Length: 80

  Name of the requirement.
• RequirementId: integer (int64)
  Read Only: true

  Value that uniquely identifies the requirement.
• RequirementLevel: number
  Read Only: true

  Level of the requirement. For example, 1, 2, 3, and so on.
• RequirementNumber: string
  Read Only: true

  Maximum Length: 80

  Value that uniquely identifies the sequence for the requirement.
• RequirementText: string (byte)
  Title: Requirement Text

  Text that describes the requirement.
• RequirementType: string
  Title: Requirement Type

  Maximum Length: 80

  Type of response that the negotiation requires. Values include Text Entry Box, Multiple Choice with Multiple Selections, or Multiple Choice with Single Selection. A list of accepted values is defined in the lookup type PON_REQUIREMENT_TYPE.
• RequirementTypeCode: string
  Title: Requirement Type Code

  Maximum Length: 30

  Abbreviation that uniquely identifies the type of response that the negotiation requires. Values include Text Entry Box, Multiple Choice with Multiple Selections, or Multiple Choice with Single Selection. A list of accepted values is defined in the lookup type PON_REQUIREMENT_TYPE.
• ResponseType: string
  Title: Response Type

  Maximum Length: 80

  Specifies whether the response for the requirement is required. Values include Required, Optional, Display Only, or Internal. A list of accepted values is defined in the lookup type PON_HDR_ATTR_RESPONSE_TYPE.
• ResponseTypeCode: string
  Title: Response Type Code

  Maximum Length: 30

  Abbreviation that specifies whether the response for the requirement is required. Values include Required, Optional, Display Only, or Internal. A list of accepted values is defined in the lookup type PON_HDR_ATTR_RESPONSE_TYPE.
• ScoreId: integer (int64)
  Read Only: true

  Value that uniquely identifies the score.
• ScoringMethod: string
  Title: Scoring

  Maximum Length: 80

  Method that the application uses to score each requirement response. Values include Automatic, Manual, or None. A list of accepted values is defined in the lookup type PON_SCORING_TYPE.
• ScoringMethodCode: string
  Title: Scoring Method Code

  Maximum Length: 30

  Abbreviation that uniquely identifies the method that the application uses to score each requirement response. Values include Automatic, Manual, or None. A list of accepted values is defined in the lookup type PON_SCORING_TYPE.
• Section: string
  Title: Section

  Read Only: true

  Name of the requirement section.
• SectionId: integer (int64)
  Read Only: true

  Value that uniquely identifies the section.
• TargetDateTimeValue: string (date-time)
  Title: Target Date Time Value

  Value that the user entered. This value is applicable for date and time.
• TargetDateValue: string (date)
  Title: Target Date Value

  Value that the user entered in the attribute. This value is applicable for dates.
• TargetNumberValue: number
  Title: Target Number Value

  Value that the user entered in the attribute. This value is applicable for numbers.
• TargetTextValue: string
  Title: Target Text Value

  Maximum Length: 4000

  Target text or URL (Uniform Resource Locator) values of the requirement.
• ValueType: string
  Title: Value Type

  Maximum Length: 80

  Type of value for the requirement. Values include Single Line Text, Multiple Line Text, Number, Date, Date and Time, or URL (Uniform Resource Locator). A list of accepted values is defined in the lookup type PON_REQ_RESPONSE_TYPE.
• ValueTypeCode: string
  Title: Value Type Code

  Maximum Length: 30

  Abbreviation that identifies the type of value for the requirement. A list of accepted values is defined in the lookup type PON_REQ_RESPONSE_TYPE.
• Weight: number
  Title: Weight

  Importance of the requirement when compared to other requirements. The application uses this weight when it calculates the requirement score.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the requirement.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ResponseTypeCode":{
            "title":"Response Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that specifies whether the response for the requirement is required. Values include Required, Optional, Display Only, or Internal. A list of accepted values is defined in the lookup type PON_HDR_ATTR_RESPONSE_TYPE.",
            "nullable":true,
            "x-queryable":false
        },
        "LevelCode":{
            "title":"Level Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the supplier level for the requirement. Values include Supplier or Supplier site. A list of accepted values is defined in the lookup type PON_SUPPLIER_LEVEL.",
            "nullable":true,
            "x-queryable":false
        },
        "TargetDateValue":{
            "title":"Target Date Value",
            "type":"string",
            "description":"Value that the user entered in the attribute. This value is applicable for dates.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "TargetDateTimeValue":{
            "title":"Target Date Time Value",
            "type":"string",
            "description":"Value that the user entered. This value is applicable for date and time.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The Attachments resource manages details about attachments for a requirement.",
            "items":{
                "$ref":"#/components/schemas/supplierNegotiations-sections-requirements-attachments-item-response"
            }
        },
        "Hint":{
            "title":"Hint",
            "maxLength":"1000",
            "type":"string",
            "description":"Text that the application displays to the supplier to help respond to the requirements.",
            "nullable":true,
            "x-queryable":false
        },
        "ScoreId":{
            "type":"integer",
            "description":"Value that uniquely identifies the score.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ScoringMethodCode":{
            "title":"Scoring Method Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the method that the application uses to score each requirement response. Values include Automatic, Manual, or None. A list of accepted values is defined in the lookup type PON_SCORING_TYPE.",
            "nullable":true,
            "x-queryable":false
        },
        "ParentType":{
            "maxLength":"10",
            "type":"string",
            "description":"Type of requirement. If the requirement is the parent of any other requirement, then ParentType contains SECTION. If not, then ParentType contains SCORE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DisplayTargetFlag":{
            "title":"Display target",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then display the target value to the supplier. If false, then do not display. The default value is false.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ResponseType",
                    "ResponseTypeCode"
                ]
            }
        },
        "RequirementLevel":{
            "type":"number",
            "description":"Level of the requirement. For example, 1, 2, 3, and so on.",
            "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"
            }
        },
        "ValueTypeCode":{
            "title":"Value Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the type of value for the requirement. A list of accepted values is defined in the lookup type PON_REQ_RESPONSE_TYPE.",
            "nullable":true,
            "x-queryable":false
        },
        "RequirementNumber":{
            "maxLength":"80",
            "type":"string",
            "description":"Value that uniquely identifies the sequence for the requirement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QuestionRevisionNumber":{
            "title":"Revision",
            "type":"integer",
            "description":"Revision number of a predefined question that the application adds to the supplier qualification.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "ScoringMethod":{
            "title":"Scoring",
            "maxLength":"80",
            "type":"string",
            "description":"Method that the application uses to score each requirement response. Values include Automatic, Manual, or None. A list of accepted values is defined in the lookup type PON_SCORING_TYPE.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RequirementId":{
            "type":"integer",
            "description":"Value that uniquely identifies the requirement.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "MaximumScore":{
            "title":"Maximum Score",
            "type":"number",
            "description":"Highest possible score for the requirement response.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ResponseType",
                    "ResponseTypeCode",
                    "ScoringMethod",
                    "ScoringMethodCode"
                ]
            }
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the requirement.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the requirement.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ValueType":{
            "title":"Value Type",
            "maxLength":"80",
            "type":"string",
            "description":"Type of value for the requirement. Values include Single Line Text, Multiple Line Text, Number, Date, Date and Time, or URL (Uniform Resource Locator). A list of accepted values is defined in the lookup type PON_REQ_RESPONSE_TYPE.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AllowCommentsFromSuppliersFlag":{
            "title":"Allow comments from suppliers",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then allow the supplier to provide comments to each requirement. If false, then do not allow. The default value is false.",
            "nullable":true,
            "x-queryable":false
        },
        "RequirementTypeCode":{
            "title":"Requirement Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the type of response that the negotiation requires. Values include Text Entry Box, Multiple Choice with Multiple Selections, or Multiple Choice with Single Selection. A list of accepted values is defined in the lookup type PON_REQUIREMENT_TYPE.",
            "nullable":true,
            "x-queryable":false
        },
        "PricingRequirementFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the response amount requirement is added to the pricing section. If false, then no requirement is added. This is applicable only when if the Overall Ranking Method is Composite Scoring. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AttachmentsFromSuppliers":{
            "title":"Attachments from Suppliers",
            "maxLength":"80",
            "type":"string",
            "description":"Requirement for each supplier attachment. Values include Not Allowed, Optional, or Required. A list of accepted values is defined in the lookup type PON_REQ_ALLOW_ATTACHMENT.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "KnockoutScore":{
            "title":"Knockout Score",
            "type":"number",
            "description":"Lowest requirement score that the response can receive and remain part of the shortlist.",
            "nullable":true,
            "x-queryable":false
        },
        "Section":{
            "title":"Section",
            "type":"string",
            "description":"Name of the requirement section.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Weight":{
            "title":"Weight",
            "type":"number",
            "description":"Importance of the requirement when compared to other requirements. The application uses this weight when it calculates the requirement score.",
            "nullable":true,
            "x-queryable":false
        },
        "ResponseType":{
            "title":"Response Type",
            "maxLength":"80",
            "type":"string",
            "description":"Specifies whether the response for the requirement is required. Values include Required, Optional, Display Only, or Internal. A list of accepted values is defined in the lookup type PON_HDR_ATTR_RESPONSE_TYPE.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Requirement":{
            "title":"Requirement",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the requirement.",
            "nullable":true,
            "x-queryable":false
        },
        "QuestionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the requirement for a question.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "RequirementText":{
            "title":"Requirement Text",
            "type":"string",
            "description":"Text that describes the requirement.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "TargetNumberValue":{
            "title":"Target Number Value",
            "type":"number",
            "description":"Value that the user entered in the attribute. This value is applicable for numbers.",
            "nullable":true,
            "x-queryable":false
        },
        "RequirementType":{
            "title":"Requirement Type",
            "maxLength":"80",
            "type":"string",
            "description":"Type of response that the negotiation requires. Values include Text Entry Box, Multiple Choice with Multiple Selections, or Multiple Choice with Single Selection. A list of accepted values is defined in the lookup type PON_REQUIREMENT_TYPE.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "acceptableResponseScoreValues":{
            "title":"Acceptable Response Values",
            "type":"array",
            "description":"The Acceptable Response Values resource manages details about the scoring criteria of each negotiation requirement.",
            "items":{
                "$ref":"#/components/schemas/supplierNegotiations-sections-requirements-acceptableResponseScoreValues-item-response"
            }
        },
        "Level":{
            "title":"Level",
            "maxLength":"80",
            "type":"string",
            "description":"Supplier level for the requirement. Values include Supplier or Supplier site. A list of accepted values is defined in the lookup type PON_SUPPLIER_LEVEL.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TargetTextValue":{
            "title":"Target Text Value",
            "maxLength":"4000",
            "type":"string",
            "description":"Target text or URL (Uniform Resource Locator) values of the requirement.",
            "nullable":true,
            "x-queryable":false
        },
        "SectionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the section.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AttachmentsFromSuppliersCode":{
            "title":"Attachments from Suppliers Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the requirement for each supplier attachment. Values include Not Allowed, Optional, or Required. A list of accepted values is defined in the lookup type PON_REQ_ALLOW_ATTACHMENT.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the requirement.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Acceptable Response Values

Type: array

Title: Acceptable Response Values

The Acceptable Response Values resource manages details about the scoring criteria of each negotiation requirement.

Show Source

• Array of: object supplierNegotiations-sections-requirements-acceptableResponseScoreValues-item-response

{
    "title":"Acceptable Response Values",
    "type":"array",
    "description":"The Acceptable Response Values resource manages details about the scoring criteria of each negotiation requirement.",
    "items":{
        "$ref":"#/components/schemas/supplierNegotiations-sections-requirements-acceptableResponseScoreValues-item-response"
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The Attachments resource manages details about attachments for a requirement.

Show Source

• Array of: object supplierNegotiations-sections-requirements-attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The Attachments resource manages details about attachments for a requirement.",
    "items":{
        "$ref":"#/components/schemas/supplierNegotiations-sections-requirements-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 : supplierNegotiations-sections-requirements-acceptableResponseScoreValues-item-response

Type: object

Show Source

• AttachmentsFromSuppliers: string
  Title: Attachments from Suppliers

  Maximum Length: 80

  Requirement for each supplier attachment. Values include Not Allowed, Optional, or Required. A list of accepted values is defined in the lookup type PON_REQ_ALLOW_ATTACHMENT.
• AttachmentsFromSuppliersCode: string
  Title: Attachments from Suppliers Code

  Maximum Length: 30

  Abbreviation that uniquely identifies the requirement for each supplier attachment. Values include Not Allowed, Optional, or Required. A list of accepted values is defined in the lookup type PON_REQ_ALLOW_ATTACHMENT.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the acceptable response score value.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the acceptable response score value.
• DateFromRange: string (date)
  Title: Date from Range

  Start date in the range of values. Applies for date attributes.
• DateTimeFromRange: string (date-time)
  Title: Date Time from Range

  Start date and time in the range of values. Applies for date and time attributes.
• DateTimeToRange: string (date-time)
  Title: Date Time to Range

  End date and time in the range of values. Applies for date and time attributes.
• DateToRange: string (date)
  Title: Date to Range

  End Date in the range of values. Applies for date attributes.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the acceptable response score value.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the acceptable response score value.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NoResponseFlag: boolean
  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then allow the application to assign a score to each supplier who does not respond to an optional requirement. If false, then do not allow. The default value is false.
• NumberFromRange: number
  Title: Number from Range

  Lowest number in a range of values. Applies for number attributes.
• NumberToRange: number
  Title: Number to Range

  Highest number in a range of values. Applies for number attributes.
• RequirementId: integer (int64)
  Read Only: true

  Value that uniquely identifies the requirement.
• Score: number
  Title: Score

  Score that the application assigns to each attribute response.
• ScoreDisplayNumber: string
  Read Only: true

  Maximum Length: 80

  Value that uniquely identifies the score display. The application sets this value for each requirement that uses Multiple Choice With Single Selection or Multiple Choice With Multiple Selections. It also sets this value for each response that replies to a number, date, or date time requirement.
• ScoreId: integer (int64)
  Read Only: true

  Value that uniquely identifies the score.
• Section: string
  Title: Section

  Read Only: true

  Name of the requirement section.
• SectionId: integer (int64)
  Read Only: true

  Value that uniquely identifies the section.
• TargetFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then set the value that the application is willing to accept as the target response value for the requirement. If false, then do not set. The default value is false.
• TextValue: string
  Title: Text Response Value

  Maximum Length: 1000

  Value that the user entered. This value is applicable for text values.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the acceptable response score value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the acceptable response score value.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ScoreDisplayNumber":{
            "maxLength":"80",
            "type":"string",
            "description":"Value that uniquely identifies the score display. The application sets this value for each requirement that uses Multiple Choice With Single Selection or Multiple Choice With Multiple Selections. It also sets this value for each response that replies to a number, date, or date time requirement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the acceptable response score value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DateToRange":{
            "title":"Date to Range",
            "type":"string",
            "description":"End Date in the range of values. Applies for date attributes.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "AttachmentsFromSuppliers":{
            "title":"Attachments from Suppliers",
            "maxLength":"80",
            "type":"string",
            "description":"Requirement for each supplier attachment. Values include Not Allowed, Optional, or Required. A list of accepted values is defined in the lookup type PON_REQ_ALLOW_ATTACHMENT.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ScoreId":{
            "type":"integer",
            "description":"Value that uniquely identifies the score.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Section":{
            "title":"Section",
            "type":"string",
            "description":"Name of the requirement section.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TargetFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then set the value that the application is willing to accept as the target response value for the requirement. If false, then do not set. The default value is false.",
            "nullable":true,
            "x-queryable":false
        },
        "Score":{
            "title":"Score",
            "type":"number",
            "description":"Score that the application assigns to each attribute response.",
            "nullable":true,
            "x-queryable":false
        },
        "TextValue":{
            "title":"Text Response Value",
            "maxLength":"1000",
            "type":"string",
            "description":"Value that the user entered. This value is applicable for text values.",
            "nullable":true,
            "x-queryable":false
        },
        "DateTimeToRange":{
            "title":"Date Time to Range",
            "type":"string",
            "description":"End date and time in the range of values. Applies for date and time attributes.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "NumberFromRange":{
            "title":"Number from Range",
            "type":"number",
            "description":"Lowest number in a range of values. Applies for number attributes.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RequirementId":{
            "type":"integer",
            "description":"Value that uniquely identifies the requirement.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "DateFromRange":{
            "title":"Date from Range",
            "type":"string",
            "description":"Start date in the range of values. Applies for date attributes.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "SectionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the section.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AttachmentsFromSuppliersCode":{
            "title":"Attachments from Suppliers Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the requirement for each supplier attachment. Values include Not Allowed, Optional, or Required. A list of accepted values is defined in the lookup type PON_REQ_ALLOW_ATTACHMENT.",
            "nullable":true,
            "x-queryable":false
        },
        "DateTimeFromRange":{
            "title":"Date Time from Range",
            "type":"string",
            "description":"Start date and time in the range of values. Applies for date and time attributes.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "NoResponseFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then allow the application to assign a score to each supplier who does not respond to an optional requirement. If false, then do not allow. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the acceptable response score value.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "NumberToRange":{
            "title":"Number to Range",
            "type":"number",
            "description":"Highest number in a range of values. Applies for number attributes.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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 : supplierNegotiations-sections-requirements-attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  An identifier used for tracking the uploaded files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  Value that uniquely identifies the attachment. It is a primary key that the application creates when the user attaches a 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 negotiation.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

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

  Maximum Length: 30

  Default Value: FILE

  Abbreviation that identifies the data type. Values include FILE, FOLDER, TEXT, or WEB_PAGE.
• Description: string
  Title: Description

  Maximum Length: 255

  Description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  Value that uniquely identifies the attached document.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Folder path of the attachment.
• DmVersionNumber: string
  Maximum Length: 255

  Number that identifies the version of the attached document.
• 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, 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 contents in the attachment expires.
• FileContents: string (byte)
  Title: File Contents

  Contents of the 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 attachment.
• 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 negotiation.
• 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) that identifies the attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  URI (Uniform Resource Identifier) that identifies the attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  Sign in details that the user used when adding or modifying the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the user created the attachment record.",
            "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":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"URI (Uniform Resource Identifier) that identifies 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":"URI (Uniform Resource Identifier) that identifies the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that uniquely identifies the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"Value that uniquely identifies the attachment. It is a primary key that the application creates when the user attaches a document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "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"
            }
        },
        "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 negotiation.",
            "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"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that identifies the version of the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "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
        },
        "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"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":"255",
            "type":"string",
            "description":"Sign in details that the user used when adding or modifying the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "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
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the data type. Values include FILE, FOLDER, TEXT, or WEB_PAGE.",
            "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 negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "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"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL (Uniform Resource Locator) of the attachment.",
            "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":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Date when the contents in the attachment expires.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Abbreviation that identifies the error, if any, for 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":"Folder path of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "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"
            }
        },
        "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
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"An identifier used for tracking the uploaded files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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

Back to Top

Examples

This example describes how to get all requirements.

Example cURL Command

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

curl -u username:password "https://servername/fscmRestApi/resources/version/supplierNegotiations/supplierNegotiationsUniqID/child/sections/SectionId/child/requirements"

Example Response Body

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

{
    "items": [
        {
            "RequirementId": 24705,
            "ParentType": "SECTION",
            "RequirementLevel": 1,
            "RequirementNumber": "1.",
            "Requirement": "RAM Spec",
            "RequirementText": "What is the size of the RAM?",
            "QuestionId": null,
            "QuestionRevisionNumber": null,
            "Hint": null,
            "Level": "Supplier site",
            "LevelCode": "SUPPLIER_SITE",
            "ResponseType": "Optional",
            "ResponseTypeCode": "OPTIONAL",
            "RequirementType": "Multiple choice with multiple selections",
            "RequirementTypeCode": "MCMS",
            "ValueType": "Single line text",
            "ValueTypeCode": "SINGLE_LINE_TEXT",
            "TargetTextValue": null,
            "TargetNumberValue": null,
            "TargetDateValue": null,
            "TargetDateTimeValue": null,
            "DisplayTargetFlag": false,
            "AttachmentsFromSuppliers": null,
            "AttachmentsFromSuppliersCode": null,
            "AllowCommentsFromSuppliersFlag": false,
            "ScoreId": -1,
            "ScoringMethod": "None",
            "ScoringMethodCode": "NONE",
            "Weight": null,
            "MaximumScore": null,
            "KnockoutScore": null,
            "CreatedBy": "CVBUYER01",
            "CreationDate": "2018-06-28T10:46:24+00:00",
            "LastUpdateDate": "2018-06-28T11:44:18.512+00:00",
            "LastUpdatedBy": "CVBUYER01",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/sections/11275/child/requirements/24705",
                    "name": "requirements",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/sections/11275/child/requirements/24705",
                    "name": "requirements",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/sections/11275",
                    "name": "sections",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/sections/11275/child/requirements/24705/child/acceptableResponseScoreValues",
                    "name": "acceptableResponseScoreValues",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/sections/11275/child/requirements/24705/child/attachments",
                    "name": "attachments",
                    "kind": "collection"
                }
            ]
        },
        {
            "RequirementId": 300100152360580,
            "ParentType": "SECTION",
            "RequirementLevel": 1,
            "RequirementNumber": "2.",
            "Requirement": "Color",
            "RequirementText": "What is the color of the laptop?",
            "QuestionId": null,
            "QuestionRevisionNumber": null,
            "Hint": null,
            "Level": "Supplier",
            "LevelCode": "SUPPLIER",
            "ResponseType": "Required",
            "ResponseTypeCode": "REQUIRED",
            "RequirementType": "Text entry box",
            "RequirementTypeCode": "INPUT_BOX",
            "ValueType": "Single line text",
            "ValueTypeCode": "SINGLE_LINE_TEXT",
            "TargetTextValue": null,
            "TargetNumberValue": null,
            "TargetDateValue": null,
            "TargetDateTimeValue": null,
            "DisplayTargetFlag": false,
            "AttachmentsFromSuppliers": "Not allowed",
            "AttachmentsFromSuppliersCode": "NOT_ALLOWED",
            "AllowCommentsFromSuppliersFlag": false,
            "ScoreId": -1,
            "ScoringMethod": "None",
            "ScoringMethodCode": "NONE",
            "Weight": null,
            "MaximumScore": null,
            "KnockoutScore": null,
            "CreatedBy": "CVBUYER01",
            "CreationDate": "2018-06-28T11:27:29.650+00:00",
            "LastUpdateDate": "2018-06-28T11:27:50.083+00:00",
            "LastUpdatedBy": "CVBUYER01",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/sections/11275/child/requirements/300100152360580",
                    "name": "requirements",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/sections/11275/child/requirements/300100152360580",
                    "name": "requirements",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/sections/11275",
                    "name": "sections",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/sections/11275/child/requirements/300100152360580/child/acceptableResponseScoreValues",
                    "name": "acceptableResponseScoreValues",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/sections/11275/child/requirements/300100152360580/child/attachments",
                    "name": "attachments",
                    "kind": "collection"
                }
            ]
        }
    ],
    "count": 2,
    "hasMore": false,
    "limit": 10,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/sections/11275/child/requirements",
            "name": "requirements",
            "kind": "collection"
        }
    ]
}

Back to Top