Jump to

• Request
• Response

Get one currency-based approval attribute

get

/fscmRestApi/resources/11.13.18.05/approvalCurrencyAttributes/{CurrencyAttributeId}

Request

Path Parameters

• CurrencyAttributeId(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=

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 : approvalCurrencyAttributes-item-response

Type: object

Show Source

• AttributeToConvert: string
  Title: Attribute to Convert

  Read Only: true

  Maximum Length: 255

  Name of the approval attribute selected for currency conversion in the currency-based approval attribute.
• AttributeToConvertId: integer (int64)
  Unique identifier of the approval attribute selected for currency conversion in the currency-based approval attribute.
• AttributeToConvertKey: string
  Maximum Length: 100

  Key that identifies the approval attribute selected for currency conversion in the currency-based approval attribute.
• ConversionRateType: string
  Maximum Length: 30

  Conversion rate type used to convert the approval attribute value in the currency-based approval attribute.
• ConvertToCurrency: string
  Title: Convert To

  Read Only: true

  Maximum Length: 80

  Currency to which the approval attribute value is converted in the currency-based approval attribute.
• ConvertToCurrencyCode: string
  Maximum Length: 30

  Abbreviation that identifies the currency to which the approval attribute value is converted in the currency-based approval attribute.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the currency-based approval attribute.
• CreatedDate: string (date-time)
  Read Only: true

  The date when the currency-based approval attribute was created.
• CurrencyAttribute: string
  Title: User-Defined Attribute

  Maximum Length: 100

  Name of the currency-based approval attribute available for use in approval rules.
• CurrencyAttributeId: integer (int64)
  Read Only: true

  Unique identifier of the currency-based approval attribute.
• InternalApprovalAttribute: string
  Title: Internal Approval Attribute

  Read Only: true

  Maximum Length: 255

  Internal approval attribute derived from the combination of the dimension key and the attribute key associated with the approval task.
• InternalApprovalAttributeId: integer (int64)
  Read Only: true

  Unique identifier of the internal approval attribute associated with the approval task.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the currency-based approval attribute was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the currency-based approval attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• TaskId: integer (int64)
  Unique identifier of the approval task.
• UserConversionRateType: string
  Title: Conversion Rate Type

  Read Only: true

  Maximum Length: 30

  Name of the user-defined conversion rate type used to determine the currency conversion rate for the approval request in the currency-based approval attribute.

{
    "type":"object",
    "properties":{
        "AttributeToConvert":{
            "title":"Attribute to Convert",
            "maxLength":255,
            "type":"string",
            "description":"Name of the approval attribute selected for currency conversion in the currency-based approval attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "AttributeToConvertId":{
            "type":"integer",
            "description":"Unique identifier of the approval attribute selected for currency conversion in the currency-based approval attribute.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "sortable":false
            }
        },
        "AttributeToConvertKey":{
            "maxLength":100,
            "type":"string",
            "description":"Key that identifies the approval attribute selected for currency conversion in the currency-based approval attribute.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ConversionRateType":{
            "maxLength":30,
            "type":"string",
            "description":"Conversion rate type used to convert the approval attribute value in the currency-based approval attribute.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ConvertToCurrency":{
            "title":"Convert To",
            "maxLength":80,
            "type":"string",
            "description":"Currency to which the approval attribute value is converted in the currency-based approval attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ConvertToCurrencyCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the currency to which the approval attribute value is converted in the currency-based approval attribute.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the currency-based approval attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CreatedDate":{
            "type":"string",
            "description":"The date when the currency-based approval attribute was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CurrencyAttribute":{
            "title":"User-Defined Attribute",
            "maxLength":100,
            "type":"string",
            "description":"Name of the currency-based approval attribute available for use in approval rules.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CurrencyAttributeId":{
            "type":"integer",
            "description":"Unique identifier of the currency-based approval attribute.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "sortable":false,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "InternalApprovalAttribute":{
            "title":"Internal Approval Attribute",
            "maxLength":255,
            "type":"string",
            "description":"Internal approval attribute derived from the combination of the dimension key and the attribute key associated with the approval task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "InternalApprovalAttributeId":{
            "type":"integer",
            "description":"Unique identifier of the internal approval attribute associated with the approval task.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "sortable":false
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the currency-based approval attribute was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the currency-based approval attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "TaskId":{
            "type":"integer",
            "description":"Unique identifier of the approval task.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "sortable":false
            },
            "x-queryable":true
        },
        "UserConversionRateType":{
            "title":"Conversion Rate Type",
            "maxLength":30,
            "type":"string",
            "description":"Name of the user-defined conversion rate type used to determine the currency conversion rate for the approval request in the currency-based approval attribute.",
            "nullable":false,
            "readOnly":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