Jump to

• Request
• Response

Create one response currency

post

/fscmRestApi/resources/11.13.18.05/supplierNegotiations/{supplierNegotiationsUniqID}/child/responseCurrencies

Request

Path Parameters

• 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

• AuctionHeaderId: integer (int64)
  Value that uniquely identifies the negotiation.
• ConversionRate: number
  Title: Conversion Rate

  Ratio between the negotiation currency and the response currency. The fixed rate to use between the currencies is defined in the gl_fixed_conv_rates table.
• NegotiationCurrencyCode: string
  Title: Negotiation Currency

  Maximum Length: 15

  Abbreviation that identifies the currency that the negotiation uses.
• PricePrecision: number
  Title: Price Precision

  Value that specifies the precision in number of digits after the decimal for the response currency.
• ResponseCurrencyCode: string
  Title: Response Currency

  Maximum Length: 15

  Abbreviation that identifies the currency that the response uses.
• ResponseCurrencyId: number
  Value that uniquely identifies the currency that the response uses.

{
    "type":"object",
    "properties":{
        "AuctionHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the negotiation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ConversionRate":{
            "title":"Conversion Rate",
            "type":"number",
            "description":"Ratio between the negotiation currency and the response currency. The fixed rate to use between the currencies is defined in the gl_fixed_conv_rates table.",
            "nullable":true,
            "x-queryable":false
        },
        "NegotiationCurrencyCode":{
            "title":"Negotiation Currency",
            "maxLength":15,
            "type":"string",
            "description":"Abbreviation that identifies the currency that the negotiation uses.",
            "nullable":false,
            "x-queryable":false
        },
        "ResponseCurrencyId":{
            "type":"number",
            "description":"Value that uniquely identifies the currency that the response uses.",
            "nullable":false
        },
        "ResponseCurrencyCode":{
            "title":"Response Currency",
            "maxLength":15,
            "type":"string",
            "description":"Abbreviation that identifies the currency that the response uses.",
            "nullable":false,
            "x-queryable":false
        },
        "PricePrecision":{
            "title":"Price Precision",
            "type":"number",
            "description":"Value that specifies the precision in number of digits after the decimal for the response currency.",
            "nullable":true,
            "x-queryable":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-responseCurrencies-item-response

Type: object

Show Source

• AuctionHeaderId: integer (int64)
  Value that uniquely identifies the negotiation.
• ConversionRate: number
  Title: Conversion Rate

  Ratio between the negotiation currency and the response currency. The fixed rate to use between the currencies is defined in the gl_fixed_conv_rates table.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date and time when the user created the response currency.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

  User who most recently updated the response currency.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NegotiationCurrencyCode: string
  Title: Negotiation Currency

  Maximum Length: 15

  Abbreviation that identifies the currency that the negotiation uses.
• PricePrecision: number
  Title: Price Precision

  Value that specifies the precision in number of digits after the decimal for the response currency.
• ResponseCurrency: string
  Title: Currency Name

  Read Only: true

  Maximum Length: 80

  Name of the currency that the response uses.
• ResponseCurrencyCode: string
  Title: Response Currency

  Maximum Length: 15

  Abbreviation that identifies the currency that the response uses.
• ResponseCurrencyDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  Text that describes the response currency. For example, the description for USD is US Dollar.
• ResponseCurrencyId: number
  Value that uniquely identifies the currency that the response uses.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the response currency.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "AuctionHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the negotiation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the response currency.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the response currency.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "NegotiationCurrencyCode":{
            "title":"Negotiation Currency",
            "maxLength":15,
            "type":"string",
            "description":"Abbreviation that identifies the currency that the negotiation uses.",
            "nullable":false,
            "x-queryable":false
        },
        "ResponseCurrencyId":{
            "type":"number",
            "description":"Value that uniquely identifies the currency that the response uses.",
            "nullable":false,
            "x-queryable":true
        },
        "ResponseCurrencyCode":{
            "title":"Response Currency",
            "maxLength":15,
            "type":"string",
            "description":"Abbreviation that identifies the currency that the response uses.",
            "nullable":false,
            "x-queryable":false
        },
        "PricePrecision":{
            "title":"Price Precision",
            "type":"number",
            "description":"Value that specifies the precision in number of digits after the decimal for the response currency.",
            "nullable":true,
            "x-queryable":false
        },
        "ResponseCurrencyDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Text that describes the response currency. For example, the description for USD is US Dollar.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ConversionRate":{
            "title":"Conversion Rate",
            "type":"number",
            "description":"Ratio between the negotiation currency and the response currency. The fixed rate to use between the currencies is defined in the gl_fixed_conv_rates table.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ResponseCurrency":{
            "title":"Currency Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the currency that the response uses.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the response currency.",
            "format":"date-time",
            "nullable":false,
            "readOnly":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."
        }
    }
}

Back to Top