Jump to

• Request
• Response
• Examples

Get all channels associated with a channel type

get

/crmRestApi/resources/11.13.18.05/serviceChannelTypesLOV/{LookupCode}/child/svcChannelLookups

Request

Path Parameters

• LookupCode(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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:
  
  

  • ChannelEnabledFinder :Finds enabled channels with the specified finder.
    Finder Variables:
  • ChannelVOChannelShortNameAltKey :Finds a channel with the specified alternate key.
    Finder Variables:
    • ChannelShortName :The short name of the channel.
  • DefaultChannelByTypeFinder :Finds the default channel for a given channel type.
    Finder Variables:
    • AccountName :The account name of the channel.
    • ChannelTypeCd :The channel type associated with the channel.
  • EnabledChannelByBUAndStripeAndTypeFinder :Finds enabled channels for an application stripe, business unit, and channel type combination.
    Finder Variables:
    • BUOrgId :The business unit identifier to filter the search with.
    • ChannelTypeCd :The channel type to filter the search with.
    • StripeCd :The application stripe to filter the search by.
  • PrimaryKey :Finds a channel with the specified primary key.
    Finder Variables:
    • ChannelId :The unique identifier of the communication channel.
• 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:
  

  • APIId; string; The unique identifier of the channel API.
  • APIPassword; string; The password for the channel API.
  • APIVersion; string; The API version of the channel.
  • AccessToken; string; The access token used for the channel.
  • AccountName; string; The name of the account associated with the channel.
  • AuthToken; string; The authorization token used for the social channel.
  • AuthenticationURL; string; The channel authentication URL.
  • AuthorizationURL; string; The channel authorization URL.
  • BUOrgId; integer; The unique identifier of the business unit associated with the channel.
  • BusinessUnitName; string; The name of the business unit associated with the channel.
  • ChannelId; integer; The unique identifier of the communication channel.
  • ChannelShortName; string; The short name of the channel.
  • ChannelTypeCd; string; The type of the communication channel.
  • CreatedBy; string; The user who created the channel.
  • CreationDate; string; The date when the channel was created.
  • CustomerTypeCd; string; The type of customers expected to send a message to the channel, such as Consumer, Business, or Both.
  • DisplayName; string; The display name of the communication channel.
  • EnabledFlag; boolean; Indicates whether the channel is active.
  • EndPoint; string; The endpoint of the channel.
  • IncludeSenderEmailFlag; boolean; Indicates whether the sender's email address should be included in the outbound message.
  • IncludeSenderNameFlag; boolean; Indicates whether the sender's name should be included in the outbound message.
  • LastUpdateDate; string; The date when the channel was last updated.
  • LastUpdateLogin; string; The login of the user who last updated the channel.
  • LastUpdatedBy; string; The user who last updated the channel.
  • MultipleMatchesActionCd; string; The action the application should take if multiple matches are found for the message sender, such as Select None or Select First Match.
  • NetworkTypeCd; string; The social network associated with the channel.
  • NoMatchActionCd; string; The action the application should take if no matches are found for the message sender, such as Nothing or Create Contact.
  • OpenSrCount; integer; The number of service requests associated with the channel that are neither deleted nor closed.
  • OriginalSystemReference; string; The original system of reference for a channel that was imported.
  • Port; string; The port associated with the channel.
  • PrivatePToPAllowedFlag; boolean; Indicates whether the channel allows private messages.
  • PurposeCd; string; The purpose of the channel such as Support, Sales, Inquiry.
  • RefreshToken; string; The refresh token used for the social channel.
  • SourceCd; string; The source interface for the channel creation.
  • StripeCd; string; The application stripe of the channel.
  • TokenAccessURL; string; The channel token access URL.
  • TokenRequestURL; string; The URL to pass a token request on the channel.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : serviceChannelTypesLOV-svcChannelLookups

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/serviceChannelTypesLOV-svcChannelLookups-item-response"
            }
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object serviceChannelTypesLOV-svcChannelLookups-item-response

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

Type: object

Show Source

• AccessToken: string
  Title: Access Token

  Maximum Length: 400

  The access token used for the channel.
• AccountName: string
  Title: Account Name

  Maximum Length: 400

  The name of the account associated with the channel.
• APIId: string
  Title: API

  Maximum Length: 400

  The unique identifier of the channel API.
• APIPassword: string
  Title: API Password

  Maximum Length: 400

  The password for the channel API.
• APIVersion: string
  Title: API Version

  Maximum Length: 400

  The API version of the channel.
• AuthenticationURL: string
  Title: Authentication URL

  Maximum Length: 1000

  The channel authentication URL.
