Jump to

• Request
• Response

Get payables and procurement options for all business units

get

/fscmRestApi/resources/11.13.18.05/payablesAndProcurementOptions

Request

Query Parameters

• 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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds the common options with the specified primary key.
    Finder Variables:
    • businessUnitId; integer; The unique business unit identifier.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • accrueExpenseItems; string; Defines the accrue expense items options.
  • alwaysTakeDiscount; string; Indicator if available discount for a supplier will be taken, regardless of when the invoice is paid, the default used during supplier entry.
  • automaticOffsets; string; Indicator that allows overriding of either the primary balancing segment or all segments, except the natural account segment when creating the liability account.
  • billPayable; string; The Accounting Flexfield identifier for the future dated payment account the default for suppliers and bank accounts.
  • billToLocation; string; The location identifier for the headquarter location of your company.
  • billToLocationId; integer; Location identifier for the headquarter location of your company.
  • businessUnit; string; The Indicator of the business unit name for the Payables and Procurement options.
  • businessUnitId; integer; Indicates the business unit ID for the Payables and Procurement options.
  • buyingCompanyIdentifier; string; A unique identifier that identifies the buying business unit. The identifier is included on the invoice number of invoices created by the pay on receipt process or debit memos from return on receipt transactions.
  • conversionRateType; string; Specifies the default conversion rate type when you enter invoices or create payments.
  • conversionRateVarianceGain; string; The Accounting Flexfield identifier for the account used to record exchange rate gains for invoices matched to purchase orders.
  • conversionRateVarianceLoss; string; The Accounting Flexfield identifier for the account used to record exchange rate losses for invoices matched to purchase orders.
  • createdBy; string; The user who created the record.
  • creationDate; string; The date when the record was created.
  • discountTaken; string; The Accounting Flexfield identifier for the discount taken account.
  • freight; string; The Accounting Flexfield identifier for the Payables freight account.
  • gaplessInvoiceNumberingFlag; boolean; The gapless invoice numbering option indicator.
  • holdUnmatchedInvoicesFlag; boolean; The default Hold Unmatched Invoices value for a supplier.
  • invoiceCurrency; string; The currency code for invoices, the default used during supplier entry.
  • lastUpdateDate; string; The date when the record was last updated.
  • lastUpdateLogin; string; The session login associated to the user who last updated the record.
  • lastUpdatedBy; string; The user who last updated the record.
  • liability; string; The Accounting Flexfield identifier for the Payables liability account, the default used during invoice entry.
  • miscellaneous; string; The Accounting Flexfield identifier for the Payables miscellaneous account, that is used for supplier portal invoices.
  • offsetSegments; string; The code for the method used to build offsetting accounting flexfields for invoice and payment distributions that create automatic offsets for fund accounting.
  • oneTimePaymentExpense; string; The account combination that the invoice expense is booked for the one time payments functionality.
  • oneTimePaymentLiability; string; The account combination that the invoice liability is booked for the one time payments functionality.
  • payAlone; string; The default Pay Alone value for suppliers.
  • payDateBasis; string; The basis used for selecting invoices for payment that are due or have a discount, the default used during supplier entry.
  • paymentConversionRateType; string; The required information for the conversion rate for payments.
  • paymentCurrency; string; The currency code for payments, the default used during supplier entry.
  • paymentTerms; integer; The payment terms identifier, the default used during supplier entry.
  • prepayment; string; The Accounting Flexfield identifier for the prepayment account, the default used during supplier entry.
  • prepaymentTaxDifference; string; The account to which any prepayment tax difference amount will be charged.
  • realizedGainDistribution; string; The Accounting Flexfield identifier for the account that is the realized exchange rate when gains are posted.
  • realizedLossDistribution; string; The Accounting Flexfield identifier for the account that is realized when the exchange rate losses are posted.
  • requireConversioRateEntryFlag; boolean; The required information about the conversion rate for invoices.
  • taxCountryCode; string; The European Union or EU member state designation for your organization.
  • taxRegistrationMemberState; string; The European Union or EU member state designation for your organization.
  • taxRegistrationNumber; string; The value-added tax registration number for your organization.
  • termsDateBasis; string; The date used together with the payment terms and invoice amount to create an invoice scheduled payment, the default used during supplier entry.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

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(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 : payablesAndProcurementOptions

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/payablesAndProcurementOptions-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object payablesAndProcurementOptions-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/payablesAndProcurementOptions-item-response"
    }
}

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

