Jump to

• Request
• Response

Get all information about all faulted processes or alerted tasks along with their associated application data

get

/fscmRestApi/resources/11.13.18.05/publicSectorFaultedOpaProcessSearches

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 faulted processes or alerted tasks by the primary key criteria.
    Finder Variables:
    • FaultedTransId; integer; Unique identifier of the faulted process transaction.
  • simpleSearchFinder: Finds faulted processes or alerted tasks with a specified keyword.
    Finder Variables:
    • value; string; The keyword used to find faulted processes or alerted tasks.
• 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:
  

  • ActionDetail; string; Detailed information about why the task action was initiated.
  • AssignedBy; string; The name of the user who assigned this alerted task.
  • AssignedDate; string; The date on which the alerted task was assigned.
  • Assignee; string; The user name of the user to whom the alerted task has been currently assigned.
  • AssignmentType; string; Indicates the assignment type for the alerted task. This determines whether the alerted task belongs to the user or to his group. Valid values are ALL, MY, MY_ONLY or GROUP.
  • Classification; string; The classification of a faulted transaction.
  • CustomTaskStatus; string; Customized task status value after initiating the task action.
  • ErrorSummary; string; The error summary of a faulted transaction.
  • FaultedTransId; integer; Unique identifier of the faulted transaction.
  • OpaGenVersion; string; Indicates whether the alerted task belongs to Generation 2 or Generation 3.
  • PrimaryFlag; string; Indicates whether the record is a primary record.
  • PrimaryMeaning; string; Indicates whether a transaction is the primary application within a parent-child relationship of applications.
  • PrimaryRecordId; string; The primary record ID for a subrecord.
  • PrimaryRecordKey; integer; The primary record key for a subrecord.
  • ProcessDefId; string; The process definition unique identifier of a faulted transaction.
  • ProcessId; string; Unique process identifier of a faulted transaction.
  • ProcessState; string; The process state of a faulted transaction.
  • PropertyAddress1; string; The first line of property address for the associated application.
  • PropertyAddress2; string; The other lines of property address for the associated application.
  • PropertyCity; string; The city in the property address.
  • PropertyPostalCode; string; The postal code in the property address.
  • PropertyState; string; The state in the property address.
  • PropertyStreetNameConcat; string; The street direction, street name, street type and street suffix in the property address.
  • PropertyStreetNumber; string; The street number in the property address.
  • PropertyStreetNumberAlpha; string; The street number if it is in alphabetic form in the property address.
  • PropertyStreetNumberNumeric; number; The street number if it is in numeric form in the property address.
  • RecipientsUserId; string; The recipient's user ID of a faulted transaction.
  • RecordDesc; string; The record description for the associated application.
  • RecordId; string; The record identifier of a faulted transaction.
  • RecordKey; integer; The record key of a faulted transaction.
  • RecordStatus; string; The record status of a faulted transaction.
  • RecordType; string; The record type of a faulted transaction.
  • ResourceType; string; The resource type of a faulted transaction.
  • SubClassification; string; The subclassification of a faulted transaction.
  • SubapplicationFlag; string; Indicates whether the record is a subapplication.
  • SubapplicationMeaning; string; Indicates whether a transaction is the child application within a parent-child relationship of applications.
  • TaskCreatedDate; string; The date on which the alerted task was created.
  • TaskDueDate; string; The due date of the alerted task.
  • TaskId; string; Unique task identifier of an alerted task.
  • TaskName; string; The name for the alerted task.
  • TaskPriority; integer; The priority of the alerted task.
  • TaskStatus; string; The task status of an alerted task.
  • TaskUpdatedDate; string; The date on which the alerted task was updated.
  • WorklistTaskId; integer; Auto-generated value of the task in the Task Info table.
• 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:
  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 : publicSectorFaultedOpaProcessSearches

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/publicSectorFaultedOpaProcessSearches-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"SharedServices",
        "usage":"BusinessObject",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorFaultedOpaProcessSearches-item-response

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

Type: object

Show Source

• ActionDetail: string
  Read Only: true

  Maximum Length: 1000

  Detailed information about why the task action was initiated.
• AssignedBy: string
  Read Only: true

  Maximum Length: 100

  The name of the user who assigned this alerted task.
• AssignedDate: string (date-time)
  Read Only: true

  The date on which the alerted task was assigned.
• Assignee: string
  Read Only: true

  Maximum Length: 100

  The user name of the user to whom the alerted task has been currently assigned.
• AssignmentType: string
  Read Only: true

  Maximum Length: 10

  Indicates the assignment type for the alerted task. This determines whether the alerted task belongs to the user or to his group. Valid values are ALL, MY, MY_ONLY or GROUP.