• AuthorizationURL: string
  Title: Authorization URL

  Maximum Length: 1000

  The channel authorization URL.
• AuthToken: string
  Title: Authorization Token

  Maximum Length: 400

  The authorization token used for the social channel.
• BUOrgId: integer (int64)
  Title: Business Unit ID

  The unique identifier of the business unit associated with the channel.
• BusinessUnitName: string
  Title: Business Unit Name

  Maximum Length: 255

  The name of the business unit associated with the channel.
• ChannelId: integer (int64)
  Title: Channel

  Read Only: true

  The unique identifier of the communication channel.
• ChannelShortName: string
  Title: Channel Code

  Maximum Length: 450

  The short name of the channel.
• ChannelTypeCd: string
  Title: Channel Type

  Maximum Length: 30

  The type of the communication channel.
• ChannelTypeCdLovSwitcher: string
  Read Only: true

  The name of the channel type list of values picker.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the channel.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the channel was created.
• CustomerTypeCd: string
  Title: Customer Type

  Maximum Length: 30

  The type of customers expected to send a message to the channel, such as Consumer, Business, or Both.
• DeleteFlag: boolean
  Read Only: true

  Indicates whether the channel has been deleted.
• DisplayName: string
  Title: Display Name

  Maximum Length: 400

  The display name of the communication channel.
• EnabledFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: true

  Indicates whether the channel is active.
• EndPoint: string
  Title: Endpoint

  Maximum Length: 1000

  The endpoint of the channel.
• IncludeSenderEmailFlag: boolean
  Title: Include Sender Email

  Maximum Length: 1

  Default Value: false

  Indicates whether the sender's email address should be included in the outbound message.
• IncludeSenderNameFlag: boolean
  Title: Include Sender Name

  Maximum Length: 1

  Default Value: false

  Indicates whether the sender's name should be included in the outbound message.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the channel was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the channel.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the channel.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MultipleMatchesActionCd: string
  Title: If Multiple Matches Found for Sender

  Maximum Length: 30

  The action the application should take if multiple matches are found for the message sender, such as Select None or Select First Match.
• NetworkTypeCd: string
  Title: Network

  Maximum Length: 30

  The social network associated with the channel.
• NoMatchActionCd: string
  Title: If No Matches Found for Sender

  Maximum Length: 30

  The action the application should take if no matches are found for the message sender, such as Nothing or Create Contact.
• OpenSrCount: integer
  Read Only: true

  The number of service requests associated with the channel that are neither deleted nor closed.
• OriginalSystemReference: string
  Title: Original System

  Maximum Length: 255

  The original system of reference for a channel that was imported.
• Port: string
  Title: Port

  Maximum Length: 10

  The port associated with the channel.
• PrivatePToPAllowedFlag: boolean
  Title: Private Conversation Allowed

  Maximum Length: 1

  Default Value: true

  Indicates whether the channel allows private messages.
• PurposeCd: string
  Title: Purpose

  Maximum Length: 30

  The purpose of the channel such as Support, Sales, Inquiry.
• RefreshToken: string
  Title: Refresh Token

  Maximum Length: 400

  The refresh token used for the social channel.
• SourceCd: string
  Title: Source Code

  Maximum Length: 30

  Default Value: ORA_SVC_ADMIN_UI

  The source interface for the channel creation.
• StripeCd: string
  Title: Stripe Code

  Maximum Length: 30

  The application stripe of the channel.
• TokenAccessURL: string
  Title: Token Access URL

  Maximum Length: 1000

  The channel token access URL.
• TokenRequestURL: string
  Title: Token Request URL

  Maximum Length: 1000

  The URL to pass a token request on the channel.
• UpdateFlag: boolean
  Read Only: true

  Indicates whether the channel has been updated.