Type: object

Show Source

• accrueExpenseItems: string
  Title: Accrue Expense Items

  Maximum Length: 25

  Default Value: RECEIPT

  Defines the accrue expense items options.
• alwaysTakeDiscount: string
  Maximum Length: 1

  Indicator if available discount for a supplier will be taken, regardless of when the invoice is paid, the default used during supplier entry.
• automaticOffsets: string
  Maximum Length: 1

  Indicator that allows overriding of either the primary balancing segment or all segments, except the natural account segment when creating the liability account.
• billPayable: string
  The Accounting Flexfield identifier for the future dated payment account the default for suppliers and bank accounts.
• billToLocation: string
  The location identifier for the headquarter location of your company.
• billToLocationId: integer (int64)
  Title: Bill-to Location

  Location identifier for the headquarter location of your company.
• businessUnit: string
  The Indicator of the business unit name for the Payables and Procurement options.
• businessUnitId: integer (int64)
  Indicates the business unit ID for the Payables and Procurement options.
• buyingCompanyIdentifier: string
  Title: Buying Company Identifier

  Maximum Length: 10

  A unique identifier that identifies the buying business unit. The identifier is included on the invoice number of invoices created by the pay on receipt process or debit memos from return on receipt transactions.
• conversionRateType: string
  Specifies the default conversion rate type when you enter invoices or create payments.
• conversionRateVarianceGain: string
  The Accounting Flexfield identifier for the account used to record exchange rate gains for invoices matched to purchase orders.
• conversionRateVarianceLoss: string
  The Accounting Flexfield identifier for the account used to record exchange rate losses for invoices matched to purchase orders.
• createdBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the record.
• creationDate: string (date-time)
  Read Only: true

  The date when the record was created.
• discountTaken: string
  The Accounting Flexfield identifier for the discount taken account.
• freight: string
  The Accounting Flexfield identifier for the Payables freight account.
• gaplessInvoiceNumberingFlag: boolean
  Title: Gapless invoice numbering

  Maximum Length: 1

  Default Value: false

  The gapless invoice numbering option indicator.
• holdUnmatchedInvoicesFlag: boolean
  Maximum Length: 1

  The default Hold Unmatched Invoices value for a supplier.
• invoiceCurrency: string
  Maximum Length: 15

  The currency code for invoices, the default used during supplier entry.
• lastUpdateDate: string (date-time)
  Read Only: true

  The date when the record was last updated.
• lastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• lastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The session login associated to the user who last updated the record.
• liability: string
  The Accounting Flexfield identifier for the Payables liability account, the default used during invoice entry.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• miscellaneous: string
  The Accounting Flexfield identifier for the Payables miscellaneous account, that is used for supplier portal invoices.
• offsetSegments: string
  Maximum Length: 25

  Default Value: NONE

  The code for the method used to build offsetting accounting flexfields for invoice and payment distributions that create automatic offsets for fund accounting.
• oneTimePaymentExpense: string
  The account combination that the invoice expense is booked for the one time payments functionality.
• oneTimePaymentLiability: string
  The account combination that the invoice liability is booked for the one time payments functionality.
• payAlone: string
  Maximum Length: 1

  The default Pay Alone value for suppliers.
• payDateBasis: string
  Maximum Length: 25

  The basis used for selecting invoices for payment that are due or have a discount, the default used during supplier entry.
• paymentConversionRateType: string
  Maximum Length: 30

  Default Value: Corporate

  The required information for the conversion rate for payments.
• paymentCurrency: string
  Maximum Length: 15

  The currency code for payments, the default used during supplier entry.
• paymentTerms: integer (int64)
  The payment terms identifier, the default used during supplier entry.
• prepayment: string
  The Accounting Flexfield identifier for the prepayment account, the default used during supplier entry.
• prepaymentTaxDifference: string
  The account to which any prepayment tax difference amount will be charged.
• realizedGainDistribution: string
  The Accounting Flexfield identifier for the account that is the realized exchange rate when gains are posted.
