Jump to

• Request
• Response

Get all relationship types

get

/crmRestApi/resources/11.13.18.05/relationshipTypes

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 a relationship type with the specified primary key.
    Finder Variables:
    • LookupCode; string; Finds a relationship type with the specified lookup code.
    • LookupType; string; Finds a relationship type with the specified lookup type.
    • RelationshipTypeId; integer; The unique identifier of the relationship type.
  • RoleForSubjectObjectFinder: Finds a relationship role.
    Finder Variables:
    • bindObjectType; string; Finds a relationship with the specified object type.
    • bindRelationshipCode; string; Finds a relationship with the specified relationship code.
    • bindRelationshipType; string; Finds a relationship with the specified relationship type.
    • bindSubjectType; string; Finds a relationship with the specified subject type.
• 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:
  

  • AllowCircularRelationships; string; Indicates whether the circular relationships are allowed using this relationship type.
  • BackwardRelationshipCode; string; The backward relationship code used to describe relationships like SUPPLIER_OF.
  • CreatedByModule; string; The application module that created the record. It is 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. Review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups.
  • Description; string; The description of the relationship role.
  • DirectionCode; string; The direction code validated by DIRECTION_CODE lookup type. P for Parent, C for Child, and N for Not Directional.
  • EndDateActive; string; The date when the relationship role ends.
  • ForwardRelationshipCode; string; The forward relationship code used to describe relationships like CUSTOMER_OF.
  • Language; string; The relationship role lookup language.
  • LookupCode; string; The relationship role code.
  • LookupType; string; The role lookup code HZ_RELATIONSHIP_ROLE.
  • Meaning; string; The meaning of the relationship role.
  • ObjectType; string; The object type of the relationship type.
  • RelationshipType; string; The name of the relationship type like CUSTOMER_SUPPLIER.
  • RelationshipTypeId; integer; The unique identifier of the relationship type.
  • Role; string; The unique relationship role lookup code based on relationship type and phrase. In the HZ_RELATIONSHIP_ROLE lookup type meaning is the plural role and description is the singular role.
  • SetId; integer; The unique identifier of the set, value 0.
  • SourceLang; string; The source language of the relationship role.
  • StartDateActive; string; The date when the relationship role starts.
  • Status; string; Indicates whether the relationship type is inactive or active with values like I for Inactive, A for Active.
  • SubjectType; string; The subject type of the relationship type. You can't use this attribute as a finder, because this is a transient field. The response will return an error if you use this attribute as a finder.
  • Tag; string; The role tag of the relationship.
  • TerritoryCode; string; The territory code of the relationship role.
  • ViewApplicationId; integer; The unique identifier of the view application of the relationship role lookup code.
• 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 : relationshipTypes

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/relationshipTypes-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"LOV",
        "group":"OEC"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object relationshipTypes-item-response

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

Type: object

Show Source

• AllowCircularRelationships: string
  Title: Circular

  Read Only: true

  Maximum Length: 1

  Indicates whether the circular relationships are allowed using this relationship type.
• BackwardRelationshipCode: string
  Read Only: true

  Maximum Length: 30

  The backward relationship code used to describe relationships like SUPPLIER_OF.
• CreatedByModule: string
  Read Only: true

  Maximum Length: 150

  The application module that created the record. It is 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. Review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups.
• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  The description of the relationship role.
• DirectionCode: string
  Read Only: true

  Maximum Length: 30

  The direction code validated by DIRECTION_CODE lookup type. P for Parent, C for Child, and N for Not Directional.
• EndDateActive: string (date)
  Read Only: true

  The date when the relationship role ends.
• ForwardRelationshipCode: string
  Read Only: true

  Maximum Length: 30

  The forward relationship code used to describe relationships like CUSTOMER_OF.
• Language: string
  Read Only: true

  Maximum Length: 30

  The relationship role lookup language.
• links: array Links
  Title: Links

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

  Maximum Length: 30

  The relationship role code.
• LookupType: string
  Read Only: true

  Maximum Length: 30

  The role lookup code HZ_RELATIONSHIP_ROLE.
