1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. List of Values
  4. Screen Pop Pages

Get all screen pop pages

get

/crmRestApi/resources/11.13.18.05/screenPopPages

Request

Query Parameters
  • 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).
  • 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
  • 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:

    • ByNameFinder: Finds a screen pop page by name.
      Finder Variables:
      • Name; string; The name of the screen pop page.
    • PrimaryKey: Finds a screen pop page with the specified primary key.
      Finder Variables:
      • NavigationActionId; integer; The unique identifier of the screen pop record.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • CreatedBy; string; The user who created the record.
    • CreationDate; string; The date and time when the record was created.
    • DisplayName; string; The display name of the screen pop page.
    • EditableFlag; boolean; Indicates whether this is a seeded record.
    • EntityId; integer; This is used to identify the view object used to derive the parameters for Map parameters associated to the page.
    • IsHidden; string; Indicates whether the screen pop page is hidden. The default value is N.
    • Label; string; The label used for the navigation action.
    • LastUpdateDate; string; The date and time when the record was last updated.
    • LastUpdateLogin; string; The login of the user who created the record.
    • LastUpdatedBy; string; The user who last updated the record.
    • Name; string; The unique identifier of the screen pop page which is used to identify the page in API calls.
    • NavigationActionId; integer; The auto-generated number and primary key for this table.
    • PageKey; string; This is specified to uniquely identify a page and is used by page developers.
    • PageTypeCd; string; This is used to indicate what type of screen pop page this is. For example, it could be ORA_SVC_LIST_PAGE, ORA_SVC_EDIT_PAGE, ORA_SVC_CREATE_PAGE, or ORA_SVC_CUSTOM_PAGE
    • Path; string; The path used for the navigation action.
    • TitlePrefix; string; The beginning portion of the title displayed on the navigation page.
    • TitleSuffix; string; The suffix of the title displayed for the navigated page.
    • TitleTokenId; integer; The value of the token to display as part of the title.
    • UITypeCd; string; The user interface type mapping to the lookup type 'ORA_SVC_MCA_SCREEN_PAGE_TYPE'.
    • WebappName; string; The name of the registered application for this navigation action.
  • 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
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : screenPopPages
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : screenPopPages-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 64
    The user who created the record.
  • Read Only: true
    The date and time when the record was created.
  • Title: Display Name
    Maximum Length: 100
    The display name of the screen pop page.
  • Title: Editable
    Maximum Length: 1
    Default Value: true
    Indicates whether this is a seeded record.
  • This is used to identify the view object used to derive the parameters for Map parameters associated to the page.
  • Read Only: true
    Indicates whether the screen pop page is hidden. The default value is N.
  • Title: Label
    Maximum Length: 64
    The label used for the navigation action.
  • Read Only: true
    The date and time when the record was last updated.
  • Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Read Only: true
    Maximum Length: 32
    The login of the user who created the record.
  • Links
  • Screen Pop Page Parameters
    Title: Screen Pop Page Parameters
    The screen pop page parameters resource is used to view the parameters accepted by a screen pop page. The parameters indicate data needed to display the correct content on a page.
  • Title: Page Name
    Maximum Length: 64
    The unique identifier of the screen pop page which is used to identify the page in API calls.
  • Title: Navigation Action ID
    Read Only: true
    The auto-generated number and primary key for this table.
  • Title: Page Key
    Maximum Length: 256
    This is specified to uniquely identify a page and is used by page developers.
  • Title: Page Type
    Maximum Length: 30
    This is used to indicate what type of screen pop page this is. For example, it could be ORA_SVC_LIST_PAGE, ORA_SVC_EDIT_PAGE, ORA_SVC_CREATE_PAGE, or ORA_SVC_CUSTOM_PAGE
  • Title: Page Path
    Maximum Length: 500
    The path used for the navigation action.
  • Title: Title Prefix
    Maximum Length: 80
    The beginning portion of the title displayed on the navigation page.
  • Title: Title Suffix
    Maximum Length: 80
    The suffix of the title displayed for the navigated page.
  • Title: Token ID
    The value of the token to display as part of the title.
  • Title: User Interface Type
    Maximum Length: 30
    Default Value: ORA_SVC_ADF
    The user interface type mapping to the lookup type 'ORA_SVC_MCA_SCREEN_PAGE_TYPE'.
  • Title: Registered App Name
    Maximum Length: 250
    The name of the registered application for this navigation action.