• realizedLossDistribution: string
  The Accounting Flexfield identifier for the account that is realized when the exchange rate losses are posted.
• requireConversioRateEntryFlag: boolean
  Title: Require conversion rate entry

  Maximum Length: 1

  Default Value: true

  The required information about the conversion rate for invoices.
• taxCountryCode: string
  Title: VAT Registration Member State

  Maximum Length: 15

  The European Union or EU member state designation for your organization.
• taxRegistrationMemberState: string
  The European Union or EU member state designation for your organization.
• taxRegistrationNumber: string
  Title: VAT Registration Number

  Maximum Length: 20

  The value-added tax registration number for your organization.
• termsDateBasis: string
  Maximum Length: 25

  The date used together with the payment terms and invoice amount to create an invoice scheduled payment, the default used during supplier entry.

{
    "type":"object",
    "properties":{
        "miscellaneous":{
            "type":"string",
            "description":"The Accounting Flexfield identifier for the Payables miscellaneous account, that is used for supplier portal invoices.",
            "nullable":true,
            "x-queryable":true
        },
        "businessUnit":{
            "type":"string",
            "description":"The Indicator of the business unit name for the Payables and Procurement options.",
            "nullable":true,
            "x-queryable":true
        },
        "lastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "freight":{
            "type":"string",
            "description":"The Accounting Flexfield identifier for the Payables freight account.",
            "nullable":true,
            "x-queryable":true
        },
        "conversionRateVarianceGain":{
            "type":"string",
            "description":"The Accounting Flexfield identifier for the account used to record exchange rate gains for invoices matched to purchase orders.",
            "nullable":true,
            "x-queryable":true
        },
        "paymentConversionRateType":{
            "maxLength":30,
            "type":"string",
            "description":"The required information for the conversion rate for payments.",
            "nullable":true,
            "default":"Corporate",
            "x-queryable":true
        },
        "lastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The session login associated to the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "holdUnmatchedInvoicesFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The default Hold Unmatched Invoices value for a supplier.",
            "nullable":true,
            "x-queryable":true
        },
        "oneTimePaymentExpense":{
            "type":"string",
            "description":"The account combination that the invoice expense is booked for the one time payments functionality.",
            "nullable":true,
            "x-queryable":true
        },
        "buyingCompanyIdentifier":{
            "title":"Buying Company Identifier",
            "maxLength":10,
            "type":"string",
            "description":"A unique identifier that identifies the buying business unit. The identifier is included on the invoice number of invoices created by the pay on receipt process or debit memos from return on receipt transactions.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "gaplessInvoiceNumberingFlag"
                ]
            },
            "x-queryable":true
        },
        "businessUnitId":{
            "type":"integer",
            "description":"Indicates the business unit ID for the Payables and Procurement options.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:APPLCORE_SETID_DETERMINANT_TYPE":"BU"
            },
            "x-queryable":true
        },
        "prepayment":{
            "type":"string",
            "description":"The Accounting Flexfield identifier for the prepayment account, the default used during supplier entry.",
            "nullable":true,
            "x-queryable":true
        },
        "alwaysTakeDiscount":{
            "maxLength":1,
            "type":"string",
            "description":"Indicator if available discount for a supplier will be taken, regardless of when the invoice is paid, the default used during supplier entry.",
            "nullable":true,
            "x-queryable":true
        },
        "invoiceCurrency":{
            "maxLength":15,
            "type":"string",
            "description":"The currency code for invoices, the default used during supplier entry.",
            "nullable":true,
            "x-queryable":true
        },
        "termsDateBasis":{
            "maxLength":25,
            "type":"string",
            "description":"The date used together with the payment terms and invoice amount to create an invoice scheduled payment, the default used during supplier entry.",
            "nullable":true,
            "x-queryable":true
        },
        "payAlone":{
            "maxLength":1,
            "type":"string",
            "description":"The default Pay Alone value for suppliers.",
            "nullable":true,
            "x-queryable":true
        },
        "realizedGainDistribution":{
            "type":"string",
            "description":"The Accounting Flexfield identifier for the account that is the realized exchange rate when gains are posted.",
            "nullable":true,
            "x-queryable":true
        },
        "accrueExpenseItems":{
            "title":"Accrue Expense Items",
            "maxLength":25,
            "type":"string",
            "description":"Defines the accrue expense items options.",
            "nullable":true,
            "default":"RECEIPT",
            "x-queryable":true
        },
        "automaticOffsets":{
            "maxLength":1,
            "type":"string",
            "description":"Indicator that allows overriding of either the primary balancing segment or all segments, except the natural account segment when creating the liability account.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "taxRegistrationMemberState":{
            "type":"string",
            "description":"The European Union or EU member state designation for your organization.",
            "nullable":true,
            "x-queryable":true
        },
        "paymentTerms":{
            "type":"integer",
            "description":"The payment terms identifier, the default used during supplier entry.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "oneTimePaymentLiability":{
            "type":"string",
            "description":"The account combination that the invoice liability is booked for the one time payments functionality.",
            "nullable":true,
            "x-queryable":true
        },
        "lastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "realizedLossDistribution":{
            "type":"string",
            "description":"The Accounting Flexfield identifier for the account that is realized when the exchange rate losses are posted.",
            "nullable":true,
            "x-queryable":true
        },
        "billPayable":{
            "type":"string",
            "description":"The Accounting Flexfield identifier for the future dated payment account the default for suppliers and bank accounts.",
            "nullable":true,
            "x-queryable":true
        },
        "liability":{
            "type":"string",
            "description":"The Accounting Flexfield identifier for the Payables liability account, the default used during invoice entry.",
            "nullable":true,
            "x-queryable":true
        },
        "conversionRateVarianceLoss":{
            "type":"string",
            "description":"The Accounting Flexfield identifier for the account used to record exchange rate losses for invoices matched to purchase orders.",
            "nullable":true,
            "x-queryable":true
        },
        "billToLocationId":{
            "title":"Bill-to Location",
            "type":"integer",
            "description":"Location identifier for the headquarter location of your company.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "fnd:APPLCORE_SETID_DETERMINANT_ATTR":"OrgId"
            },
            "x-queryable":true
        },
        "creationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "conversionRateType":{
            "type":"string",
            "description":"Specifies the default conversion rate type when you enter invoices or create payments.",
            "nullable":true,
            "x-queryable":true
        },
        "prepaymentTaxDifference":{
            "type":"string",
            "description":"The account to which any prepayment tax difference amount will be charged.",
            "nullable":true,
            "x-queryable":true
        },
        "taxCountryCode":{
            "title":"VAT Registration Member State",
            "maxLength":15,
            "type":"string",
            "description":"The European Union or EU member state designation for your organization.",
            "nullable":true,
            "x-queryable":true
        },
        "createdBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "requireConversioRateEntryFlag":{
            "title":"Require conversion rate entry",
            "maxLength":1,
            "type":"boolean",
            "description":"The required information about the conversion rate for invoices.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "billToLocation":{
            "type":"string",
            "description":"The location identifier for the headquarter location of your company.",
            "nullable":true,
            "x-queryable":true
        },
        "discountTaken":{
            "type":"string",
            "description":"The Accounting Flexfield identifier for the discount taken account.",
            "nullable":true,
            "x-queryable":true
        },
        "taxRegistrationNumber":{
            "title":"VAT Registration Number",
            "maxLength":20,
            "type":"string",
            "description":"The value-added tax registration number for your organization.",
            "nullable":true,
            "x-queryable":true
        },
        "payDateBasis":{
            "maxLength":25,
            "type":"string",
            "description":"The basis used for selecting invoices for payment that are due or have a discount, the default used during supplier entry.",
            "nullable":true,
            "x-queryable":true
        },
        "offsetSegments":{
            "maxLength":25,
            "type":"string",
            "description":"The code for the method used to build offsetting accounting flexfields for invoice and payment distributions that create automatic offsets for fund accounting.",
            "nullable":true,
            "default":"NONE",
            "x-queryable":true
        },
        "gaplessInvoiceNumberingFlag":{
            "title":"Gapless invoice numbering",
            "maxLength":1,
            "type":"boolean",
            "description":"The gapless invoice numbering option indicator.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "paymentCurrency":{
            "maxLength":15,
            "type":"string",
            "description":"The currency code for payments, the default used during supplier entry.",
            "nullable":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