• Classification: string
  Read Only: true

  Maximum Length: 10

  The classification of a faulted transaction.
• CustomTaskStatus: string
  Read Only: true

  Maximum Length: 400

  Customized task status value after initiating the task action.
• ErrorDetails: string (byte)
  Read Only: true

  The error details of a faulted transaction.
• ErrorSummary: string
  Read Only: true

  Maximum Length: 1000

  The error summary of a faulted transaction.
• FaultedTransId: integer (int64)
  Read Only: true

  Unique identifier of the faulted transaction.
• links: array Links
  Title: Links

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

  Maximum Length: 10

  Indicates whether the alerted task belongs to Generation 2 or Generation 3.
• PrimaryFlag: string
  Read Only: true

  Maximum Length: 1

  Indicates whether the record is a primary record.
• PrimaryMeaning: string
  Read Only: true

  Maximum Length: 80

  Indicates whether a transaction is the primary application within a parent-child relationship of applications.
• PrimaryRecordId: string
  Read Only: true

  Maximum Length: 100

  The primary record ID for a subrecord.
• PrimaryRecordKey: integer (int64)
  Read Only: true

  The primary record key for a subrecord.
• ProcessDefId: string
  Read Only: true

  Maximum Length: 100

  The process definition unique identifier of a faulted transaction.
• ProcessId: string
  Read Only: true

  Maximum Length: 100

  Unique process identifier of a faulted transaction.
• ProcessState: string
  Read Only: true

  Maximum Length: 100

  The process state of a faulted transaction.
• PropertyAddress1: string
  Read Only: true

  Maximum Length: 1000

  The first line of property address for the associated application.
• PropertyAddress2: string
  Read Only: true

  Maximum Length: 1000

  The other lines of property address for the associated application.
• PropertyCity: string
  Read Only: true

  Maximum Length: 100

  The city in the property address.
• PropertyPostalCode: string
  Read Only: true

  Maximum Length: 100

  The postal code in the property address.
• PropertyState: string
  Read Only: true

  Maximum Length: 100

  The state in the property address.
• PropertyStreetNameConcat: string
  Read Only: true

  Maximum Length: 500

  The street direction, street name, street type and street suffix in the property address.
• PropertyStreetNumber: string
  Read Only: true

  Maximum Length: 100

  The street number in the property address.
• PropertyStreetNumberAlpha: string
  Read Only: true

  Maximum Length: 100

  The street number if it is in alphabetic form in the property address.
• PropertyStreetNumberNumeric: number
  Read Only: true

  The street number if it is in numeric form in the property address.
• RecipientsUserId: string
  Read Only: true

  Maximum Length: 1000

  The recipient's user ID of a faulted transaction.
• RecordDesc: string
  Read Only: true

  Maximum Length: 1000

  The record description for the associated application.
• RecordId: string
  Read Only: true

  Maximum Length: 100

  The record identifier of a faulted transaction.
• RecordKey: integer (int64)
  Read Only: true

  The record key of a faulted transaction.
• RecordStatus: string
  Read Only: true

  Maximum Length: 100

  The record status of a faulted transaction.
• RecordType: string
  Read Only: true

  Maximum Length: 100

  The record type of a faulted transaction.
• ResourceType: string
  Read Only: true

  Maximum Length: 30

  The resource type of a faulted transaction.
• SubapplicationFlag: string
  Read Only: true

  Maximum Length: 1

  Indicates whether the record is a subapplication.
• SubapplicationMeaning: string
  Read Only: true

  Maximum Length: 80

  Indicates whether a transaction is the child application within a parent-child relationship of applications.
• SubClassification: string
  Read Only: true

  Maximum Length: 100

  The subclassification of a faulted transaction.
• TaskCreatedDate: string (date-time)
  Read Only: true

  The date on which the alerted task was created.
• TaskDueDate: string (date-time)
  Read Only: true

  The due date of the alerted task.
• TaskId: string
  Read Only: true

  Maximum Length: 100

  Unique task identifier of an alerted task.
• TaskName: string
  Read Only: true

  Maximum Length: 400

  The name for the alerted task.
• TaskPriority: integer (int32)
  Read Only: true

  The priority of the alerted task.
• TaskStatus: string
  Read Only: true

  Maximum Length: 100

  The task status of an alerted task.
• TaskUpdatedDate: string (date-time)
  Read Only: true

  The date on which the alerted task was updated.
• WorklistTaskId: integer (int64)
  Read Only: true

  Auto-generated value of the task in the Task Info table.