• Meaning: string
  Read Only: true

  Maximum Length: 80

  The meaning of the relationship role.
• ObjectType: string
  Title: Object Type

  Read Only: true

  Maximum Length: 30

  The object type of the relationship type.
• RelationshipType: string
  Title: Relationship Type

  Read Only: true

  Maximum Length: 30

  The name of the relationship type like CUSTOMER_SUPPLIER.
• RelationshipTypeId: integer (int64)
  Read Only: true

  The unique identifier of the relationship type.
• Role: string
  Read Only: true

  Maximum Length: 30

  The unique relationship role lookup code based on relationship type and phrase. In the HZ_RELATIONSHIP_ROLE lookup type meaning is the plural role and description is the singular role.
• SetId: integer (int64)
  Read Only: true

  The unique identifier of the set, value 0.
• SourceLang: string
  Read Only: true

  Maximum Length: 4

  The source language of the relationship role.
• StartDateActive: string (date)
  Read Only: true

  The date when the relationship role starts.
• Status: string
  Read Only: true

  Maximum Length: 1

  Indicates whether the relationship type is inactive or active with values like I for Inactive, A for Active.
• SubjectType: string
  Title: Subject Type

  Read Only: true

  Maximum Length: 30

  The subject type of the relationship type. You can't use this attribute as a finder, because this is a transient field. The response will return an error if you use this attribute as a finder.
• Tag: string
  Read Only: true

  Maximum Length: 150

  The role tag of the relationship.
• TerritoryCode: string
  Read Only: true

  Maximum Length: 2

  The territory code of the relationship role.
• ViewApplicationId: integer (int64)
  Read Only: true

  The unique identifier of the view application of the relationship role lookup code.

{
    "type":"object",
    "properties":{
        "Status":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the relationship type is inactive or active with values like I for Inactive, A for Active.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AllowCircularRelationships":{
            "title":"Circular",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the circular relationships are allowed using  this relationship type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ViewApplicationId":{
            "type":"integer",
            "description":"The unique identifier of the view application of the relationship role lookup code.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the relationship role.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationshipTypeId":{
            "type":"integer",
            "description":"The unique identifier of the relationship type.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LookupType":{
            "maxLength":"30",
            "type":"string",
            "description":"The role lookup code HZ_RELATIONSHIP_ROLE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceLang":{
            "maxLength":"4",
            "type":"string",
            "description":"The source language of the relationship role.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationshipType":{
            "title":"Relationship Type",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the relationship type like CUSTOMER_SUPPLIER.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BackwardRelationshipCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The backward relationship code used to describe relationships like SUPPLIER_OF.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DirectionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The direction code validated by DIRECTION_CODE lookup type. P for Parent, C for Child, and N for Not Directional.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LookupCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The relationship role code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Role":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique relationship role lookup code based on relationship type and phrase. In the HZ_RELATIONSHIP_ROLE lookup type meaning is the plural role and description is the singular role.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectType":{
            "title":"Object Type",
            "maxLength":"30",
            "type":"string",
            "description":"The object type of the relationship type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDateActive":{
            "type":"string",
            "description":"The date when the relationship role starts.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDateActive":{
            "type":"string",
            "description":"The date when the relationship role ends.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubjectType":{
            "title":"Subject Type",
            "maxLength":"30",
            "type":"string",
            "description":"The subject type of the relationship type. You can't use this attribute as a finder, because this is a transient field. The response will return an error if you use this attribute as a finder.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Language":{
            "maxLength":"30",
            "type":"string",
            "description":"The relationship role lookup language.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TerritoryCode":{
            "maxLength":"2",
            "type":"string",
            "description":"The territory code of the relationship role.",
            "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"
            }
        },
        "Tag":{
            "maxLength":"150",
            "type":"string",
            "description":"The role tag of the relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedByModule":{
            "maxLength":"150",
            "type":"string",
            "description":"The application module that created the record. It is 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. Review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SetId":{
            "type":"integer",
            "description":"The unique identifier of the set, value 0.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ForwardRelationshipCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The forward relationship code used to describe relationships like CUSTOMER_OF.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Meaning":{
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the relationship role.",
            "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 : 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