Jump to

• Request
• Response

Get all fees for the project record

get

/fscmRestApi/resources/11.13.18.05/publicSectorProjectRecordFeePayments

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 row that matches the primary key criteria.
    Finder Variables:
    • AgencyId; integer; The identifier of the public sector agency.
    • ProjectCode; string; The unique identifier of the string for a project.
    • RecordKey; integer; The identifier of the application record. The value is generated based on the auto number rule configured for the type of record.
  • insSimpleSearchFinder: Finds a record assigned to a project that matches the specified keyword.
    Finder Variables:
    • value; string; The keyword used to find an inspection row.
  • simpleSearchFinder: Finds the record assigned to a project that matches the specified keyword.
    Finder Variables:
    • value; string; The keyword used to find the fee item of the record assigned to a project.
• 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:
  

  • AgencyId; integer; The unique identifier of the public sector agency.
  • Classification; string; The classification of the record type.
  • CreatedBy; string; The name of the user who created the record.
  • CreationDate; string; The date and time when the record was created.
  • LastUpdateDate; string; The date and time when the record was last updated.
  • LastUpdatedBy; string; The name of the user who last updated the assignment.
  • ProjectCode; string; The unique identifier of the project.
  • RecordId; string; The identifier of the application record. The value is generated based on the auto number rule configured for the type of record.
  • RecordKey; integer; The unique identifier of the record.
• 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: 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 : publicSectorProjectRecordFeePayments

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":{
        "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."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/publicSectorProjectRecordFeePayments-item-response"
            }
        },
        "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"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "subgroup":"Projects",
        "usage":"BusinessObject",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorProjectRecordFeePayments-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/publicSectorProjectRecordFeePayments-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 : publicSectorProjectRecordFeePayments-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Read Only: true

  The unique identifier of the public sector agency.
• Classification: string
  Read Only: true

  Maximum Length: 3

  The classification of the record type.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date and time when the record was created.
• FeeRecordDisplay: array Record Fee Payments
  Title: Record Fee Payments

  The resource contains all the details related to the transaction fee item.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The name of the user who last updated the assignment.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProjectCode: string
  Read Only: true

  Maximum Length: 30

  The unique identifier of the project.
• RecordId: string
  Read Only: true

  Maximum Length: 50

  The identifier of the application record. The value is generated based on the auto number rule configured for the type of record.
