REST API for Oracle Loyalty Cloud

Get all relationships

get

/crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Relationship

Request

Path Parameters

PartyNumber(required): string

The unique primary identifier for the household party. The profile option HZ_GENERATE_PARTY_NUMBER controls whether the attribute value can be system generated or user-provided during create. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Profile Options task. Inactive records can't be updated.

Query Parameters

dependency: string

This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

Format: <attr1>=<val1>,<attr2>=<value2>
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 a relationship with the specified primary key.
  Finder Variables:
  - RelationshipRecId; integer; The unique identifier of the relationship.
- Relationship2AltKey: Finds a relationship with the specified parameters.
  Finder Variables:
  - ObjectPartyId; integer; The identifier of the object in this relationship.
  - RelationshipCode; string; Indicates whether this is a forward or a backward relationship code.
  - RelationshipType; string; The relationship type name.
  - SubjectPartyNumber; string; The unique identification number for the subject party of the relationship.
- Relationship3AltKey: Finds a relationship with the specified parameters.
  Finder Variables:
  - ObjectPartyId; integer; The identifier of the object in this relationship.
  - RelationshipCode; string; Indicates whether this is a forward or a backward relationship code.
  - RelationshipType; string; The relationship type name.
  - SubjectSourceSystem; string; The name of external source system for the subject party in the relationship.
  - SubjectSourceSystemReferenceValue; string; The identifier for the subject party in the relationship from external source system.
- Relationship4AltKey: Finds a relationship with the specified parameters.
  Finder Variables:
  - ObjectPartyNumber; string; The unique identification number for the object party of the relationship.
  - RelationshipCode; string; Indicates whether this is a forward or a backward relationship code.
  - RelationshipType; string; The relationship type name.
  - SubjectPartyId; integer; The identifier for a subject in the relationship.
- Relationship5AltKey: Finds a relationship with specified parameters.
  Finder Variables:
  - ObjectPartyNumber; string; The unique identification number for the object party of the relationship.
  - RelationshipCode; string; Indicates whether this is a forward or a backward relationship code.
  - RelationshipType; string; The relationship type name.
  - SubjectPartyNumber; string; The unique identification number for the subject party of the relationship.
- Relationship6AltKey: Finds a relationship with the specified parameters.
  Finder Variables:
  - ObjectPartyNumber; string; The unique identification number for the object party of the relationship.
  - RelationshipCode; string; Indicates whether this is a forward or a backward relationship code.
  - RelationshipType; string; The relationship type name.
  - SubjectSourceSystem; string; The name of external source system for the subject party in the relationship.
  - SubjectSourceSystemReferenceValue; string; The identifier for the subject party in the relationship from external source system.
- Relationship7AltKey: Finds a relationship with the specified parameters.
  Finder Variables:
  - ObjectSourceSystem; string; The name of external source system for the object party in the relationship.
  - ObjectSourceSystemReferenceValue; string; The identifier for the object party in the relationship from external source system.
  - RelationshipCode; string; Indicates whether this is a forward or a backward relationship code.
  - RelationshipType; string; The relationship type name.
  - SubjectPartyId; integer; The identifier for a subject in the relationship.
- Relationship8AltKey: Finds a relationship with the specified parameters.
  Finder Variables:
  - ObjectSourceSystem; string; The name of external source system for the object party in the relationship.
  - ObjectSourceSystemReferenceValue; string; The identifier for the object party in the relationship from external source system.
  - RelationshipCode; string; Indicates whether this is a forward or a backward relationship code.
  - RelationshipType; string; The relationship type name.
  - SubjectPartyNumber; string; The unique identification number for the subject party of the relationship.
- Relationship9AltKey: Finds a relationship with the specified parameters.
  Finder Variables:
  - ObjectSourceSystem; string; The name of external source system for the object party in the relationship.
  - ObjectSourceSystemReferenceValue; string; The identifier for the object party in the relationship from external source system.
  - RelationshipCode; string; Indicates whether this is a forward or a backward relationship code.
  - RelationshipType; string; The relationship type name.
  - SubjectSourceSystem; string; The name of external source system for the subject party in the relationship.
  - SubjectSourceSystemReferenceValue; string; The identifier for the subject party in the relationship from external source system.
