Jump to

• Request
• Response

Update one conversion rule

patch

/fscmRestApi/resources/11.13.18.05/currencyConversionLists/{CurrencyConvListId}/child/conversions/{CurrencyConvDetailId}

Request

Path Parameters

• CurrencyConvDetailId(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=
• CurrencyConvListId(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=

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AdjustmentType: string
  Maximum Length: 255

  Abbreviation that indicates the adjustment type in the currency conversion.
• AdjustmentTypeCode: string
  Title: Adjustment Type

  Maximum Length: 30

  Abbreviation that indicates the adjustment type in the currency conversion.
• AdjustmentValue: number
  Title: Adjustment Amount

  Value of the adjustment in the currency conversion.
• ConversionRate: number
  Title: Conversion Rate

  Rate of the currency conversion.
• ConversionType: string
  Maximum Length: 255

  Abbreviation that indicates the conversion type in the currency conversion.
• ConversionTypeCode: string
  Title: Conversion Type

  Maximum Length: 30

  Default Value: FIXED

  Abbreviation that indicates the conversion type in the currency conversion.
• CurrencyConvDetailId: integer (int64)
  Value that uniquely identifies the currency conversion detail.
• CurrencyConvListId: integer (int64)
  Value that uniquely identifies the currency conversion list.
• detailsDFF: array detailsDFF
• EndDate: string (date-time)
  Title: End Date

  Date when the currency conversion expires.
• GlConversionType: string
  Maximum Length: 255

  Abbreviation that indicates the conversion type in general ledger in the conversion.
• GlConversionTypeCode: string
  Title: GL Conversion Type

  Maximum Length: 30

  Abbreviation that indicates the conversion type in general ledger in the conversion.
• StartDate: string (date-time)
  Title: Start Date

  Effective date of the currency conversion.

{
    "type":"object",
    "properties":{
        "AdjustmentType":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that indicates the adjustment type in the currency conversion.",
            "nullable":true
        },
        "AdjustmentTypeCode":{
            "title":"Adjustment Type",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that indicates the adjustment type in the currency conversion.",
            "nullable":true
        },
        "AdjustmentValue":{
            "title":"Adjustment Amount",
            "type":"number",
            "description":"Value of the adjustment in the currency conversion.",
            "nullable":true
        },
        "ConversionRate":{
            "title":"Conversion Rate",
            "type":"number",
            "description":"Rate of the currency conversion.",
            "nullable":true
        },
        "ConversionType":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that indicates the conversion type in the currency conversion.",
            "nullable":true
        },
        "ConversionTypeCode":{
            "title":"Conversion Type",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that indicates the conversion type in the currency conversion.",
            "nullable":false,
            "default":"FIXED"
        },
        "CurrencyConvDetailId":{
            "type":"integer",
            "description":"Value that uniquely identifies the currency conversion detail.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "CurrencyConvListId":{
            "type":"integer",
            "description":"Value that uniquely identifies the currency conversion list.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date when the currency conversion expires.",
            "format":"date-time",
            "nullable":true
        },
        "GlConversionType":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that indicates the conversion type in general ledger in the conversion.",
            "nullable":true
        },
        "GlConversionTypeCode":{
            "title":"GL Conversion Type",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that indicates the conversion type in general ledger in the conversion.",
            "nullable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Effective date of the currency conversion.",
            "format":"date-time",
            "nullable":false
        },
        "detailsDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/currencyConversionLists-conversions-detailsDFF-item-patch-request"
            },
            "x-cardinality":"1"
        }
    }
}

Nested Schema : detailsDFF

Type: array

Show Source

• Array of: object currencyConversionLists-conversions-detailsDFF-item-patch-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/currencyConversionLists-conversions-detailsDFF-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : currencyConversionLists-conversions-detailsDFF-item-patch-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 150

  Context Value
• __FLEX_Context_DisplayValue: string
  Title: Context Value

  Context Value
• CurrencyConvDetailId: integer (int64)

