Jump to

• Request
• Response

Get one respond by spreadsheet error

get

/fscmRestApi/resources/11.13.18.05/draftSupplierNegotiationResponses/{draftSupplierNegotiationResponsesUniqID}/child/respondBySpreadsheetErrors/{respondBySpreadsheetErrorsUniqID}

Request

Path Parameters

• 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.
• respondBySpreadsheetErrorsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- AuctionHeaderId, BatchId and BidNumber ---for the Spreadsheet Errors resource and used to uniquely identify an instance of Spreadsheet Errors. The client should not generate the hash key value. Instead, the client should query on the Spreadsheet Errors collection resource with a filter on the primary key values in order to navigate to a specific instance of Spreadsheet Errors.
  
  For example: respondBySpreadsheetErrors?q=AuctionHeaderId=<value1>;BatchId=<value2>;BidNumber=<value3>

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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

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 : draftSupplierNegotiationResponses-respondBySpreadsheetErrors-item-response

Type: object

Show Source

• AuctionHeaderId: integer
  Read Only: true

  A unique ID assigned to each negotiation.
• BatchId: integer (int64)
  Read Only: true

  Unique ID assigned to the set of errors generated during the spreadsheet import in a negotiation response.
• BidNumber: integer (int64)
  Read Only: true

  Value that identifies the negotiation response.
• ColumnDisplayName: string
  Read Only: true

  Maximum Length: 255

  Display name of the error column. It refers to the attribute's display name in the General, Lines, or Requirements worksheet (spreadsheet tabs) where an error occurred during the spreadsheet import.
• ColumnName: string
  Title: Column Title

  Read Only: true

  Maximum Length: 240

  Internal name of the error column. It refers to the internal code of the attribute in the General, Lines, or Requirements worksheets (spreadsheet tabs) where an error occurred during the spreadsheet import.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Identifies the user who created the row.
• EntityNameDisplay: string
  Title: Table Name

  Read Only: true

  Maximum Length: 255

  Names of the sections in the import spreadsheet, such as Requirements and Lines, that may contain errors during the spreadsheet import.
• ErrorMessageDisplay: string
  Title: Error

  Read Only: true

  Maximum Length: 255

  Error message generated during the spreadsheet import.
• ErrorValue: string
  Read Only: true

  Maximum Length: 4000

  Data type of the attribute with the error in text format.
• ErrorValueDatatype: string
  Read Only: true

  Maximum Length: 3

  Data type of the attribute containing the error.
• ErrorValueDate: string (date)
  Read Only: true

  Data type of the attribute with the error in the date format.
• ErrorValueDatetime: string (date-time)
  Read Only: true

  Data type of the attribute with the error in the date time format.
• ErrorValueNumber: number
  Read Only: true

  Data type of the attribute with the error in the number format.
• InterfaceLineId: number
  Title: Spreadsheet Row Number

  Read Only: true

  Negotiation line number in the spreadsheet that contains an error.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Timestamp of the last update of the row.
• links: array Links
  Title: Links

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

  Read Only: true

  Maximum Length: 80

  Name of the worksheet, such as General and Lines, in the spreadsheet that may contains errors.
• WorksheetSequenceNumber: number
  Read Only: true

  Sequence number of the worksheet (spreadsheet tab) that contains an error, such as 1 for General and 2 for Lines.

{
    "type":"object",
    "properties":{
        "AuctionHeaderId":{
            "type":"integer",
            "description":"A unique ID assigned to each negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Timestamp of the last update of the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ColumnDisplayName":{
            "maxLength":255,
            "type":"string",
            "description":"Display name of the error column. It refers to the attribute's display name in the General, Lines, or Requirements worksheet (spreadsheet tabs) where an error occurred during the spreadsheet import.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Identifies the user who created the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BatchId":{
            "type":"integer",
            "description":"Unique ID assigned to the set of errors generated during the spreadsheet import in a negotiation response.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BidNumber":{
            "type":"integer",
            "description":"Value that identifies the negotiation response.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ErrorValueNumber":{
            "type":"number",
            "description":"Data type of the attribute with the error in the number format.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorksheetSequenceNumber":{
            "type":"number",
            "description":"Sequence number of the worksheet (spreadsheet tab) that contains an error, such as 1 for General and 2 for Lines.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ColumnName":{
            "title":"Column Title",
            "maxLength":240,
            "type":"string",
            "description":"Internal name of the error column. It refers to the internal code of the attribute in the General, Lines, or Requirements worksheets (spreadsheet tabs) where an error occurred during the spreadsheet import.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ErrorValueDatetime":{
            "type":"string",
            "description":"Data type of the attribute with the error in the date time format.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ErrorValueDatatype":{
            "maxLength":3,
            "type":"string",
            "description":"Data type of the attribute containing the error.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ErrorValueDate":{
            "type":"string",
            "description":"Data type of the attribute with the error in the date format.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ErrorValue":{
            "maxLength":4000,
            "type":"string",
            "description":"Data type of the attribute with the error in text format.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InterfaceLineId":{
            "title":"Spreadsheet Row Number",
            "type":"number",
            "description":"Negotiation line number in the spreadsheet that contains an error.",
            "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"
            }
        },
        "ErrorMessageDisplay":{
            "title":"Error",
            "maxLength":255,
            "type":"string",
            "description":"Error message generated during the spreadsheet import.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EntityNameDisplay":{
            "title":"Table Name",
            "maxLength":255,
            "type":"string",
            "description":"Names of the sections in the import spreadsheet, such as Requirements and Lines, that may contain errors during the spreadsheet import.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorksheetName":{
            "title":"Worksheet Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the worksheet, such as General and Lines, in the spreadsheet that may contains errors.",
            "nullable":true,
            "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