{
    "type":"object",
    "properties":{
        "ErrorSummary":{
            "maxLength":"1000",
            "type":"string",
            "description":"The error summary of a faulted transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskCreatedDate":{
            "type":"string",
            "description":"The date on which the alerted task was created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskId":{
            "maxLength":"100",
            "type":"string",
            "description":"Unique task identifier of an alerted task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the record is a primary record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordKey":{
            "type":"integer",
            "description":"The record key of a faulted transaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ActionDetail":{
            "maxLength":"1000",
            "type":"string",
            "description":"Detailed information about why the task action was initiated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskPriority":{
            "type":"integer",
            "description":"The priority of the alerted task.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "PropertyStreetNumber":{
            "maxLength":"100",
            "type":"string",
            "description":"The street number in the property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ErrorDetails":{
            "type":"string",
            "description":"The error details of a faulted transaction.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PropertyStreetNumberNumeric":{
            "type":"number",
            "description":"The street number if it is in numeric form in the property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FaultedTransId":{
            "type":"integer",
            "description":"Unique identifier of the faulted transaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RecordType":{
            "maxLength":"100",
            "type":"string",
            "description":"The record type of a faulted transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubapplicationFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the record is a subapplication.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyStreetNameConcat":{
            "maxLength":"500",
            "type":"string",
            "description":"The street direction, street name, street type and street suffix in the property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OpaGenVersion":{
            "maxLength":"10",
            "type":"string",
            "description":"Indicates whether the alerted task belongs to Generation 2 or Generation 3.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedDate":{
            "type":"string",
            "description":"The date on which the alerted task was assigned.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Classification":{
            "maxLength":"10",
            "type":"string",
            "description":"The classification of a faulted transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryRecordKey":{
            "type":"integer",
            "description":"The primary record key for a subrecord.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PropertyAddress2":{
            "maxLength":"1000",
            "type":"string",
            "description":"The other lines of property address for the associated application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyAddress1":{
            "maxLength":"1000",
            "type":"string",
            "description":"The first line of property address for the associated application.",
            "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"
            }
        },
        "RecordId":{
            "maxLength":"100",
            "type":"string",
            "description":"The record identifier of a faulted transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedBy":{
            "maxLength":"100",
            "type":"string",
            "description":"The name of the user who assigned this alerted task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordStatus":{
            "maxLength":"100",
            "type":"string",
            "description":"The record status of a faulted transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Assignee":{
            "maxLength":"100",
            "type":"string",
            "description":"The user name of the user to whom the alerted task has been currently assigned.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorklistTaskId":{
            "type":"integer",
            "description":"Auto-generated value of the task in the Task Info table.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TaskDueDate":{
            "type":"string",
            "description":"The due date of the alerted task.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessDefId":{
            "maxLength":"100",
            "type":"string",
            "description":"The process definition unique identifier of a faulted transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceType":{
            "maxLength":"30",
            "type":"string",
            "description":"The resource type of a faulted transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubClassification":{
            "maxLength":"100",
            "type":"string",
            "description":"The subclassification of a faulted transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubapplicationMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether a transaction is the child application within a parent-child relationship of applications.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskStatus":{
            "maxLength":"100",
            "type":"string",
            "description":"The task status of an alerted task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryRecordId":{
            "maxLength":"100",
            "type":"string",
            "description":"The primary record ID for a subrecord.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyState":{
            "maxLength":"100",
            "type":"string",
            "description":"The state in the property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessState":{
            "maxLength":"100",
            "type":"string",
            "description":"The process state of a faulted transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskUpdatedDate":{
            "type":"string",
            "description":"The date on which the alerted task was updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskName":{
            "maxLength":"400",
            "type":"string",
            "description":"The name for the alerted task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyStreetNumberAlpha":{
            "maxLength":"100",
            "type":"string",
            "description":"The street number if it is in alphabetic form in the property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyPostalCode":{
            "maxLength":"100",
            "type":"string",
            "description":"The postal code in the property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignmentType":{
            "maxLength":"10",
            "type":"string",
            "description":"Indicates the assignment type for the alerted task. This determines whether the alerted task belongs to the user or to his group. Valid values are ALL, MY, MY_ONLY or GROUP.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecipientsUserId":{
            "maxLength":"1000",
            "type":"string",
            "description":"The recipient's user ID of a faulted transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordDesc":{
            "maxLength":"1000",
            "type":"string",
            "description":"The record description for the associated application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessId":{
            "maxLength":"100",
            "type":"string",
            "description":"Unique process identifier of a faulted transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyCity":{
            "maxLength":"100",
            "type":"string",
            "description":"The city in the property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether a transaction is the primary application within a parent-child relationship of applications.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomTaskStatus":{
            "maxLength":"400",
            "type":"string",
            "description":"Customized task status value after initiating the task action.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top