- RelationshipAltKey: Finds a relationship with the specified parameters.
  Finder Variables:
  - ObjectPartyId; integer; The identifier of the object in this relationship.
  - RelationshipCode; string; Indicates whether this is a forward or a backward relationship code.
  - RelationshipType; string; The relationship type name.
  - SubjectPartyId; integer; The identifier for a subject in the relationship.
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:
- Comments; string; The comments provided by the user.
- ConflictId; integer; The unique identifier of the conflict for the relationship record. This number is used by mobile or portable applications that consume the web service.
- CreatedBy; string; The user who created the record.
- CreatedByModule; string; The application module that created the relationship record. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups.
- CreationDate; string; The date and time when the record was created.
- DependentFlag; string; Indicates whether one party is dependent on another. Default value is N.
- DirectionCode; string; The code of the relationship direction. The list of accepted values are defined in the lookup DIRECTION_CODE. Valid values are P-Parent, C-Child, N-Not Directional.
- EndDate; string; The date when the relationship ends.
- HeadOfHouseholdFlag; string; Indicates whether a person is the head of the household that he belongs to. It's applicable only in the MEMBERSHIP relationship, and will be used to indicate which members are the head of household. There may be multiple heads of households, depending on the deploying company's implementation.
- InfluenceLevel; string; The sales contact's influence in a buying relationship. Sample values are Inner Circle, Political structure, None.
- JobDefinitionName; string; The definition of the job name.
- JobDefinitionPackage; string; The definition of the job package.
- LastUpdateDate; string; The date and time when the record was last updated.
- LastUpdateLogin; string; The login details of the user who last updated the record.
- LastUpdatedBy; string; The user who last updated the record.
- ObjectPartyId; integer; The unique identifier of the object in this relationship.
- ObjectPartyName; string; The name of the object party.
- ObjectPartyNumber; string; The alternate key identifier of the object party of the relationship.
- ObjectSourceSystem; string; The name of external source system for the object party in the relationship, which are defined by an admin as part of system setup.
- ObjectSourceSystemReferenceValue; string; The unique identifier for the object party in the relationship from external source system.
- ObjectTableName; string; The source table name of the object party in this relationship.
- ObjectType; string; The object type of the relationship like ORGANIZATION, PERSON.
- ObjectUsageCode; string; The usage code of object party in the relationship.
- ObjectVersionNumber; integer; The number used to implement optimistic locking for relationship record. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
- ObjectVersionNumber1; integer; The alternate number used to implement optimistic locking for relationship record.
- ObjectVersionNumber2; integer; The alternate number to implement optimistic locking for relationship record.
- PartyId; integer; The alternate unique identifier of the associated party record.
- PartyId1; integer; The alternate identifier of the associated party record.
- PercentageOwnership; number; The percentage of the child entity owned by the parent entity.
- RelationshipCode; string; The code indicating whether this is a forward or a backward relationship code.
- RelationshipId; integer; The unique identifier of the relationship.
- RelationshipRecId; integer; The unique identifier of the relationship record.
- RelationshipType; string; The name of the type of the relationship. For example, CUSTOMER_SUPPLIER.
- RequestId; integer; The unique identifier of the request on relationship record.
- SSROwnerTableName; string; The name of the table that holds the record data and is referenced to manage source system reference.
- StartDate; string; The date when the relationship begins.
- Status; string; The status of the relationship, A for active, I for inactive.
- SubjectPartyId; integer; The unique identifier of the subject in this relationship.
- SubjectPartyName; string; The name of the subject party.
- SubjectPartyNumber; string; The alternate key identifier of the subject party of the relationship.
- SubjectSourceSystem; string; The name of external source system for the subject party in the relationship, which are defined by an admin as part of system setup.
- SubjectSourceSystemReferenceValue; string; The unique identifier of the subject party in the relationship from external source system.
- SubjectTableName; string; The source table name of the subject party in this relationship.
- SubjectType; string; The subject type of the relationship like ORGANIZATION, PERSON.
- SubjectUsageCode; string; The usage code of subject party in the relationship.
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.

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.

Root Schema : households-Relationship

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/households-Relationship-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

Array of: object households-Relationship-item-response

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

Type: object

Show Source

BackwardRole: string

Title: Backward Role

The backward relationship code used to describe relationships. For example, SUPPLIER_OF.
BackwardRoleDescription: string

Title: Backward Role Description

Read Only: true

Maximum Length: 255

Indicates the description of the backward relationship role.
Comments: string

Title: Comments

Maximum Length: 2000

The comments provided by the user.
ConflictId: integer (int64)

Default Value: 0

The unique identifier of the conflict for the relationship record. This number is used by mobile or portable applications that consume the web service.
CreatedBy: string

Title: Created By

Read Only: true

Maximum Length: 64

The user who created the record.
CreatedByModule: string