{
    "type":"object",
    "properties":{
        "CurrencyConvDetailId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":150,
            "type":"string",
            "description":"Context Value",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Context Value"
                },
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"Context Value",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context Value"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

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 : currencyConversionLists-conversions-item-response

Type: object

Show Source

• AdjustmentType: string
  Maximum Length: 255

  Abbreviation that indicates the adjustment type in the currency conversion.
• AdjustmentTypeCode: string
  Title: Adjustment Type

  Maximum Length: 30

  Abbreviation that indicates the adjustment type in the currency conversion.
• AdjustmentValue: number
  Title: Adjustment Amount

  Value of the adjustment in the currency conversion.
• ConversionRate: number
  Title: Conversion Rate

  Rate of the currency conversion.
• ConversionType: string
  Maximum Length: 255

  Abbreviation that indicates the conversion type in the currency conversion.
• ConversionTypeCode: string
  Title: Conversion Type

  Maximum Length: 30

  Default Value: FIXED

  Abbreviation that indicates the conversion type in the currency conversion.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date and time when the user created the record.
• CurrencyConvDetailId: integer (int64)
  Value that uniquely identifies the currency conversion detail.
• CurrencyConvListId: integer (int64)
  Value that uniquely identifies the currency conversion list.
• detailsDFF: array detailsDFF
• EndDate: string (date-time)
  Title: End Date

  Date when the currency conversion expires.
• FromCurrency: string
  Maximum Length: 255

  Base currency in the conversion.
• FromCurrencyCode: string
  Title: Base Currency

  Maximum Length: 15

  Abbreviation that indicates the base currency in the conversion.
• GlConversionType: string
  Maximum Length: 255

  Abbreviation that indicates the conversion type in general ledger in the conversion.
• GlConversionTypeCode: string
  Title: GL Conversion Type

  Maximum Length: 30

  Abbreviation that indicates the conversion type in general ledger in the conversion.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

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

  The link relations associated with the resource instance.
• StartDate: string (date-time)
  Title: Start Date

  Effective date of the currency conversion.
• ToCurrency: string
  Maximum Length: 255

  Target currency of the conversion.
• ToCurrencyCode: string
  Title: To Currency

  Maximum Length: 15

  Abbreviation that indicates the target currency of the conversion.

{
    "type":"object",
    "properties":{
        "AdjustmentType":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that indicates the adjustment type in the currency conversion.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentTypeCode":{
            "title":"Adjustment Type",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that indicates the adjustment type in the currency conversion.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentValue":{
            "title":"Adjustment Amount",
            "type":"number",
            "description":"Value of the adjustment in the currency conversion.",
            "nullable":true,
            "x-queryable":true
        },
        "ConversionRate":{
            "title":"Conversion Rate",
            "type":"number",
            "description":"Rate of the currency conversion.",
            "nullable":true,
            "x-queryable":true
        },
        "ConversionType":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that indicates the conversion type in the currency conversion.",
            "nullable":true,
            "x-queryable":true
        },
        "ConversionTypeCode":{
            "title":"Conversion Type",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that indicates the conversion type in the currency conversion.",
            "nullable":false,
            "default":"FIXED",
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyConvDetailId":{
            "type":"integer",
            "description":"Value that uniquely identifies the currency conversion detail.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CurrencyConvListId":{
            "type":"integer",
            "description":"Value that uniquely identifies the currency conversion list.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date when the currency conversion expires.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "FromCurrency":{
            "maxLength":255,
            "type":"string",
            "description":"Base currency in the conversion.",
            "nullable":true,
            "x-queryable":true
        },
        "FromCurrencyCode":{
            "title":"Base Currency",
            "maxLength":15,
            "type":"string",
            "description":"Abbreviation that indicates the base currency in the conversion.",
            "nullable":false,
            "x-queryable":true
        },
        "GlConversionType":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that indicates the conversion type in general ledger in the conversion.",
            "nullable":true,
            "x-queryable":true
        },
        "GlConversionTypeCode":{
            "title":"GL Conversion Type",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that indicates the conversion type in general ledger in the conversion.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Effective date of the currency conversion.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "ToCurrency":{
            "maxLength":255,
            "type":"string",
            "description":"Target currency of the conversion.",
            "nullable":true,
            "x-queryable":true
        },
        "ToCurrencyCode":{
            "title":"To Currency",
            "maxLength":15,
            "type":"string",
            "description":"Abbreviation that indicates the target currency of the conversion.",
            "nullable":false,
            "x-queryable":true
        },
        "detailsDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/currencyConversionLists-conversions-detailsDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : detailsDFF

Type: array

Show Source

• Array of: object currencyConversionLists-conversions-detailsDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/currencyConversionLists-conversions-detailsDFF-item-response"
    },
    "x-cardinality":"1"
}

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 : currencyConversionLists-conversions-detailsDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 150

  Context Value
• __FLEX_Context_DisplayValue: string
  Title: Context Value

  Context Value
• CurrencyConvDetailId: integer (int64)
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "CurrencyConvDetailId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":150,
            "type":"string",
            "description":"Context Value",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Context Value"
                },
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"Context Value",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context Value"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "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."
        }
    }
}

Links

detailsDFF

Operation: /fscmRestApi/resources/11.13.18.05/currencyConversionLists/{CurrencyConvListId}/child/conversions/{CurrencyConvDetailId}/child/detailsDFF

Parameters:

• CurrencyConvDetailId: $request.path.CurrencyConvDetailId
• CurrencyConvListId: $request.path.CurrencyConvListId

validateDateOverlap

Operation: /fscmRestApi/resources/11.13.18.05/currencyConversionLists/{CurrencyConvListId}/child/conversions/{CurrencyConvDetailId}/action/validateDateOverlap

Parameters:

• CurrencyConvDetailId: $request.path.CurrencyConvDetailId
• CurrencyConvListId: $request.path.CurrencyConvListId

Validates the date overlap for a currency conversion

Back to Top