{
    "type":"object",
    "properties":{
        "APIId":{
            "title":"API",
            "maxLength":400,
            "type":"string",
            "description":"The unique identifier of the channel API.",
            "nullable":true,
            "x-queryable":true
        },
        "APIPassword":{
            "title":"API Password",
            "maxLength":400,
            "type":"string",
            "description":"The password for the channel API.",
            "nullable":true,
            "x-queryable":true
        },
        "APIVersion":{
            "title":"API Version",
            "maxLength":400,
            "type":"string",
            "description":"The API version of the channel.",
            "nullable":true,
            "x-queryable":true
        },
        "AccessToken":{
            "title":"Access Token",
            "maxLength":400,
            "type":"string",
            "description":"The access token used for the channel.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountName":{
            "title":"Account Name",
            "maxLength":400,
            "type":"string",
            "description":"The name of the account associated with the channel.",
            "nullable":false,
            "x-queryable":true
        },
        "AuthToken":{
            "title":"Authorization Token",
            "maxLength":400,
            "type":"string",
            "description":"The authorization token used for the social channel.",
            "nullable":true,
            "x-queryable":true
        },
        "AuthenticationURL":{
            "title":"Authentication URL",
            "maxLength":1000,
            "type":"string",
            "description":"The channel authentication URL.",
            "nullable":true,
            "x-queryable":true
        },
        "AuthorizationURL":{
            "title":"Authorization URL",
            "maxLength":1000,
            "type":"string",
            "description":"The channel authorization URL.",
            "nullable":true,
            "x-queryable":true
        },
        "BUOrgId":{
            "title":"Business Unit ID",
            "type":"integer",
            "description":"The unique identifier of the business unit associated with the channel.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            },
            "x-queryable":true
        },
        "BusinessUnitName":{
            "title":"Business Unit Name",
            "maxLength":255,
            "type":"string",
            "description":"The name of the business unit associated with the channel.",
            "nullable":true,
            "x-queryable":true
        },
        "ChannelId":{
            "title":"Channel",
            "type":"integer",
            "description":"The unique identifier of the communication channel.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChannelShortName":{
            "title":"Channel Code",
            "maxLength":450,
            "type":"string",
            "description":"The short name of the channel.",
            "nullable":false,
            "x-queryable":true
        },
        "ChannelTypeCd":{
            "title":"Channel Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the communication channel.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ChannelTypeCdLovSwitcher":{
            "type":"string",
            "description":"The name of the channel type list of values picker.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the channel.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the channel was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerTypeCd":{
            "title":"Customer Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of customers expected to send a message to the channel, such as Consumer, Business, or Both.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the channel has been deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DisplayName":{
            "title":"Display Name",
            "maxLength":400,
            "type":"string",
            "description":"The display name of the communication channel.",
            "nullable":true,
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the channel is active.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EndPoint":{
            "title":"Endpoint",
            "maxLength":1000,
            "type":"string",
            "description":"The endpoint of the channel.",
            "nullable":true,
            "x-queryable":true
        },
        "IncludeSenderEmailFlag":{
            "title":"Include Sender Email",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the sender's email address should be included in the outbound message.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "IncludeSenderNameFlag":{
            "title":"Include Sender Name",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the sender's name should be included in the outbound message.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the channel was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the channel.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the channel.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MultipleMatchesActionCd":{
            "title":"If Multiple Matches Found for Sender",
            "maxLength":30,
            "type":"string",
            "description":"The action the application should take if multiple matches are found for the message sender, such as Select None or Select First Match.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "NetworkTypeCd":{
            "title":"Network",
            "maxLength":30,
            "type":"string",
            "description":"The social network associated with the channel.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "NoMatchActionCd":{
            "title":"If No Matches Found for Sender",
            "maxLength":30,
            "type":"string",
            "description":"The action the application should take if no matches are found for the message sender, such as Nothing or Create Contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OpenSrCount":{
            "type":"integer",
            "description":"The number of service requests associated with the channel that are neither deleted nor closed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OriginalSystemReference":{
            "title":"Original System",
            "maxLength":255,
            "type":"string",
            "description":"The original system of reference for a channel that was imported.",
            "nullable":true,
            "x-queryable":true
        },
        "Port":{
            "title":"Port",
            "maxLength":10,
            "type":"string",
            "description":"The port associated with the channel.",
            "nullable":true,
            "x-queryable":true
        },
        "PrivatePToPAllowedFlag":{
            "title":"Private Conversation Allowed",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the channel allows private messages.",
            "nullable":true,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PurposeCd":{
            "title":"Purpose",
            "maxLength":30,
            "type":"string",
            "description":"The purpose of the channel such as Support, Sales, Inquiry.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RefreshToken":{
            "title":"Refresh Token",
            "maxLength":400,
            "type":"string",
            "description":"The refresh token used for the social channel.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceCd":{
            "title":"Source Code",
            "maxLength":30,
            "type":"string",
            "description":"The source interface for the channel creation.",
            "nullable":false,
            "default":"ORA_SVC_ADMIN_UI",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StripeCd":{
            "title":"Stripe Code",
            "maxLength":30,
            "type":"string",
            "description":"The application stripe of the channel.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TokenAccessURL":{
            "title":"Token Access URL",
            "maxLength":1000,
            "type":"string",
            "description":"The channel token access URL.",
            "nullable":true,
            "x-queryable":true
        },
        "TokenRequestURL":{
            "title":"Token Request URL",
            "maxLength":1000,
            "type":"string",
            "description":"The URL to pass a token request on the channel.",
            "nullable":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the channel has been updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

Examples

The following example shows how to get all channel type lookups by submitting a GET request on the REST resource using cURL.

cURL Command

- curl -u <username:password> \ -X http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceChannelTypesLOV/ORA_SVC_CHAT/child/svcChannelLookups

Example of Response Body

{
    "items": [
        {
            "ChannelId": 100100104291162,
            "ChannelTypeCd": "ORA_SVC_CHAT",
            "NetworkTypeCd": null,
            "AccountName": "Chat",
            "DisplayName": "Chat",
            "PrivatePToPAllowedFlag": true,
            "OriginalSystemReference": null,
            "EnabledFlag": true,
            "CreatedBy": "SEED_DATA_FROM_APPLICATION",
            "CreationDate": "2017-06-26T20:17:51.972+00:00",
            "LastUpdatedBy": "SEED_DATA_FROM_APPLICATION",
            "LastUpdateDate": "2019-03-19T03:21:25.273+00:00",
            "LastUpdateLogin": "-1",
            "EndPoint": null,
            "Port": null,
            "APIVersion": null,
            "APIId": null,
            "APIPassword": null,
            "AuthenticationURL": null,
            "AuthorizationURL": null,
            "TokenRequestURL": null,
            "TokenAccessURL": null,
            "AccessToken": null,
            "RefreshToken": null,
            "AuthToken": null,
            "OpenSrCount": null,
            "ChannelTypeCdLovSwitcher": "LOV_ChannelTypeCd",
            "StripeCd": "ORA_SVC_CRM",
            "BUOrgId": null,
            "BusinessUnitName": null,
            "UpdateFlag": true,
            "DeleteFlag": true,
            "PurposeCd": "SUPPORT",
            "CustomerTypeCd": "ORA_SVC_BOTH",
            "MultipleMatchesActionCd": "ORA_SVC_NONE",
            "NoMatchActionCd": "ORA_SVC_NO_ACTION",
            "IncludeSenderNameFlag": false,
            "IncludeSenderEmailFlag": false,
            "links": [
                {
                    "rel": "self",
                    "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceChannelTypesLOV/ORA_SVC_CHAT/child/svcChannelLookups/100100104291162",
                    "name": "svcChannelLookups",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceChannelTypesLOV/ORA_SVC_CHAT/child/svcChannelLookups/100100104291162",
                    "name": "svcChannelLookups",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceChannelTypesLOV/ORA_SVC_CHAT",
                    "name": "serviceChannelTypesLOV",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceChannelTypesLOV/ORA_SVC_CHAT/child/svcChannelLookups/100100104291162/lov/CustomerTypeCdLookup",
                    "name": "CustomerTypeCdLookup",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceChannelTypesLOV/ORA_SVC_CHAT/child/svcChannelLookups/100100104291162/lov/YesNoLOV",
                    "name": "YesNoLOV",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceChannelTypesLOV/ORA_SVC_CHAT/child/svcChannelLookups/100100104291162/lov/NoMatchActionCdLookup",
                    "name": "NoMatchActionCdLookup",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceChannelTypesLOV/ORA_SVC_CHAT/child/svcChannelLookups/100100104291162/lov/MultipleMatchesActionCdLookup",
                    "name": "MultipleMatchesActionCdLookup",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceChannelTypesLOV/ORA_SVC_CHAT/child/svcChannelLookups/100100104291162/lov/PurposeCdLookup",
                    "name": "PurposeCdLookup",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceChannelTypesLOV/ORA_SVC_CHAT/child/svcChannelLookups/100100104291162/lov/BusinessUnitLOV",
                    "name": "BusinessUnitLOV",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceChannelTypesLOV/ORA_SVC_CHAT/child/svcChannelLookups/100100104291162/lov/NetworkTypeCdLOV",
                    "name": "NetworkTypeCdLOV",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceChannelTypesLOV/ORA_SVC_CHAT/child/svcChannelLookups/100100104291162/lov/StripeCdLOV",
                    "name": "StripeCdLOV",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceChannelTypesLOV/ORA_SVC_CHAT/child/svcChannelLookups/100100104291162/lov/ChannelTypeCdLOV",
                    "name": "ChannelTypeCdLOV",
                    "kind": "collection"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceChannelTypesLOV/ORA_SVC_CHAT/child/svcChannelLookups",
            "name": "svcChannelLookups",
            "kind": "collection"
        }
    ]
}

Back to Top