Title: Created by Application

Maximum Length: 30

Default Value: HZ_WS

The application module that created the relationship record. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups.
CreationDate: string (date-time)

Title: Creation Date

Read Only: true

The date and time when the record was created.
DependentFlag: string

Title: Dependent Indicator

Maximum Length: 1

Default Value: N

Indicates whether one party is dependent on another. Default value is N.
DirectionCode: string

Read Only: true

Maximum Length: 30

The code of the relationship direction. The list of accepted values are defined in the lookup DIRECTION_CODE. Valid values are P-Parent, C-Child, N-Not Directional.
EndDate: string (date)

Title: To Date

The date when the relationship ends.
HeadOfHouseholdFlag: string

Title: Head of Household Indicator

Maximum Length: 1

Default Value: N

Indicates whether a person is the head of the household that he belongs to. It's applicable only in the MEMBERSHIP relationship, and will be used to indicate which members are the head of household. There may be multiple heads of households, depending on the deploying company's implementation.
InfluenceLevel: string

Title: Influence Level

The sales contact's influence in a buying relationship. Sample values are Inner Circle, Political structure, None.
IsObjectSalesPartyFlag: boolean

Title: Is Object Sales Party

Read Only: true

Indicates whether the object party is sales party or not.
IsSubjectSalesPartyFlag: boolean

Title: Is Subject Sales Party

Read Only: true

Indicates whether the subject party is sales party or not.
JobDefinitionName: string

Maximum Length: 100

The definition of the job name.
JobDefinitionPackage: string

Maximum Length: 900

The definition of the job package.
LastUpdateDate: string (date-time)

Title: Last Updated Date

Read Only: true

The date and time when the record was last updated.
LastUpdatedBy: string

Title: Last Updated By

Read Only: true

Maximum Length: 64

The user who last updated the record.
LastUpdateLogin: string

Title: Last Update Login

Read Only: true

Maximum Length: 32

The login details of the user who last updated the record.
links: array Links

Title: Links

The link relations associated with the resource instance.
ObjectPartyId: integer (int64)

The unique identifier of the object in this relationship.
ObjectPartyName: string

Title: Object Party Name

Read Only: true

Maximum Length: 360

The name of the object party.
ObjectPartyNumber: string

Title: Object Registry ID

Maximum Length: 30

The alternate key identifier of the object party of the relationship.
ObjectSourceSystem: string

Title: Object Source System

The name of external source system for the object party in the relationship, which are defined by an admin as part of system setup.
ObjectSourceSystemReferenceValue: string

Title: Object Source System Reference

The unique identifier for the object party in the relationship from external source system.
ObjectTableName: string

Maximum Length: 30

The source table name of the object party in this relationship.
ObjectType: string

Maximum Length: 30

The object type of the relationship like ORGANIZATION, PERSON.
ObjectUsageCode: string

Maximum Length: 30

The usage code of object party in the relationship.
ObjectVersionNumber: integer (int32)

The number used to implement optimistic locking for relationship record. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
ObjectVersionNumber1: integer (int32)

Read Only: true

The alternate number used to implement optimistic locking for relationship record.
ObjectVersionNumber2: integer (int32)

Read Only: true

The alternate number to implement optimistic locking for relationship record.
PartyId: integer (int64)

Read Only: true

The alternate unique identifier of the associated party record.
PartyId1: integer (int64)

Read Only: true

The alternate identifier of the associated party record.
PercentageOwnership: number

Title: Ownership Percentage

The percentage of the child entity owned by the parent entity.
PreferredContactFlag: boolean

Maximum Length: 10

Default Value: false

Indicates whether this contact person is primary contact for the customer. Accepted values are Y and N. Default value is N.
PrimaryCustomerFlag: boolean

Maximum Length: 10

Default Value: false

Indicates whether this customer is primary customer for the contact. Accepted values are Y and N. Default value is N.
RelationshipCode: string

Title: Relationship Code

Maximum Length: 30

The code indicating whether this is a forward or a backward relationship code.
RelationshipGroup: string

Title: Relationship Group

Maximum Length: 255

Used for filtering the Role and Backward Role drop down values with relationship types that are part of provided relationship group.
RelationshipId: integer (int64)

Read Only: true

The unique identifier of the relationship.
RelationshipRecId: integer (int64)

The unique identifier of the relationship record.
RelationshipSourceSystem: string

The name of the external source system for the relationship, which are defined by an admin as part of the system setup.
RelationshipSourceSystemReferenceValue: string

