Jump to

• Request
• Response

Create one response value for the default line attribute

post

/fscmRestApi/resources/11.13.18.05/supplierNegotiations/{supplierNegotiationsUniqID}/child/lineDefaultAttributeGroups/{GroupId}/child/lineDefaultAttributes/{AttributeId}/child/lineDefaultAcceptableResponseScoreValues

Request

Path Parameters

• AttributeId(required): number
  Value that identifies the default line attribute.
• GroupId(required): integer(int64)
  Value that identifies the default line attribute group.
• 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.

Header Parameters

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• FromDateResponseValue: string (date)
  Title: From Date Response Value

  Earliest date in the date range used by the application to score the attribute. Applicable for date values.
• FromNumberResponseValue: number
  Title: From Number Response Value

  Lowest number in the range used by the application to score the attribute. Applicable for numeric values.
• Score: number
  Title: Score

  Score assigned by the application to each attribute response.
• TextResponseValue: string
  Title: Text Response Value

  Maximum Length: 240

  Value accepted by the application for the attribute. Applies to text values.
• ToDateResponseValue: string (date)
  Title: To Date Response Value

  Most recent date in the date range used by the application to score the attribute. Applicable for date values.
• ToNumberResponseValue: number
  Title: To Number Response Value

  Highest number in the range used by the application to score the attribute. Applicable for numeric values.

{
    "type":"object",
    "properties":{
        "FromDateResponseValue":{
            "title":"From Date Response Value",
            "type":"string",
            "description":"Earliest date in the date range used by the application to score the attribute. Applicable for date values.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "FromNumberResponseValue":{
            "title":"From Number Response Value",
            "type":"number",
            "description":"Lowest number in the range used by the application to score the attribute. Applicable for numeric values.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Score":{
            "title":"Score",
            "type":"number",
            "description":"Score assigned by the application to each attribute response.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "sortable":false
            }
        },
        "TextResponseValue":{
            "title":"Text Response Value",
            "maxLength":240,
            "type":"string",
            "description":"Value accepted by the application for the attribute. Applies to text values.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ToDateResponseValue":{
            "title":"To Date Response Value",
            "type":"string",
            "description":"Most recent date in the date range used by the application to score the attribute. Applicable for date values.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ToNumberResponseValue":{
            "title":"To Number Response Value",
            "type":"number",
            "description":"Highest number in the range used by the application to score the attribute. Applicable for numeric values.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":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 : supplierNegotiations-lineDefaultAttributeGroups-lineDefaultAttributes-lineDefaultAcceptableResponseScoreValues-item-response

Type: object

Show Source

• AttributeId: number
  Title: Attribute ID

  Read Only: true

  Value that identifies the default line attribute.
• AuctionHeaderId: integer (int64)
  Title: Auction Header ID

  Read Only: true

  Value that uniquely identifies the negotiation.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who created the response value for the default line attribute.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date and time when the user created the response value for the default line attribute.
• FromDateResponseValue: string (date)
  Title: From Date Response Value

  Earliest date in the date range used by the application to score the attribute. Applicable for date values.
• FromNumberResponseValue: number
  Title: From Number Response Value

  Lowest number in the range used by the application to score the attribute. Applicable for numeric values.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Date and time when the user last updated the response value for the default line attribute.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User who last updated the response value for the default line attribute.
• links: array Links
  Title: Links

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

  Score assigned by the application to each attribute response.
• ScoreId: number
  Title: Score ID

  Read Only: true

  Value that uniquely identifies the score for the acceptable response of the default line attribute.
• TextResponseValue: string
  Title: Text Response Value

  Maximum Length: 240

  Value accepted by the application for the attribute. Applies to text values.
• ToDateResponseValue: string (date)
  Title: To Date Response Value

  Most recent date in the date range used by the application to score the attribute. Applicable for date values.
• ToNumberResponseValue: number
  Title: To Number Response Value

  Highest number in the range used by the application to score the attribute. Applicable for numeric values.

{
    "type":"object",
    "properties":{
        "AttributeId":{
            "title":"Attribute ID",
            "type":"number",
            "description":"Value that identifies the default line attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "AuctionHeaderId":{
            "title":"Auction Header ID",
            "type":"integer",
            "description":"Value that uniquely identifies the negotiation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "sortable":false
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the response value for the default line attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the user created the response value for the default line attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "FromDateResponseValue":{
            "title":"From Date Response Value",
            "type":"string",
            "description":"Earliest date in the date range used by the application to score the attribute. Applicable for date values.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "FromNumberResponseValue":{
            "title":"From Number Response Value",
            "type":"number",
            "description":"Lowest number in the range used by the application to score the attribute. Applicable for numeric values.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date and time when the user last updated the response value for the default line attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the response value for the default line attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Score":{
            "title":"Score",
            "type":"number",
            "description":"Score assigned by the application to each attribute response.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "sortable":false
            }
        },
        "ScoreId":{
            "title":"Score ID",
            "type":"number",
            "description":"Value that uniquely identifies the score for the acceptable response of the default line attribute.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "sortable":false
            },
            "x-queryable":true
        },
        "TextResponseValue":{
            "title":"Text Response Value",
            "maxLength":240,
            "type":"string",
            "description":"Value accepted by the application for the attribute. Applies to text values.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ToDateResponseValue":{
            "title":"To Date Response Value",
            "type":"string",
            "description":"Most recent date in the date range used by the application to score the attribute. Applicable for date values.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ToNumberResponseValue":{
            "title":"To Number Response Value",
            "type":"number",
            "description":"Highest number in the range used by the application to score the attribute. Applicable for numeric values.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top