Jump to

• Request
• Response

Get all higher education customer accounts

get

/fscmRestApi/resources/11.13.18.05/hedCustomerAccounts

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 specific higher education customer account that matches the primary key criteria specified.
    Finder Variables
    • PartyId; integer; The unique identifier of the higher education customer account.
• 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:
  

  • EmailAddress; string; The email address for the party.
  • PartyId; integer; The unique identifier of the party the customer account is associated with. Party is a generic term covering both people and also entities like businesses, schools, branches of a government, and nonprofit organizations.
  • PartyName; string; The name of the party the customer account is associated with. Party is a generic term covering both people and also entities like businesses, schools, branches of a government, and nonprofit organizations.
  • PartyTypeCode; string; Code for the type of party the customer account is associated with. Valid values are Person and Organization. Organizations are entities like businesses, schools, charities, branches of a government, or similar.
  • PartyTypeMeaning; string; Meaning for the party type code the customer account is associated with. Valid values are Person and Organization. Organizations are entities like businesses, schools, charities, branches of a government, or similar.
  • StatusMessage; string; Message providing information about the current status of accounts and account relationships of the user.
  • ValidRelationshipFlag; boolean; Indicates that both the proxy and student's customer accounts and the relationship between these accounts exist.
• 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 : hedCustomerAccounts

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/hedCustomerAccounts-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"HED"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object hedCustomerAccounts-item-response

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

Type: object

Show Source

• EmailAddress: string
  Title: Email Address

  Read Only: true

  Maximum Length: 320

  The email address for the party.
• linkedAccountDetails: array Linked Account Details
  Title: Linked Account Details

  Linked customer accounts are the in receivables customer accounts that are configured such that they can be used in student management.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OtherAccounts: integer
  Title: Other Accounts

  Read Only: true

  The number of customer accounts assigned to the party. When the number is greater than zero, the party has accounts in Receivables that won't be visible from or used by Student Management.
• PartyId: integer
  Title: Party ID

  The unique identifier of the party the customer account is associated with. Party is a generic term covering both people and also entities like businesses, schools, branches of a government, and nonprofit organizations.
• PartyName: string
  Title: Party Name

  Read Only: true

  Maximum Length: 360

  The name of the party the customer account is associated with. Party is a generic term covering both people and also entities like businesses, schools, branches of a government, and nonprofit organizations.
• PartyTypeCode: string
  Title: Party Type Code

  Read Only: true

  Maximum Length: 30

  Code for the type of party the customer account is associated with. Valid values are Person and Organization. Organizations are entities like businesses, schools, charities, branches of a government, or similar.
• PartyTypeMeaning: string
  Title: Party Type Meaning

  Read Only: true

  Maximum Length: 80

  Meaning for the party type code the customer account is associated with. Valid values are Person and Organization. Organizations are entities like businesses, schools, charities, branches of a government, or similar.
• StatusMessage: string
  Title: Status Message

  Message providing information about the current status of accounts and account relationships of the user.
• tagAssignments: array Tag Assignments
  Title: Tag Assignments

  Tag assignments track the attribute tags assigned to a person.
• ValidRelationshipFlag: boolean
  Title: Valid Relationship Indicator

  Indicates that both the proxy and student's customer accounts and the relationship between these accounts exist.

