Jump to

• Request
• Response

Get one claim

get

/fscmRestApi/resources/11.13.18.05/channelCustomerMassClaimActions/{MassClaimActionId}/child/claims/{MassActionClaimId}

Request

Path Parameters

• MassActionClaimId(required): integer(int64)
  Value that uniquely identifies a claim for mass action. The value is a primary key that the application generates when the user selects a claim for mass action
• 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.

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 : channelCustomerMassClaimActions-claims-item-response

Type: object

Show Source

• Amount: number
  Read Only: true

  Amount claimed in the claim currency.
• BillToAccount: string
  Read Only: true

  Maximum Length: 30

  Number of the bill-to customer account.
• BillToAddress: string
  Read Only: true

  Maximum Length: 4000

  Address of the bill-to customer account site.
• BillToCustomer: string
  Read Only: true

  Maximum Length: 360

  Name of the bill-to customer account.
• ClaimDate: string (date)
  Read Only: true

  Date when a claim is created.
• ClaimId: integer (int64)
  Value that uniquely identifies the customer claim.
• ClaimNumber: string
  Maximum Length: 30

  Number that indicates the customer claim.
• ClaimReason: string
  Read Only: true

  Maximum Length: 120

  Reason for creating the claim.
• ClaimSource: string
  Read Only: true

  Maximum Length: 80

  Name of the claim sources.
• ClaimSourceCode: string
  Read Only: true

  Abbreviation that identifies the source of the claim.
• ClaimType: string
  Read Only: true

  Maximum Length: 120

  Type that enable you to classify claims.
• 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.
• CurrencyCode: string
  Read Only: true

  Maximum Length: 80

  Abbreviation that identifies the currency used for the channel claim.
• CustomerReference: string
  Read Only: true

  Maximum Length: 360

  Number that identifies the reference details passed by the customer.
• LastUpdateDate: string (date-time)
  Read Only: true

  User who most recently updated the record.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Date and time when the user most recently updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MassActionClaimId: integer (int64)
  Value that uniquely identifies a claim for mass action. The value is a primary key that the application generates when the user selects a claim for mass action
• MassClaimActionId: integer (int64)
  Value that uniquely identifies the mass claim action performed.
• Owner: string
  Read Only: true

  Maximum Length: 360

  Name of the person who owns the claim.
• ShipToSite: string
  Read Only: true

  Maximum Length: 391

  Name of the ship-to customer site.
• Status: string
  Read Only: true

  Maximum Length: 50

  Status of the channel claim.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":50,
            "type":"string",
            "description":"Status of the channel claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MassClaimActionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the mass claim action performed.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "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
        },
        "ClaimNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number that indicates the customer claim.",
            "nullable":true,
            "x-queryable":true
        },
        "Owner":{
            "maxLength":360,
            "type":"string",
            "description":"Name of the person who owns the claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClaimId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer claim.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MassActionClaimId":{
            "type":"integer",
            "description":"Value that uniquely identifies a claim for mass action. The value is a primary key that the application generates when the user selects a claim for mass action",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Amount":{
            "type":"number",
            "description":"Amount claimed in the claim currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClaimSource":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the claim sources.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClaimType":{
            "maxLength":120,
            "type":"string",
            "description":"Type that enable you to classify claims.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClaimSourceCode":{
            "type":"string",
            "description":"Abbreviation that identifies the source of the claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BillToAddress":{
            "maxLength":4000,
            "type":"string",
            "description":"Address of the bill-to customer account site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":80,
            "type":"string",
            "description":"Abbreviation that identifies the currency used for the channel claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClaimReason":{
            "maxLength":120,
            "type":"string",
            "description":"Reason for creating the claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipToSite":{
            "maxLength":391,
            "type":"string",
            "description":"Name of the ship-to customer site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerReference":{
            "maxLength":360,
            "type":"string",
            "description":"Number that identifies the reference details passed by the customer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BillToAccount":{
            "maxLength":30,
            "type":"string",
            "description":"Number of the bill-to customer account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BillToCustomer":{
            "maxLength":360,
            "type":"string",
            "description":"Name of the bill-to customer account.",
            "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"
            }
        },
        "ClaimDate":{
            "type":"string",
            "description":"Date when a claim is created.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"User who most recently updated the record.",
            "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