• RecordKey: integer (int64)
  Read Only: true

  The unique identifier of the record.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the public sector agency.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "Classification":{
            "maxLength":3,
            "type":"string",
            "description":"The classification of the record type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeRecordDisplay":{
            "title":"Record Fee Payments",
            "type":"array",
            "description":"The resource contains all the details related to the transaction fee item.",
            "items":{
                "$ref":"#/components/schemas/publicSectorProjectRecordFeePayments-FeeRecordDisplay-item-response"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectCode":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the project.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordId":{
            "maxLength":50,
            "type":"string",
            "description":"The identifier of the application record. The value is generated based on the auto number rule configured for the type of record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordKey":{
            "type":"integer",
            "description":"The unique identifier of the record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Record Fee Payments

Type: array

Title: Record Fee Payments

The resource contains all the details related to the transaction fee item.

Show Source

• Array of: object publicSectorProjectRecordFeePayments-FeeRecordDisplay-item-response

{
    "title":"Record Fee Payments",
    "type":"array",
    "description":"The resource contains all the details related to the transaction fee item.",
    "items":{
        "$ref":"#/components/schemas/publicSectorProjectRecordFeePayments-FeeRecordDisplay-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 : publicSectorProjectRecordFeePayments-FeeRecordDisplay-item-response

Type: object

Show Source

• AccountingEventStatus: string
  Title: Accounting Event Status

  Maximum Length: 3

  Default Value: I

  The status of the accounting event.
• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The unique identifier of the public sector agency.
• AssessedDate: string (date)
  Title: Assessed Date

  The date when the fee item was assessed.
• BillType: string
  Title: Bill Type

  Maximum Length: 15

  Determines the default invoice values for the invoice form and invoice number ID. The values are taken from the source application.
• CreatedFor: string
  Maximum Length: 30

  The phase when the fee was created.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 3

  The default currency code for the fee schedule.
• DepartmentDescription: string
  Read Only: true

  Maximum Length: 100

  The description of the department.
• DepartmentId: string
  Title: Department

  Maximum Length: 30

  The department identifier of the fee item.
• Description: string
  Title: Fee Description

  Read Only: true

  Maximum Length: 50

  The description of the fee item.
• DueDate: string (date)
  Title: Due Date

  The due date for the fee item.
• FeeAmount: number
  Title: Amount

  The fee amount.
• FeeItemId: string
  Title: Fee Item

  Maximum Length: 30

  The unique identifier of the fee that can be assessed for one or more record types.
• FeeMemo: string
  Title: Memo

  Maximum Length: 200

  The memo content for the fee item.
• FeeQuantity: number
  Title: Fee Quantity

  The fee quantity.
• FeeRecordKey: integer (int64)
  Title: Fee Record

  The unique identifier of the fee record.
• FeeSource: string
  Title: Source

  Maximum Length: 3

  The source from which the fee is collected.
• FeeStatus: string
  Title: Status

  Maximum Length: 6

  The fee status.
• FeeStatusMeaning: string
  Read Only: true

  Maximum Length: 255

  The meaning of the fee status.
• Invoice: string
  Title: Invoice

  Maximum Length: 50

  The invoice number for the associated bill header.
• InvoiceDate: string (date)
  Title: Invoice Date

  Date the invoice was generated.
• InvoiceId: integer (int64)
  Title: Invoice ID

  Unique identifier of the invoice.
• InvoiceLine: integer (int64)
  Title: Invoice Line

  The invoice line number.
• InvoiceRequestStatus: string
  Title: Invoice Request Status

  Maximum Length: 30

  The request status when generating an invoice.
• InvoiceSystemCd: string
  Title: Invoice System Code

  Maximum Length: 30

  The source of the invoicing system.
• LicensePeriod: string
  Maximum Length: 100

  The license period of the application.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LnpRecordKey: integer (int64)
  The unique identifier of the record.
• MappingSource: string
  Title: Mapping Source

  Maximum Length: 10

  The mapping source of the application.
• PaymentDate: string (date-time)
  Title: Payment Date

  The date when the payment was made.
• PaymentMethodCode: string
  Title: Payment Method

  Maximum Length: 30

  The payment method code that is configured for the current payment option.
• PaymentReferenceId: string
  Title: Payment Reference

  Maximum Length: 50

  The unique identifier of the payment.
• PaymentSystemCd: string
  Title: Payment System Code

  Maximum Length: 30

  Indicates the source of the payment system.
• ReceiptNumber: string
  Title: Receipt

  Maximum Length: 50

  The receipt number.
• RefundedAmount: number
  The total amount refunded for the fee item.
• RefundedCurrencyCode: string
  Maximum Length: 3

  The currency code for the refund.
• RefundReason: string
  Maximum Length: 30

  The reason for the refund.
• ReversalReason: string
  Maximum Length: 30

  The reason for the reversal.
• ReversedAmount: number
  The total fee amount reversed.
• ReversedCurrencyCode: string
  Maximum Length: 3

  The currency code for the reversal.
• RevrecDateOption: string
  Title: Revenue Recognition Date

  Maximum Length: 30

  Indicates the options for the revenue recognition accounting date. The options are Fee Paid, Fee Assessed, and Fee Refunded. The default value is None.

{
    "type":"object",
    "properties":{
        "AccountingEventStatus":{
            "title":"Accounting Event Status",
            "maxLength":3,
            "type":"string",
            "description":"The status of the accounting event.",
            "nullable":true,
            "default":"I",
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the public sector agency.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "AssessedDate":{
            "title":"Assessed Date",
            "type":"string",
            "description":"The date when the fee item was assessed.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "BillType":{
            "title":"Bill Type",
            "maxLength":15,
            "type":"string",
            "description":"Determines the default invoice values for the invoice form and invoice number ID. The values are taken from the source application.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedFor":{
            "maxLength":30,
            "type":"string",
            "description":"The phase when the fee was created.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":3,
            "type":"string",
            "description":"The default currency code for the fee schedule.",
            "nullable":false,
            "x-queryable":true
        },
        "DepartmentDescription":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the department.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DepartmentId":{
            "title":"Department",
            "maxLength":30,
            "type":"string",
            "description":"The department identifier of the fee item.",
            "nullable":false,
            "x-queryable":true
        },
        "Description":{
            "title":"Fee Description",
            "maxLength":50,
            "type":"string",
            "description":"The description of the fee item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DueDate":{
            "title":"Due Date",
            "type":"string",
            "description":"The due date for the fee item.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "FeeAmount":{
            "title":"Amount",
            "type":"number",
            "description":"The fee amount.",
            "nullable":false,
            "x-queryable":true
        },
        "FeeItemId":{
            "title":"Fee Item",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the fee that can be assessed for one or more record types.",
            "nullable":false,
            "x-queryable":true
        },
        "FeeMemo":{
            "title":"Memo",
            "maxLength":200,
            "type":"string",
            "description":"The memo content for the fee item.",
            "nullable":true,
            "x-queryable":true
        },
        "FeeQuantity":{
            "title":"Fee Quantity",
            "type":"number",
            "description":"The fee quantity.",
            "nullable":true,
            "x-queryable":true
        },
        "FeeRecordKey":{
            "title":"Fee Record",
            "type":"integer",
            "description":"The unique identifier of the fee record.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "FeeSource":{
            "title":"Source",
            "maxLength":3,
            "type":"string",
            "description":"The source from which the fee is collected.",
            "nullable":true,
            "x-queryable":true
        },
        "FeeStatus":{
            "title":"Status",
            "maxLength":6,
            "type":"string",
            "description":"The fee status.",
            "nullable":false,
            "x-queryable":true
        },
        "FeeStatusMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"The meaning of the fee status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Invoice":{
            "title":"Invoice",
            "maxLength":50,
            "type":"string",
            "description":"The invoice number for the associated bill header.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceDate":{
            "title":"Invoice Date",
            "type":"string",
            "description":"Date the invoice was generated.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceId":{
            "title":"Invoice ID",
            "type":"integer",
            "description":"Unique identifier of the invoice.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InvoiceLine":{
            "title":"Invoice Line",
            "type":"integer",
            "description":"The invoice line number.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InvoiceRequestStatus":{
            "title":"Invoice Request Status",
            "maxLength":30,
            "type":"string",
            "description":"The request status when generating an invoice.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceSystemCd":{
            "title":"Invoice System Code",
            "maxLength":30,
            "type":"string",
            "description":"The source of the invoicing system.",
            "nullable":true,
            "x-queryable":true
        },
        "LicensePeriod":{
            "maxLength":100,
            "type":"string",
            "description":"The license period of the application.",
            "nullable":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier of the record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MappingSource":{
            "title":"Mapping Source",
            "maxLength":10,
            "type":"string",
            "description":"The mapping source of the application.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentDate":{
            "title":"Payment Date",
            "type":"string",
            "description":"The date when the payment was made.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentMethodCode":{
            "title":"Payment Method",
            "maxLength":30,
            "type":"string",
            "description":"The payment method code that is configured for the current payment option.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentReferenceId":{
            "title":"Payment Reference",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the payment.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentSystemCd":{
            "title":"Payment System Code",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the source of the payment system.",
            "nullable":true,
            "x-queryable":true
        },
        "ReceiptNumber":{
            "title":"Receipt",
            "maxLength":50,
            "type":"string",
            "description":"The receipt number.",
            "nullable":true,
            "x-queryable":true
        },
        "RefundReason":{
            "maxLength":30,
            "type":"string",
            "description":"The reason for the refund.",
            "nullable":true,
            "x-queryable":true
        },
        "RefundedAmount":{
            "type":"number",
            "description":"The total amount refunded for the fee item.",
            "nullable":true,
            "x-queryable":true
        },
        "RefundedCurrencyCode":{
            "maxLength":3,
            "type":"string",
            "description":"The currency code for the refund.",
            "nullable":true,
            "x-queryable":true
        },
        "ReversalReason":{
            "maxLength":30,
            "type":"string",
            "description":"The reason for the reversal.",
            "nullable":true,
            "x-queryable":true
        },
        "ReversedAmount":{
            "type":"number",
            "description":"The total fee amount reversed.",
            "nullable":true,
            "x-queryable":true
        },
        "ReversedCurrencyCode":{
            "maxLength":3,
            "type":"string",
            "description":"The currency code for the reversal.",
            "nullable":true,
            "x-queryable":true
        },
        "RevrecDateOption":{
            "title":"Revenue Recognition Date",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the options for the revenue recognition accounting date. The options are Fee Paid, Fee Assessed, and Fee Refunded. The default value is None.",
            "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