The unique identifier of the relationship from external source system.
RelationshipType: string

Title: Relationship Type

Maximum Length: 30

The name of the type of the relationship. For example, CUSTOMER_SUPPLIER.
RequestId: integer (int64)

The unique identifier of the request on relationship record.
Role: string

Title: Role

The role between the subject and object party.
RoleDescription: string

Title: Role Description

Read Only: true

Maximum Length: 255

Description of the relationship role.
smartActions: array Smart Actions

Title: Smart Actions

This VO stores the endpoint and security details for every user action.
SSROwnerTableName: string

Read Only: true

Maximum Length: 255

Default Value: HZ_PARTIES

The name of the table that holds the record data and is referenced to manage source system reference.
StartDate: string (date)

Title: From Date

The date when the relationship begins.
Status: string

Read Only: true

Maximum Length: 1

Default Value: A

The status of the relationship, A for active, I for inactive.
SubjectPartyId: integer (int64)

The unique identifier of the subject in this relationship.
SubjectPartyName: string

Title: Subject Party Name

Read Only: true

Maximum Length: 360

The name of the subject party.
SubjectPartyNumber: string

Title: Subject Registry ID

Maximum Length: 30

The alternate key identifier of the subject party of the relationship.
SubjectSourceSystem: string

Title: Subject Source System

The name of external source system for the subject party in the relationship, which are defined by an admin as part of system setup.
SubjectSourceSystemReferenceValue: string

Title: Subject Source System Reference

The unique identifier of the subject party in the relationship from external source system.
SubjectTableName: string

Maximum Length: 30

The source table name of the subject party in this relationship.
SubjectType: string

Maximum Length: 30

The subject type of the relationship like ORGANIZATION, PERSON.
SubjectUsageCode: string

Maximum Length: 30