{
    "type":"object",
    "properties":{
        "tagAssignments":{
            "title":"Tag Assignments",
            "type":"array",
            "description":"Tag assignments track the attribute tags assigned to a person.",
            "items":{
                "$ref":"#/components/schemas/hedCustomerAccounts-tagAssignments-item-response"
            }
        },
        "PartyTypeMeaning":{
            "title":"Party Type Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Meaning for the party type code the customer account is associated with. Valid values are Person and Organization. Organizations are entities like businesses, schools, charities, branches of a government, or similar.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the party the customer account is associated with. Party is a generic term covering both people and also entities like businesses, schools, branches of a government, and nonprofit organizations.",
            "nullable":false,
            "x-queryable":true
        },
        "PartyTypeCode":{
            "title":"Party Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Code for the type of party the customer account is associated with. Valid values are Person and Organization. Organizations are entities like businesses, schools, charities, branches of a government, or similar.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OtherAccounts":{
            "title":"Other Accounts",
            "type":"integer",
            "description":"The number of customer accounts assigned to the party. When the number is greater than zero, the party has accounts in Receivables that won't be visible from or used by Student Management.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PartyName":{
            "title":"Party Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the party the customer account is associated with. Party is a generic term covering both people and also entities like businesses, schools, branches of a government, and nonprofit organizations.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ValidRelationshipFlag":{
            "title":"Valid Relationship Indicator",
            "type":"boolean",
            "description":"Indicates that both the proxy and student's customer accounts and the relationship between these accounts exist.",
            "nullable":true,
            "x-queryable":true
        },
        "linkedAccountDetails":{
            "title":"Linked Account Details",
            "type":"array",
            "description":"Linked customer accounts are the in receivables customer accounts that are configured such that they can be used in student management.",
            "items":{
                "$ref":"#/components/schemas/hedCustomerAccounts-linkedAccountDetails-item-response"
            }
        },
        "EmailAddress":{
            "title":"Email Address",
            "maxLength":320,
            "type":"string",
            "description":"The email address for the party.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusMessage":{
            "title":"Status Message",
            "type":"string",
            "description":"Message providing information about the current status of accounts and account relationships of the user.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Linked Account Details

Type: array

Title: Linked Account Details

Linked customer accounts are the in receivables customer accounts that are configured such that they can be used in student management.

Show Source

• Array of: object hedCustomerAccounts-linkedAccountDetails-item-response

{
    "title":"Linked Account Details",
    "type":"array",
    "description":"Linked customer accounts are the in receivables customer accounts that are configured such that they can be used in student management.",
    "items":{
        "$ref":"#/components/schemas/hedCustomerAccounts-linkedAccountDetails-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 : Tag Assignments

Type: array

Title: Tag Assignments

Tag assignments track the attribute tags assigned to a person.

Show Source

• Array of: object hedCustomerAccounts-tagAssignments-item-response

{
    "title":"Tag Assignments",
    "type":"array",
    "description":"Tag assignments track the attribute tags assigned to a person.",
    "items":{
        "$ref":"#/components/schemas/hedCustomerAccounts-tagAssignments-item-response"
    }
}

Nested Schema : hedCustomerAccounts-linkedAccountDetails-item-response

Type: object

Show Source

• AccountId: integer
  Title: Account ID

  Read Only: true

  The unique identifier for a Receivables customer account.
• AccountNumber: string
  Title: Account Number

  Read Only: true

  The number that identifies a customer account.
• AccountTypeCode: string
  Title: Account Type Code

  Read Only: true

  Code indicating the type of customer account.
• AccountTypeMeaning: string
  Title: Account Type Meaning

  Read Only: true

  Maximum Length: 255

  Meaning of the customer account type code.
• CustomerClassCode: string
  Title: Customer Class Code

  The unique identifier of the customer class assigned to the customer account.
• CustomerClassMeaning: string
  Title: Customer Class Meaning

  Read Only: true

  Maximum Length: 255

  The meaning of the customer class assigned to the customer account.
• CustomerProfileClassId: integer
  Title: Customer Profile Class ID

  Code indicating the account's customer profile class. Customer profile classes organize customer accounts into categories that reflect the needs of the deploying company.
• CustomerProfileClassName: string
  Title: Customer Profile Class Name

  Read Only: true

  Maximum Length: 255

  The name of the account's customer profile class. Customer profile classes organize customer accounts into categories that reflect the needs of the deploying company.
• DefaultFlag: boolean
  Title: Default Indicator

  Indicates whether a customer account is the default account for a person. If true, Student Management automated processes will use the account when creating transactions. When false, the account can be viewed in Student Management but by default won't be used by automated processes.
• DeletableFlag: boolean
  Title: Deletable Indicator

  Read Only: true

  Indicates whether a customer account can be deleted using Student Management.
• Description: string
  Title: Description

  Description of the customer account.
• EstablishmentDate: string (date)
  Title: Establishment Date

  Read Only: true

  The date when a customer account is set up or becomes valid.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PaymentTermId: integer
  Title: Payment Term ID

  The unique identifier of the payment term assigned to the customer account. Payment terms are used to calculate transaction due dates.
• PaymentTermName: string
  Title: Payment Term Name

  Read Only: true

  Maximum Length: 255

  The name of the payment term assigned to the customer account. Payment terms are used to calculate transaction due dates.
• StatusCode: string
  Title: Status Code

  The code that represents the status of a Receivables customer account. Valid values are A for Active or I for Inactive.
• StatusMeaning: string
  Title: Status Meaning

  The meaning of the status code. Valid values are Active and Inactive.
• TerminationDate: string (date)
  Title: Termination Date

  The date when a customer account is no longer available for use.

{
    "type":"object",
    "properties":{
        "EstablishmentDate":{
            "title":"Establishment Date",
            "type":"string",
            "description":"The date when a customer account is set up or becomes valid.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentTermName":{
            "title":"Payment Term Name",
            "maxLength":255,
            "type":"string",
            "description":"The name of the payment term assigned to the customer account. Payment terms are used to calculate transaction due dates.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PaymentTermId":{
            "title":"Payment Term ID",
            "type":"integer",
            "description":"The unique identifier of the payment term assigned to the customer account. Payment terms are used to calculate transaction due dates.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountId":{
            "title":"Account ID",
            "type":"integer",
            "description":"The unique identifier for a Receivables customer account.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "type":"string",
            "description":"Description of the customer account.",
            "nullable":true,
            "x-queryable":true
        },
        "TerminationDate":{
            "title":"Termination Date",
            "type":"string",
            "description":"The date when a customer account is no longer available for use.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AccountTypeMeaning":{
            "title":"Account Type Meaning",
            "maxLength":255,
            "type":"string",
            "description":"Meaning of the customer account type code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerProfileClassId":{
            "title":"Customer Profile Class ID",
            "type":"integer",
            "description":"Code indicating the account's customer profile class. Customer profile classes organize customer accounts into categories that reflect the needs of the deploying company.",
            "nullable":true,
            "x-queryable":true
        },
        "DeletableFlag":{
            "title":"Deletable Indicator",
            "type":"boolean",
            "description":"Indicates whether a customer account can be deleted using Student Management.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status Code",
            "type":"string",
            "description":"The code that represents the status of a Receivables customer account. Valid values are A for Active or I for Inactive.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerProfileClassName":{
            "title":"Customer Profile Class Name",
            "maxLength":255,
            "type":"string",
            "description":"The name of the account's customer profile class. Customer profile classes organize customer accounts into categories that reflect the needs of the deploying company.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AccountNumber":{
            "title":"Account Number",
            "type":"string",
            "description":"The number that identifies a customer account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerClassCode":{
            "title":"Customer Class Code",
            "type":"string",
            "description":"The unique identifier of the customer class assigned to the customer account.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StatusMeaning":{
            "title":"Status Meaning",
            "type":"string",
            "description":"The meaning of the status code. Valid values are Active and Inactive.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountTypeCode":{
            "title":"Account Type Code",
            "type":"string",
            "description":"Code indicating the type of customer account.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CustomerClassMeaning":{
            "title":"Customer Class Meaning",
            "maxLength":255,
            "type":"string",
            "description":"The meaning of the customer class assigned to the 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"
            }
        },
        "DefaultFlag":{
            "title":"Default Indicator",
            "type":"boolean",
            "description":"Indicates whether a customer account is the default account for a person. If true, Student Management automated processes will use the account when creating transactions. When false, the account can be viewed in Student Management but by default won't be used by automated processes.",
            "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."
        }
    }
}

Nested Schema : hedCustomerAccounts-tagAssignments-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RequestAction: string
  Title: Request Action

  Maximum Length: 80

  Action to define if the object should be removed.
• TagAssignmentId: integer (int64)
  Title: Tag Assignment ID

  Read Only: true

  The unique identifier for the assignment of a tag to a financial account.
• TagCode: string
  Title: Tag Code

  Maximum Length: 30

  The code that identifies a tag assigned to a financial account.
• TagId: integer (int64)
  Title: Tag ID

  The unique identifier for the tag assigned to a financial account.
• TagName: string
  Title: Tag Name

  Read Only: true

  Maximum Length: 64

  The name of a tag assigned to a financial account.

{
    "type":"object",
    "properties":{
        "TagId":{
            "title":"Tag ID",
            "type":"integer",
            "description":"The unique identifier for the tag assigned to a financial account.",
            "format":"int64",
            "nullable":false,
            "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"
            }
        },
        "TagAssignmentId":{
            "title":"Tag Assignment ID",
            "type":"integer",
            "description":"The unique identifier for the assignment of a tag to a financial account.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "TagCode":{
            "title":"Tag Code",
            "maxLength":30,
            "type":"string",
            "description":"The code that identifies a tag assigned to a financial account.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "TagName":{
            "title":"Tag Name",
            "maxLength":64,
            "type":"string",
            "description":"The name of a tag assigned to a financial account.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestAction":{
            "title":"Request Action",
            "maxLength":80,
            "type":"string",
            "description":"Action to define if the object should be removed.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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"
    }
}

Back to Top