Get a scope configuration
get
/fscmRestApi/resources/11.13.18.05/publicSectorScopeConfigurations/{ScopeConfigId}
Request
Path Parameters
-
ScopeConfigId: string
The unique identifier of the scope configuration setup.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes 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 attributes 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 attributes. 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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorScopeConfigurations-item
Type:
Show Source
object
-
AltKeyName(optional):
string
Title:
Alternate Key Name
Maximum Length:100
The alternate identifier name of the scope configuration setup data. -
BoName(optional):
string
Title:
Business Object
Maximum Length:255
The name of the business object in the scope configuration setup data. -
DeletedFlag(optional):
string
Maximum Length:
1
Indicates the deleted status of the scope configuration setup. -
links(optional):
array Items
Title:
Items
Link Relations -
ParentBoName(optional):
string
Title:
Parent Business Object
Maximum Length:255
The name of the parent business object in the scope configuration setup data. -
ScopeConfigDescr(optional):
string
Title:
Description
Maximum Length:100
The description about the scope configuration setup. -
ScopeConfigId(optional):
string
Title:
Scope Configuration ID
Maximum Length:50
The unique identifier of the scope configuration setup. -
ScopeConfigurationField(optional):
array Scope Configuration Fields
Title:
Scope Configuration Fields
The scope configuration resource is used to enable the filtration of the setup data for the Functional Setup Manager export process. The resource shows the details of the filter criteria. -
SeedDataLock(optional):
integer(int32)
Indicates the seed data lock status of the scope configuration setup.
-
ServiceLabel(optional):
string
Title:
Service Label
Maximum Length:255
The label of the Scope Selection page. -
ServiceName(optional):
string
Title:
Service Name
Maximum Length:100
The name of the data service in the scope configuration setup. -
VoName(optional):
string
Title:
View Object Name
Maximum Length:100
The name of the view object in the scope configuration setup data.
Nested Schema : Scope Configuration Fields
Type:
array
Title:
Scope Configuration Fields
The scope configuration resource is used to enable the filtration of the setup data for the Functional Setup Manager export process. The resource shows the details of the filter criteria.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.
Nested Schema : publicSectorScopeConfigurations-ScopeConfigurationField-item
Type:
Show Source
object
-
AltKeyAttrb(optional):
string
Title:
Alternate Key Field
Maximum Length:100
The alternative unique identifier of the scope configuration setup data. -
AltKeyReference(optional):
string
Title:
Reference Business Object
Maximum Length:50
The name of the reference attribute for the alternate attribute in the scope configuration field setup data. -
AutoKeyFlag(optional):
boolean
Title:
Surrogate Field
The attribute to determine whether the scope configuration field setup data has an auto generated unique attribute. -
DeletedFlag(optional):
string
Maximum Length:
1
Indicates the deleted status of the scope configuration field setup. -
FieldLabelString(optional):
string
Title:
Label String Key
Maximum Length:160
The attribute label string that is displayed on the Scope Selection page. -
FieldName(optional):
string
Title:
Field Name
Maximum Length:100
The attribute name of the scope configuration field setup data. -
FieldType(optional):
string
Title:
Field Type
Maximum Length:20
The attribute type of the scope configuration field setup data. -
links(optional):
array Items
Title:
Items
Link Relations -
ReturnToFsmFlag(optional):
boolean
Title:
Return to Functional Setup Manager
The attribute to determine whether the field value is used as a scope for data filtration. -
ScopeConfigId(optional):
string
Title:
Scope Configuration ID
Maximum Length:50
The unique identifier of the scope configuration setup. -
ScopeFieldId(optional):
string
Title:
Field ID
Maximum Length:12
The unique identifier of the scope configuration field setup. -
SeedDataLock(optional):
integer(int32)
Indicates the seed data lock status of the scope configuration setup.