Nested Schema : Screen Pop Page Parameters
Type: array
Title: Screen Pop Page Parameters
The screen pop page parameters resource is used to view the parameters accepted by a screen pop page. The parameters indicate data needed to display the correct content on a page.
Show Source
Nested Schema : screenPopPages-McaParameters-item-response
Type: object
Show Source
  • The attribute returns the Business Object if the UserDefinedFlag is N; else, returns User Defined.
  • Links
  • Screen Pop Page Map Parameters
    Title: Screen Pop Page Map Parameters
    The screen pop page map parameters resource is used to view a screen pop page parameter of the type map. Map type parameters can contain a variable number of other parameters, and are used to pass initial pre-populated fields to a create type page.
  • 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.
  • Title: Page Parameter
    Maximum Length: 64
    The name of the screen pop page parameter.
  • 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.
  • Indicates whether this is a required parameter. If the OptionalFlag is true, then returns N.
  • The name of the token code, if the MappingCode is 'TOKEN'. The code indicates the type of token.
  • The user readable token name, if the MappingCode is 'TOKEN'.
  • Maximum Length: 1
    Default Value: false
    Indicates whether the parameter is a user defined parameter.
Nested Schema : Screen Pop Page Map Parameters
Type: array
Title: Screen Pop Page Map Parameters
The screen pop page map parameters resource is used to view a screen pop page parameter of the type map. Map type parameters can contain a variable number of other parameters, and are used to pass initial pre-populated fields to a create type page.
Show Source
Nested Schema : screenPopPages-McaParameters-MapParameters-item-response
Type: object
Show Source
  • The attribute returns the Business Object if the UserDefinedFlag is N; else, returns User Defined.
  • Links
  • 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.
  • Title: Page Parameter
    Maximum Length: 64
    The name of the screen pop page parameter.
  • 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.
  • Indicates whether this is a required parameter. If the OptionalFlag is true, then returns N.
  • The name of the token code, if the MappingCode is 'TOKEN'. The code indicates the type of token.
  • The user readable token name, if the MappingCode is 'TOKEN'.
  • Maximum Length: 1
    Default Value: false
    Indicates whether the parameter is a user defined parameter.
Back to Top

Examples

Use GET with the following URI syntax to get details of all screen pop pages:

Example of Request URI

The following shows an example of the request URL.

https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/screenPopPages

Example of Request Header

The following shows an example of the request header.

GET /crmRestApi/resources/11.13.18.05/screenPopPages/ HTTP/1.1
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
Date: Mon, 13 Jan 2017 09:13:04 GMT
Server: Oracle-HTTP-Server-11g
Content-Type: application/vnd.oracle.adf.resourceitem+json
Content-Language: en

Example of Response Body

The following shows an example of the response body in JSON format.

{
{
"items": [
  {
"Name": "Create_Account",
"DisplayName": "Create Account",
"links": [
  {
"rel": "self",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/screenPopPages/Create_Account",
"name": "screenPopPages",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
}
},
  {
"rel": "canonical",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/screenPopPages/Create_Account",
"name": "screenPopPages",
"kind": "item"
},
  {
"rel": "child",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/screenPopPages/Create_Account/child/McaParameters",
"name": "McaParameters",
"kind": "collection"
}
],
},
  {
"Name": "Create_Contact",
"DisplayName": "Create Contact",
"links": [
  {
"rel": "self",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/screenPopPages/Create_Contact",
"name": "screenPopPages",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
}
},
  {
"rel": "canonical",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/screenPopPages/Create_Contact",
"name": "screenPopPages",
"kind": "item"
},
  {
"rel": "child",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/screenPopPages/Create_Contact/child/McaParameters",
"name": "McaParameters",
"kind": "collection"
}
],
},
  . . .
}
],
"count": 7,
"hasMore": false,
"limit": 25,
"offset": 0,
"links": [
  {
"rel": "self",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/screenPopPages",
"name": "screenPopPages",
"kind": "collection"
}
],
}
Back to Top