REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience

Get a page map parameter

get

/crmRestApi/resources/11.13.18.05/screenPopPages/{Name}/child/McaParameters/{McaParametersUniqID}/child/MapParameters/{MapParametersUniqID}

Request

Path Parameters

MapParametersUniqID(required): string

This is the hash key of the attributes which make up the composite key for the Screen Pop Page Map Parameters resource and used to uniquely identify an instance of Screen Pop Page Map Parameters. The client should not generate the hash key value. Instead, the client should query on the Screen Pop Page Map Parameters collection resource in order to navigate to a specific instance of Screen Pop Page Map Parameters to get the hash key.
McaParametersUniqID(required): string

This is the hash key of the attributes which make up the composite key for the Screen Pop Page Parameters resource and used to uniquely identify an instance of Screen Pop Page Parameters. The client should not generate the hash key value. Instead, the client should query on the Screen Pop Page Parameters collection resource in order to navigate to a specific instance of Screen Pop Page Parameters to get the hash key.
Name(required): string

The unique identifier of the screen pop page which is used to identify the page in API calls.

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
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
onlyData: boolean

The resource item payload will be filtered in order to contain only data (no links section, for example).

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 : screenPopPages-McaParameters-MapParameters-item-response

Type: object

Show Source

AttributeType: string

The attribute returns the Business Object if the UserDefinedFlag is N; else, returns User Defined.
links: array Links

Title: Links

The link relations associated with the resource instance.
MappingCode: string

Title: Mapping

Maximum Length: 20

Default Value: TOKEN

The code indicating the type of value passed to the parameter. The list of accepted values is defined in the lookup ORA_SVC_MCA_MAPPING_CODE_CD.
Name: string

Title: Page Parameter

Maximum Length: 64

The name of the screen pop page parameter.
OptionalFlag: boolean

Title: Required

Maximum Length: 1

Default Value: true

Indicates whether the parameter is required to display the page. If true, the parameter is required. If false, the parameter can be left blank. The default value is true.
Required: string

Indicates whether this is a required parameter. If the OptionalFlag is true, then returns N.
TokenCode: string

The name of the token code, if the MappingCode is 'TOKEN'. The code indicates the type of token.
TokenName: string

The user readable token name, if the MappingCode is 'TOKEN'.
UserDefinedFlag: boolean

Maximum Length: 1

Default Value: false

Indicates whether the parameter is a user defined parameter.

{
    "type":"object",
    "properties":{
        "UserDefinedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the parameter is a user defined parameter.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "Required":{
            "type":"string",
            "description":"Indicates whether this is a required parameter. If the OptionalFlag is true, then returns N.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeType":{
            "type":"string",
            "description":"The attribute returns the Business Object if the UserDefinedFlag is N; else, returns User Defined.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TokenName":{
            "type":"string",
            "description":"The user readable token name, if the MappingCode is 'TOKEN'.",
            "nullable":true,
            "x-queryable":true
        },
        "MappingCode":{
            "title":"Mapping",
            "maxLength":"20",
            "type":"string",
            "description":"The code indicating the type of value passed to the parameter. The list of accepted values is defined in the lookup ORA_SVC_MCA_MAPPING_CODE_CD.",
            "nullable":false,
            "default":"TOKEN",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OptionalFlag":{
            "title":"Required",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the parameter is required to display the page. If true, the parameter is required. If false, the parameter can be left blank. The default value is true.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Page Parameter",
            "maxLength":"64",
            "type":"string",
            "description":"The name of the screen pop page parameter.",
            "nullable":false,
            "x-queryable":true
        },
        "TokenCode":{
            "type":"string",
            "description":"The name of the token code, if the MappingCode is 'TOKEN'. The code indicates the type of token.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

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

Nested Schema : link

Type: object

Show Source

href: string

Title: hyperlink reference

The URI to the related resource.
kind: string

Title: kind

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

The kind of the related resource.
name: string

Title: name

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

Title: relation

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

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

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

Nested Schema : properties

Type: object

Show Source

changeIndicator: string

Change indicator or the ETag value of the resource instance.

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

Examples

The following example shows how to get a map page parameter by submitting a GET request on the REST resource.

Example of Request Header

The following shows an example of the request header.

GET /crmRestApi/resources/11.13.18.05/screenPopPages/Create_Service_Request/child/McaParameters/300100089699702/child/MapParameters/300100099573940
HOST: servername.fa.us2.oraclecloud.com
authorization: Basic U0FMRVNfQURNSU46V2VsY29tZTE=
content-type: application/vnd.oracle.adf.resourceitem+json

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Server: Oracle-HTTP-Server-11g
Content-Type: application/vnd.oracle.adf.resourceitem+json
Content-Language: en

Example of Response Body

The following example shows the contents of the response body.

{
  "Name": "ProblemDescription",
  "OptionalFlag": true,
  "MappingCode": "VALUE",
  "TokenName": "",
  "TokenCode": "",
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/screenPopPages/Create_Service_Request/child/McaParameters/300100089699702/child/MapParameters/300100099573940",
      "name": "MapParameters",
      "kind": "item",
      "properties": {
        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
      }
    },
    {
      "rel": "canonical",
      "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/screenPopPages/Create_Service_Request/child/McaParameters/300100089699702/child/MapParameters/300100099573940",
      "name": "MapParameters",
      "kind": "item"
    },
    {
      "rel": "parent",
      "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/screenPopPages/Create_Service_Request/child/McaParameters/300100089699702",
      "name": "McaParameters",
      "kind": "item"
    },
    {
      "rel": "lov",
      "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/screenPopPages/Create_Service_Request/child/McaParameters/300100089699702/child/MapParameters/300100099573940/lov/MappingCodeLOV",
      "name": "MappingCodeLOV",
      "kind": "collection"
    }
  ]
}