Jump to

• Request
• Response

Not supported

patch

/fscmRestApi/resources/11.13.18.05/channelCustomerMassClaimActions/{MassClaimActionId}/child/currencyTotals/{CurrencyCode}

Request

Path Parameters

• CurrencyCode(required): string
  Abbreviation that identifies the currency used for the channel claim.
• MassClaimActionId(required): integer(int64)
  Value that uniquely identifies the mass claim action performed. The value is a primary key that the application generates when it performs the mass claim action.

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

{
    "type":"object",
    "properties":{
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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 : channelCustomerMassClaimActions-currencyTotals-item-response

Type: object

Show Source

• Amount: number
  Read Only: true

  Total amount of claims selected for mass settlement or mass update.
• Currency: string
  Read Only: true

  Maximum Length: 80

  Name of the currency used for the channel claim.
• CurrencyCode: string
  Read Only: true

  Maximum Length: 255

  Abbreviation that identifies the currency used for the channel claim.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MassClaimActionId: integer (int64)
  Read Only: true

  Value that uniquely identifies the mass claim action performed.
• NumberOfClaims: number
  Read Only: true

  Number of claims selected for mass settlement or mass update.

{
    "type":"object",
    "properties":{
        "MassClaimActionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the mass claim action performed.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the currency used for the channel claim.",
            "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"
            }
        },
        "NumberOfClaims":{
            "type":"number",
            "description":"Number of claims selected for mass settlement or mass update.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Currency":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the currency used for the channel claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Amount":{
            "type":"number",
            "description":"Total amount of claims selected for mass settlement or mass update.",
            "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