The usage code of subject party in the relationship.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubjectPartyNumber":{
            "title":"Subject Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the subject party of the relationship.",
            "nullable":false,
            "x-queryable":true
        },
        "RelationshipType":{
            "title":"Relationship Type",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the type of the relationship. For example, CUSTOMER_SUPPLIER.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"The unique identifier of the conflict for the relationship record. This number is used by mobile or portable applications that consume the web service.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "smartActions":{
            "title":"Smart Actions",
            "type":"array",
            "description":"This VO stores the endpoint and security details for every user action.",
            "items":{
                "$ref":"#/components/schemas/households-Relationship-smartActions-item-response"
            }
        },
        "StartDate":{
            "title":"From Date",
            "type":"string",
            "description":"The date when the relationship begins.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "SubjectType":{
            "maxLength":"30",
            "type":"string",
            "description":"The subject type of the relationship like ORGANIZATION, PERSON.",
            "nullable":false,
            "x-queryable":true
        },
        "SubjectSourceSystem":{
            "title":"Subject Source System",
            "type":"string",
            "description":"The name of external source system for the subject party in the relationship, which are defined by an admin as part of system setup.",
            "nullable":true,
            "x-queryable":true
        },
        "PreferredContactFlag":{
            "maxLength":"10",
            "type":"boolean",
            "description":"Indicates whether this contact person is primary contact for the customer. Accepted values are Y and N. Default value is N.",
            "nullable":true,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PreferredContactPersonId"
                ]
            }
        },
        "BackwardRole":{
            "title":"Backward Role",
            "type":"string",
            "description":"The backward relationship code used to describe relationships. For example, SUPPLIER_OF.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "IsSubjectSalesPartyFlag":{
            "title":"Is Subject Sales Party",
            "type":"boolean",
            "description":"Indicates whether the subject party is sales party or not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "SubjectSalesAccountId"
                ]
            }
        },
        "SubjectPartyId":{
            "type":"integer",
            "description":"The unique identifier of the subject in this relationship.",
            "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"
            }
        },
        "SubjectUsageCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The usage code of subject party in the relationship.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedByModule":{
            "title":"Created by Application",
            "maxLength":"30",
            "type":"string",
            "description":"The application module that created the relationship record. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups.",
            "nullable":true,
            "default":"HZ_WS",
            "x-queryable":true
        },
        "Status":{
            "maxLength":"1",
            "type":"string",
            "description":"The status of the relationship, A for active, I for inactive.",
            "nullable":false,
            "readOnly":true,
            "default":"A",
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PercentageOwnership":{
            "title":"Ownership Percentage",
            "type":"number",
            "description":"The percentage of the child entity owned by the parent entity.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestId":{
            "type":"integer",
            "description":"The unique identifier of the request on relationship record.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RelationshipRecId":{
            "type":"integer",
            "description":"The unique identifier of the relationship record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SubjectSourceSystemReferenceValue":{
            "title":"Subject Source System Reference",
            "type":"string",
            "description":"The unique identifier of the subject party in the relationship from external source system.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryCustomerFlag":{
            "maxLength":"10",
            "type":"boolean",
            "description":"Indicates whether this customer is primary customer for the contact. Accepted values are Y and N. Default value is N.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "ObjectVersionNumber2":{
            "type":"integer",
            "description":"The alternate number to implement optimistic locking for relationship record.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "Role":{
            "title":"Role",
            "type":"string",
            "description":"The role between the subject and object party.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RelationshipSourceSystem":{
            "type":"string",
            "description":"The name of the external source system for the relationship, which are defined by an admin as part of the system setup.",
            "nullable":true,
            "x-queryable":false
        },
        "ObjectVersionNumber1":{
            "type":"integer",
            "description":"The alternate number used to implement optimistic locking for relationship record.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "HeadOfHouseholdFlag":{
            "title":"Head of Household Indicator",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether a person is the head of the household that he belongs to. It's applicable only in the MEMBERSHIP relationship, and will be used to indicate which members are the head of household. There may be multiple heads of households, depending on the deploying company's implementation.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "SSROwnerTableName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the table that holds the record data and is referenced to manage source system reference.",
            "nullable":true,
            "readOnly":true,
            "default":"HZ_PARTIES",
            "x-queryable":true
        },
        "ObjectUsageCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The usage code of object party in the relationship.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectSourceSystemReferenceValue":{
            "title":"Object Source System Reference",
            "type":"string",
            "description":"The unique identifier for the object party in the relationship from external source system.",
            "nullable":true,
            "x-queryable":true
        },
        "IsObjectSalesPartyFlag":{
            "title":"Is Object Sales Party",
            "type":"boolean",
            "description":"Indicates whether the object party is sales party or not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ObjectSalesAccountId"
                ]
            }
        },
        "SubjectTableName":{
            "maxLength":"30",
            "type":"string",
            "description":"The source table name of the subject party in this relationship.",
            "nullable":false,
            "x-queryable":true
        },
        "DependentFlag":{
            "title":"Dependent Indicator",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether one party is dependent on another. Default value is N.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login details of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "JobDefinitionName":{
            "maxLength":"100",
            "type":"string",
            "description":"The definition of the job name.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectTableName":{
            "maxLength":"30",
            "type":"string",
            "description":"The source table name of the object party in this relationship.",
            "nullable":false,
            "x-queryable":true
        },
        "InfluenceLevel":{
            "title":"Influence Level",
            "type":"string",
            "description":"The sales contact's influence in a buying relationship. Sample values are Inner Circle, Political structure, None.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ObjectType":{
            "maxLength":"30",
            "type":"string",
            "description":"The object type of the relationship like ORGANIZATION, PERSON.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectPartyId":{
            "type":"integer",
            "description":"The unique identifier of the object in this relationship.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "JobDefinitionPackage":{
            "maxLength":"900",
            "type":"string",
            "description":"The definition of the job package.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectPartyNumber":{
            "title":"Object Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the object party of the relationship.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectPartyName":{
            "title":"Object Party Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the object party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The number used to implement optimistic locking for relationship record. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "RelationshipCode":{
            "title":"Relationship Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating whether this is a forward or a backward relationship code.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SubjectPartyName":{
            "title":"Subject Party Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the subject party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationshipGroup":{
            "title":"Relationship Group",
            "maxLength":"255",
            "type":"string",
            "description":"Used for filtering the Role and Backward Role drop down values with relationship types that are part of provided relationship group.",
            "nullable":true,
            "x-queryable":false
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"The comments provided by the user.",
            "nullable":true,
            "x-queryable":true
        },
        "RoleDescription":{
            "title":"Role Description",
            "maxLength":"255",
            "type":"string",
            "description":"Description of the relationship role.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "RoleInfo"
                ]
            }
        },
        "BackwardRoleDescription":{
            "title":"Backward Role Description",
            "maxLength":"255",
            "type":"string",
            "description":"Indicates the description of the backward relationship role.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "BackwardRoleInfo"
                ]
            }
        },
        "RelationshipSourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier of the relationship from external source system.",
            "nullable":true,
            "x-queryable":false
        },
        "DirectionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The code of the relationship direction. The list of accepted values are defined in the lookup DIRECTION_CODE. Valid values are P-Parent, C-Child, N-Not Directional.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId1":{
            "type":"integer",
            "description":"The alternate identifier of the associated party record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"To Date",
            "type":"string",
            "description":"The date when the relationship ends.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The alternate unique identifier of the associated party record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ObjectSourceSystem":{
            "title":"Object Source System",
            "type":"string",
            "description":"The name of external source system for the object party in the relationship, which are defined by an admin as part of system setup.",
            "nullable":true,
            "x-queryable":true
        },
        "RelationshipId":{
            "type":"integer",
            "description":"The unique identifier of the relationship.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "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 : Smart Actions

Type: array

Title: Smart Actions

This VO stores the endpoint and security details for every user action.

Show Source

Array of: object households-Relationship-smartActions-item-response

{
    "title":"Smart Actions",
    "type":"array",
    "description":"This VO stores the endpoint and security details for every user action.",
    "items":{
        "$ref":"#/components/schemas/households-Relationship-smartActions-item-response"
    }
}

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 : households-Relationship-smartActions-item-response

Type: object

Show Source

ActionIntent: string (byte)

Title: Action Intent

JSON object that describes what an action does and what context data can be passed to the action.
ConfirmationMessage: string

Title: Confirmation Message

Maximum Length: 4000

A message to seek confirmation for the action being performed.
ContentType: string

Title: Content Type

Maximum Length: 50

The content type to use when invoking the REST endpoint.
DisplayLabel: string

Title: Action Name

Maximum Length: 256

Consumer-friendly action name.
Entity: string

Title: Parent Entity

Maximum Length: 150

REST Resources the action belongs to.
Href: string

Title: REST Endpoint

Maximum Length: 1024

The REST endpoint to perform the action.
IncludedInApplication: string

Title: Included in Application

Maximum Length: 512

List of applications that this action can be used in.
links: array Links

Title: Links

The link relations associated with the resource instance.
MassActionFlag: boolean

Title: Mass Action

Maximum Length: 1

Boolean type indicating if this action can be mass processed.
Method: string

Title: HTTP Method

Maximum Length: 15

HTTP method to use with HREF.
ObjectFunctionName: string

Title: Object Function

Maximum Length: 64

The object function associated with the smart action.
PageType: string

Title: Page Type

Maximum Length: 256

The list of pages that this action can be used in.
SmartSuggestFlag: boolean

Title: Smart Suggest

Maximum Length: 1

Indicates if smart suggest is enabled for the action.
SystemActionFlag: boolean

Title: System Action

Maximum Length: 1

Boolean type indicating if the action is seeded or custom.
UpdateOfAttributes: string

Title: Attributes to Update

Maximum Length: 512

Attributes to be updated when the Actions UI is launched.
UserActionId: integer (int64)

Title: User Action ID

Uniquely identifies the action. For internal use.
UserActionName: string

Title: Action Name

Maximum Length: 256

Uniquely identifies the action with a name. For internal use.
UserActionNavigation: array Smart Action User Interface Definitions

Title: Smart Action User Interface Definitions

UI navigation metadata striped by app usage.
UserActionRank: integer (int64)

Title: Priority

Number to indicate priority of the action.
UserActionRequestPayload: array Smart Action REST Payload Definitions

Title: Smart Action REST Payload Definitions

If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
UserActionURLBinding: array Smart Action User Interface Definitions

Title: Smart Action User Interface Definitions

Binding metadata for a variable in the URL.

{
    "type":"object",
    "properties":{
        "SmartSuggestFlag":{
            "title":"Smart Suggest",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if smart suggest is enabled for the action.",
            "nullable":true,
            "x-queryable":true
        },
        "Entity":{
            "title":"Parent Entity",
            "maxLength":"150",
            "type":"string",
            "description":"REST Resources the action belongs to.",
            "nullable":true,
            "x-queryable":true
        },
        "ContentType":{
            "title":"Content Type",
            "maxLength":"50",
            "type":"string",
            "description":"The content type to use when invoking the REST endpoint.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionURLBinding":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"Binding metadata for a variable in the URL.",
            "items":{
                "$ref":"#/components/schemas/households-Relationship-smartActions-UserActionURLBinding-item-response"
            }
        },
        "MassActionFlag":{
            "title":"Mass Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean type indicating if this action can be mass processed.",
            "nullable":true,
            "x-queryable":true
        },
        "IncludedInApplication":{
            "title":"Included in Application",
            "maxLength":"512",
            "type":"string",
            "description":"List of applications that this action can be used in.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionNavigation":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"UI navigation metadata striped by app usage.",
            "items":{
                "$ref":"#/components/schemas/households-Relationship-smartActions-UserActionNavigation-item-response"
            }
        },
        "Href":{
            "title":"REST Endpoint",
            "maxLength":"1024",
            "type":"string",
            "description":"The REST endpoint to perform the action.",
            "nullable":true,
            "x-queryable":true
        },
        "Method":{
            "title":"HTTP Method",
            "maxLength":"15",
            "type":"string",
            "description":"HTTP method to use with HREF.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayLabel":{
            "title":"Action Name",
            "maxLength":"256",
            "type":"string",
            "description":"Consumer-friendly action name.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionName":{
            "title":"Action Name",
            "maxLength":"256",
            "type":"string",
            "description":"Uniquely identifies the action with a name. For internal use.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionId":{
            "title":"User Action ID",
            "type":"integer",
            "description":"Uniquely identifies the action. For internal use.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UserActionRank":{
            "title":"Priority",
            "type":"integer",
            "description":"Number to indicate priority of the action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10"
            },
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean type indicating if the action is seeded or custom.",
            "nullable":true,
            "x-queryable":true
        },
        "ConfirmationMessage":{
            "title":"Confirmation Message",
            "maxLength":"4000",
            "type":"string",
            "description":"A message to seek confirmation for the action being performed.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionRequestPayload":{
            "title":"Smart Action REST Payload Definitions",
            "type":"array",
            "description":"If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.",
            "items":{
                "$ref":"#/components/schemas/households-Relationship-smartActions-UserActionRequestPayload-item-response"
            }
        },
        "UpdateOfAttributes":{
            "title":"Attributes to Update",
            "maxLength":"512",
            "type":"string",
            "description":"Attributes to be updated when the Actions UI is launched.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionIntent":{
            "title":"Action Intent",
            "type":"string",
            "description":"JSON object that describes what an action does and what context data can be passed to the action.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ObjectFunctionName":{
            "title":"Object Function",
            "maxLength":"64",
            "type":"string",
            "description":"The object function associated with the smart action.",
            "nullable":true,
            "x-queryable":true
        },
        "PageType":{
            "title":"Page Type",
            "maxLength":"256",
            "type":"string",
            "description":"The list of pages that this action can be used in.",
            "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 : Smart Action User Interface Definitions

Type: array

Title: Smart Action User Interface Definitions

UI navigation metadata striped by app usage.

Show Source

Array of: object households-Relationship-smartActions-UserActionNavigation-item-response

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"UI navigation metadata striped by app usage.",
    "items":{
        "$ref":"#/components/schemas/households-Relationship-smartActions-UserActionNavigation-item-response"
    }
}

Nested Schema : Smart Action REST Payload Definitions

Type: array

Title: Smart Action REST Payload Definitions

If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.

Show Source

Array of: object households-Relationship-smartActions-UserActionRequestPayload-item-response

{
    "title":"Smart Action REST Payload Definitions",
    "type":"array",
    "description":"If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.",
    "items":{
        "$ref":"#/components/schemas/households-Relationship-smartActions-UserActionRequestPayload-item-response"
    }
}

Nested Schema : Smart Action User Interface Definitions

Type: array

Title: Smart Action User Interface Definitions

Binding metadata for a variable in the URL.

Show Source

Array of: object households-Relationship-smartActions-UserActionURLBinding-item-response

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"Binding metadata for a variable in the URL.",
    "items":{
        "$ref":"#/components/schemas/households-Relationship-smartActions-UserActionURLBinding-item-response"
    }
}

Nested Schema : households-Relationship-smartActions-UserActionNavigation-item-response

Type: object

Show Source

links: array Links

Title: Links

The link relations associated with the resource instance.
SystemActionFlag: boolean

Title: System Action

Maximum Length: 1

Default Value: false

Boolean value indicating if the action is seeded or custom.
UserActionNavAppUsage: string

Title: Application Usage

Maximum Length: 50

Application usage.
UserActionNavBody: string

Title: Navigation Metadata

Maximum Length: 1000

Metadata of the navigation as needed for the specific usage.
UserActionNavId: integer (int64)

Title: Primary Key

Primary key for the user action navigation.
UserActionNavType: string

Title: Navigation Type

Maximum Length: 100

Provision for having multiple navigation flows for a given usage.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean value indicating if the action is seeded or custom.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "UserActionNavId":{
            "title":"Primary Key",
            "type":"integer",
            "description":"Primary key for the user action navigation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UserActionNavType":{
            "title":"Navigation Type",
            "maxLength":"100",
            "type":"string",
            "description":"Provision for having multiple navigation flows for a given usage.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionNavBody":{
            "title":"Navigation Metadata",
            "maxLength":"1000",
            "type":"string",
            "description":"Metadata of the navigation as needed for the specific usage.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionNavAppUsage":{
            "title":"Application Usage",
            "maxLength":"50",
            "type":"string",
            "description":"Application usage.",
            "nullable":false,
            "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 : households-Relationship-smartActions-UserActionRequestPayload-item-response

Type: object

Show Source

Binding: string

Title: Payload Value Binding Type

Maximum Length: 64

Indicates the binding type of the value.
links: array Links

Title: Links

The link relations associated with the resource instance.
MandatoryFlag: boolean

Title: Mandatory

Maximum Length: 1

Boolean value indicating if the payload is mandatory.
RequestPayloadId: integer (int64)

Uniquely identifies the payload for smart actions. For internal use.
RequestPayloadName: string

Title: Request Payload Attribute Name

Maximum Length: 256

The key in the Key Value pair that forms the payload.
SmartSuggestPath: string

Title: Smart Suggest Path

Maximum Length: 2048

The path used for smart suggest.
SystemActionFlag: boolean

Title: System Action

Maximum Length: 1

Default Value: false

Boolean value.
Value: string

Title: Request Payload Attribute Value

Maximum Length: 1000

The value in the Key Value pair that forms the payload.
ValueStruct: string

Title: Payload Value Structure

Maximum Length: 20

If the value in the Key Value pair isn't a single value, this would be set.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"Payload Value Binding Type",
            "maxLength":"64",
            "type":"string",
            "description":"Indicates the binding type of the value.",
            "nullable":true,
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean value.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ValueStruct":{
            "title":"Payload Value Structure",
            "maxLength":"20",
            "type":"string",
            "description":"If the value in the Key Value pair isn't a single value, this would be set.",
            "nullable":true,
            "x-queryable":true
        },
        "Value":{
            "title":"Request Payload Attribute Value",
            "maxLength":"1000",
            "type":"string",
            "description":"The value in the Key Value pair that forms the payload.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SmartSuggestPath":{
            "title":"Smart Suggest Path",
            "maxLength":"2048",
            "type":"string",
            "description":"The path used for smart suggest.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestPayloadId":{
            "type":"integer",
            "description":"Uniquely identifies the payload for smart actions. For internal use.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RequestPayloadName":{
            "title":"Request Payload Attribute Name",
            "maxLength":"256",
            "type":"string",
            "description":"The key in the Key Value pair that forms the payload.",
            "nullable":false,
            "x-queryable":true
        },
        "MandatoryFlag":{
            "title":"Mandatory",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean value indicating if the payload is mandatory.",
            "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 : households-Relationship-smartActions-UserActionURLBinding-item-response

Type: object

Show Source

Binding: string

Title: URL Binding Type

Maximum Length: 64

This is a hint for processing the Url Binding runtime.
links: array Links

Title: Links

The link relations associated with the resource instance.
SystemActionFlag: boolean

Title: System Action

Maximum Length: 1

Default Value: false

Boolean indicator.
URLBindingId: integer (int64)

Uniquely identifies the URL Bind for smart actions. For internal use.
URLBindingName: string

Title: URL Binding Parameter Name

Maximum Length: 256

For action REST endpoints that require runtime binding, this is the key in the key value pair.
Value: string

Title: URL Binding Parameter Value

Maximum Length: 1000

For action REST endpoints that require runtime binding, this is the value in the key value pair.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"URL Binding Type",
            "maxLength":"64",
            "type":"string",
            "description":"This is a hint for processing the Url Binding runtime.",
            "nullable":true,
            "x-queryable":true
        },
        "Value":{
            "title":"URL Binding Parameter Value",
            "maxLength":"1000",
            "type":"string",
            "description":"For action REST endpoints that require runtime binding, this is the value in the key value pair.",
            "nullable":true,
            "x-queryable":true
        },
        "URLBindingId":{
            "type":"integer",
            "description":"Uniquely identifies the URL Bind for smart actions. For internal use.",
            "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"
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean indicator.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "URLBindingName":{
            "title":"URL Binding Parameter Name",
            "maxLength":"256",
            "type":"string",
            "description":"For action REST endpoints that require runtime binding, this is the key in the key value pair.",
            "nullable":false,
            "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"
    }
}