Jump to

• Request
• Response

PATCH action not supported

patch

/fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Expense/{ExpenseUniqID}/child/matchedExpenses/{MatchReference}

Request

Path Parameters

• ExpenseUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Expenses resource and used to uniquely identify an instance of Expenses. The client should not generate the hash key value. Instead, the client should query on the Expenses collection resource in order to navigate to a specific instance of Expenses to get the hash key.
• MatchReference(required): string
  Unique identifier of a matched record.
• expenseReportsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Expense Reports resource and used to uniquely identify an instance of Expense Reports. The client should not generate the hash key value. Instead, the client should query on the Expense Reports collection resource in order to navigate to a specific instance of Expense Reports to get the hash key.

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

• MergedFlag: string
  Maximum Length: 1

  Indicates whether expenses are merged after a match.

{
    "type":"object",
    "properties":{
        "MergedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether expenses are merged after a match.",
            "nullable":true
        }
    }
}

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 : expenseReports-Expense-matchedExpenses-item-response

Type: object

Show Source

• ExpenseId: integer (int64)
  Read Only: true

  Unique identifier of an expense.
• links: array Links
  Title: Links

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

  Expense identifier of a matched record.
• MatchPercentage: number
  Read Only: true

  Percentage that indicates the strength of the match.
• MatchReference: string
  Read Only: true

  Maximum Length: 255

  Unique identifier of a matched record.
• MergedFlag: string
  Maximum Length: 1

  Indicates whether expenses are merged after a match.

{
    "type":"object",
    "properties":{
        "ExpenseId":{
            "type":"integer",
            "description":"Unique identifier of an expense.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MatchPercentage":{
            "type":"number",
            "description":"Percentage that indicates the strength of the match.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MatchReference":{
            "maxLength":255,
            "type":"string",
            "description":"Unique identifier of a matched record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MatchedExpenseId":{
            "type":"integer",
            "description":"Expense identifier of a matched record.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MergedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether expenses are merged after a match.",
            "nullable":true,
            "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."
        }
    }
}

Back to Top