Jump to

• Request
• Response

Update a currency

patch

/fscmRestApi/resources/11.13.18.05/publicSectorCurrencies/{CurrencyCode}

Request

Path Parameters

• CurrencyCode(required): string
  Currency code identifier.

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

• CurrencyCodeISONumber: string
  Maximum Length: 3

  The three-digit code for the currency according to the ISO 4217 standard.
• DecimalPosition: integer (int32)
  Title: Decimal Position

  The number of decimal positions used for amounts in the related currency.
• DeletedFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.
• Description: string
  Title: Description

  Maximum Length: 50

  The description of the currency.
• SeedDataLock: integer (int32)
  Default Value: 0

  Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.

{
    "type":"object",
    "properties":{
        "DeletedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.",
            "nullable":false,
            "default":false
        },
        "DecimalPosition":{
            "title":"Decimal Position",
            "type":"integer",
            "description":"The number of decimal positions used for amounts in the related currency.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"1"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"50",
            "type":"string",
            "description":"The description of the currency.",
            "nullable":false
        },
        "CurrencyCodeISONumber":{
            "maxLength":"3",
            "type":"string",
            "description":"The three-digit code for the currency according to the ISO 4217 standard.",
            "nullable":false
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.",
            "format":"int32",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"1"
            }
        }
    }
}

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

Type: object

Show Source

• CreationDate: string (date-time)
  Read Only: true

  The date and time that the currency was created.
• CurrencyCode: string
  Title: Currency Code

  Maximum Length: 3

  Currency code identifier.
• CurrencyCodeISONumber: string
  Maximum Length: 3

  The three-digit code for the currency according to the ISO 4217 standard.
• DecimalPosition: integer (int32)
  Title: Decimal Position

  The number of decimal positions used for amounts in the related currency.
• DeletedFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.
• Description: string
  Title: Description

  Maximum Length: 50

  The description of the currency.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time that the currency waslast updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SeedDataLock: integer (int32)
  Default Value: 0

  Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.

{
    "type":"object",
    "properties":{
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":"3",
            "type":"string",
            "description":"Currency code identifier.",
            "nullable":false,
            "x-hints":{
                "promptField":"Y",
                "promptList":"Y",
                "promptValue":"Y"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time that the currency was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"50",
            "type":"string",
            "description":"The description of the currency.",
            "nullable":false,
            "x-queryable":true
        },
        "CurrencyCodeISONumber":{
            "maxLength":"3",
            "type":"string",
            "description":"The three-digit code for the currency according to the ISO 4217 standard.",
            "nullable":false,
            "x-queryable":true
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.",
            "format":"int32",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DecimalPosition":{
            "title":"Decimal Position",
            "type":"integer",
            "description":"The number of decimal positions used for amounts in the related currency.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time that  the currency waslast updated.",
            "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