Jump to

• Request
• Response

Update a response value for a line attribute

patch

/fscmRestApi/resources/11.13.18.05/draftSupplierNegotiationResponses/{draftSupplierNegotiationResponsesUniqID}/child/lines/{LineId}/child/lineAttributeGroups/{GroupId}/child/lineAttributes/{AttributeId}

Request

Path Parameters

• AttributeId(required): integer
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• GroupId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• LineId(required): number
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• draftSupplierNegotiationResponsesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Draft Supplier Negotiation Responses resource and used to uniquely identify an instance of Draft Supplier Negotiation Responses. The client should not generate the hash key value. Instead, the client should query on the Draft Supplier Negotiation Responses collection resource in order to navigate to a specific instance of Draft Supplier Negotiation Responses to get the hash key.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ResponseDateValue: string (date)
  Title: Response Date Value

  Response value of the line attribute. This value is a date.
• ResponseNumberValue: number
  Title: Response Number Value

  Response value of the line attribute. This value is a number data type.
• ResponseTextValue: string
  Title: Response Text Value

  Maximum Length: 4000

  Response value for the line attribute. This value is a text data type.

{
    "type":"object",
    "properties":{
        "ResponseDateValue":{
            "title":"Response Date Value",
            "type":"string",
            "description":"Response value of the line attribute. This value is a date.",
            "format":"date",
            "nullable":true
        },
        "ResponseNumberValue":{
            "title":"Response Number Value",
            "type":"number",
            "description":"Response value of the line attribute. This value is a number data type.",
            "nullable":true
        },
        "ResponseTextValue":{
            "title":"Response Text Value",
            "maxLength":"4000",
            "type":"string",
            "description":"Response value for the line attribute. This value is a text data type.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : draftSupplierNegotiationResponses-lines-lineAttributeGroups-lineAttributes-item-response

Type: object

Show Source

• AttributeId: integer
  Title: Attribute ID

  Read Only: true

  Value that identifies the attribute.
• AttributeName: string
  Title: Attribute

  Read Only: true

  Maximum Length: 4000

  Description of the attribute.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Identifies the user who created the row.
• CreationDate: string (date-time)
  Read Only: true

  Timestamp of the creation of the row.
• GroupId: integer (int64)
  Title: Group ID

  Read Only: true

  Value that uniquely identifies the line attribute groups.
• GroupName: string
  Title: Group Name

  Read Only: true

  Maximum Length: 240

  Name of the attribute group.
• LastUpdateDate: string (date-time)
  Read Only: true

  Timestamp of the last update of the row.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Identifies the user who last updated the row.
• Line: string
  Title: Line

  Read Only: true

  Maximum Length: 25

  Number that identifies the negotiation line.
• LineDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 2500

  Description of the line item.
• LineId: integer
  Title: Line ID

  Read Only: true

  Value that identifies the negotiation line.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ResponseDateValue: string (date)
  Title: Response Date Value

  Response value of the line attribute. This value is a date.
• ResponseNumber: integer (int64)
  Title: Response Number

  Read Only: true

  Identification number used for the supplier's internal tracking.
• ResponseNumberValue: number
  Title: Response Number Value

  Response value of the line attribute. This value is a number data type.
• ResponseTextValue: string
  Title: Response Text Value

  Maximum Length: 4000

  Response value for the line attribute. This value is a text data type.
• ResponseType: string
  Title: Response Type

  Read Only: true

  Maximum Length: 80

  Specifies whether the response for the line attribute is required. Values include required, optional, or not needed. A list of accepted values is defined in the lookup type PON_ATTRIBUTE_RESPONSE_TYPE.
• ResponseTypeCode: string
  Title: Response Type Code

  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies whether the response for the line attribute is required. Valid values are REQUIRED, OPTIONAL, and DISPLAY_ONLY. A list of accepted values is defined in the lookup type PON_ATTRIBUTE_RESPONSE_TYPE.
• Supplier: string
  Read Only: true

  Maximum Length: 255

  Name of the supplier who responds to the negotiation.
• SupplierId: integer
  Title: Supplier ID

  Read Only: true

  Value that uniquely identifies the supplier.
• TargetDateValue: string (date)
  Title: Target Date Value

  Read Only: true

  Target value of the attribute. This value is applicable for dates.
• TargetNumberValue: number
  Title: Target Number Value

  Read Only: true

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

  Read Only: true

  Maximum Length: 4000

  Target text or URL values of the attribute.
• ValueType: string
  Title: Value Type

  Read Only: true

  Maximum Length: 80

  Display name of the data type for the attribute response. For example, text, number, date, or URL (Uniform Resource Locator). A list of accepted values is defined in the lookup type Attribute Value Type.
• ValueTypeCode: string
  Title: Value Type Code

  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the type of value for the attribute response. Valid values are TXT, NUM, DAT, and URL. A list of accepted values is defined in the lookup type PON_AUCTION_ATTRIBUTE_TYPE.
• Weight: number
  Title: Weight

  Read Only: true

  Importance of the line attribute when compared to other line attributes. The application uses this weight when it calculates the line score.

{
    "type":"object",
    "properties":{
        "GroupName":{
            "title":"Group Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the attribute group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Timestamp of the creation of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResponseTypeCode":{
            "title":"Response Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies whether the response for the line attribute is required. Valid values are REQUIRED, OPTIONAL, and DISPLAY_ONLY. A list of accepted values is defined in the lookup type PON_ATTRIBUTE_RESPONSE_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TargetDateValue":{
            "title":"Target Date Value",
            "type":"string",
            "description":"Target value of the attribute. This value is applicable for dates.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeId":{
            "title":"Attribute ID",
            "type":"integer",
            "description":"Value that identifies the attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResponseNumberValue":{
            "title":"Response Number Value",
            "type":"number",
            "description":"Response value of the line attribute. This value is a number data type.",
            "nullable":true,
            "x-queryable":true
        },
        "LineDescription":{
            "title":"Description",
            "maxLength":"2500",
            "type":"string",
            "description":"Description of the line item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AttributeName":{
            "title":"Attribute",
            "maxLength":"4000",
            "type":"string",
            "description":"Description of the attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Supplier":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the supplier who responds to the negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ValueTypeCode":{
            "title":"Value Type Code",
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that identifies the type of value for the attribute response. Valid values are TXT, NUM, DAT, and URL. A list of accepted values is defined in the lookup type PON_AUCTION_ATTRIBUTE_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResponseNumber":{
            "title":"Response Number",
            "type":"integer",
            "description":"Identification number used for the supplier's internal tracking.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResponseTextValue":{
            "title":"Response Text Value",
            "maxLength":"4000",
            "type":"string",
            "description":"Response value for the line attribute. This value is a text data type.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Identifies the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Identifies the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LineId":{
            "title":"Line ID",
            "type":"integer",
            "description":"Value that identifies the negotiation line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ValueType":{
            "title":"Value Type",
            "maxLength":"80",
            "type":"string",
            "description":"Display name of the data type for the attribute response. For example, text, number, date, or URL (Uniform Resource Locator). A list of accepted values is defined in the lookup type Attribute Value Type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Weight":{
            "title":"Weight",
            "type":"number",
            "description":"Importance of the line attribute when compared to other line attributes. The application uses this weight when it calculates the line score.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GroupId":{
            "title":"Group ID",
            "type":"integer",
            "description":"Value that uniquely identifies the line attribute groups.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResponseType":{
            "title":"Response Type",
            "maxLength":"80",
            "type":"string",
            "description":"Specifies whether the response for the line attribute is required. Values include required, optional, or not needed. A list of accepted values is defined in the lookup type PON_ATTRIBUTE_RESPONSE_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Line":{
            "title":"Line",
            "maxLength":"25",
            "type":"string",
            "description":"Number that identifies the negotiation line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierId":{
            "title":"Supplier ID",
            "type":"integer",
            "description":"Value that uniquely identifies the supplier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TargetNumberValue":{
            "title":"Target Number Value",
            "type":"number",
            "description":"Target value for the attribute. This value is applicable for numbers.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TargetTextValue":{
            "title":"Target Text Value",
            "maxLength":"4000",
            "type":"string",
            "description":"Target text or URL values of the attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResponseDateValue":{
            "title":"Response Date Value",
            "type":"string",
            "description":"Response value of the line attribute. This value is a date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Timestamp of the last update of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

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

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

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

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

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

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

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

Nested Schema : properties

Type: object

Show Source

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

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

Back to Top