Create a set of scope configurations for all setup data
post
/fscmRestApi/resources/11.13.18.05/publicSectorScopeConfigurations
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AltKeyName: string
Title:
Alternate Key Name
Maximum Length:100
The alternate identifier name of the scope configuration setup data. -
BoName(required): string
Title:
Business Object
Maximum Length:255
The name of the business object in the scope configuration setup data. -
DefaultScope: string
Maximum Length:
1000
Indicates the default scope that will be applied to the business object during export. -
DeletedFlag: string
Maximum Length:
1
Default Value:N
Indicates the deleted status of the scope configuration setup. -
EffdtMigrationMode: string
Maximum Length:
8
Indicates the migration mode for the effective dated setup table. The possible values are ORA_UPD for update and ORA_CUR for correction mode. -
ParentBoName: string
Title:
Parent Business Object
Maximum Length:255
The name of the parent business object in the scope configuration setup data. -
RowIdentifier: string
Maximum Length:
60
The row identifier in the data XML. -
ScopeConfigDescr(required): string
Title:
Description
Maximum Length:100
The description about the scope configuration setup. -
ScopeConfigId(required): string
Title:
Scope Configuration ID
Maximum Length:50
The unique identifier of the scope configuration setup. -
ScopeConfigurationField: array
Scope Configuration Fields
Title:
Scope Configuration Fields
The scope configuration fields resource is used to enable the filtration of the setup data fields for the Functional Setup Manager export process. The resource shows the details of the filter criteria fields. -
SeedDataLock: integer
(int32)
Default Value:
0
Indicates the seed data lock status of the scope configuration setup. -
ServiceLabel(required): string
Title:
Service Label
Maximum Length:255
The label of the Scope Selection page. -
ServiceName(required): string
Title:
Service Name
Maximum Length:100
The name of the data service in the scope configuration setup. -
VoName(required): 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 fields resource is used to enable the filtration of the setup data fields for the Functional Setup Manager export process. The resource shows the details of the filter criteria fields.
Show Source
Nested Schema : publicSectorScopeConfigurations-ScopeConfigurationField-item-post-request
Type:
Show Source
object
-
AltKeyAttrb: string
Title:
Alternate Key Field
Maximum Length:100
The alternative unique identifier of the scope configuration setup data. -
AltKeyReference: 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: boolean
Title:
Surrogate Field
Maximum Length:1
The attribute to determine whether the scope configuration field setup data has an auto generated unique attribute. -
DeletedFlag: string
Maximum Length:
1
Default Value:N
Indicates the deleted status of the scope configuration field setup. -
FieldLabelString: string
Title:
Label String Key
Maximum Length:160
The attribute label string that is displayed on the Scope Selection page. -
FieldName: string
Title:
Field Name
Maximum Length:100
The attribute name of the scope configuration field setup data. -
FieldType: string
Title:
Field Type
Maximum Length:20
The attribute type of the scope configuration field setup data. -
ReturnToFsmFlag: boolean
Title:
Return to Functional Setup Manager
Maximum Length:1
The attribute to determine whether the field value is used as a scope for data filtration. -
ScopeConfigId: string
Title:
Scope Configuration ID
Maximum Length:50
The unique identifier of the scope configuration setup. -
ScopeFieldId: string
Title:
Field ID
Maximum Length:12
The unique identifier of the scope configuration field setup. -
SeedDataLock: integer
(int32)
Default Value:
0
Indicates the seed data lock status of the scope configuration setup.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : publicSectorScopeConfigurations-item-response
Type:
Show Source
object
-
AltKeyName: string
Title:
Alternate Key Name
Maximum Length:100
The alternate identifier name of the scope configuration setup data. -
BoName: string
Title:
Business Object
Maximum Length:255
The name of the business object in the scope configuration setup data. -
DefaultScope: string
Maximum Length:
1000
Indicates the default scope that will be applied to the business object during export. -
DeletedFlag: string
Maximum Length:
1
Default Value:N
Indicates the deleted status of the scope configuration setup. -
EffdtMigrationMode: string
Maximum Length:
8
Indicates the migration mode for the effective dated setup table. The possible values are ORA_UPD for update and ORA_CUR for correction mode. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ParentBoName: string
Title:
Parent Business Object
Maximum Length:255
The name of the parent business object in the scope configuration setup data. -
RowIdentifier: string
Maximum Length:
60
The row identifier in the data XML. -
ScopeConfigDescr: string
Title:
Description
Maximum Length:100
The description about the scope configuration setup. -
ScopeConfigId: string
Title:
Scope Configuration ID
Maximum Length:50
The unique identifier of the scope configuration setup. -
ScopeConfigurationField: array
Scope Configuration Fields
Title:
Scope Configuration Fields
The scope configuration fields resource is used to enable the filtration of the setup data fields for the Functional Setup Manager export process. The resource shows the details of the filter criteria fields. -
SeedDataLock: integer
(int32)
Default Value:
0
Indicates the seed data lock status of the scope configuration setup. -
ServiceLabel: string
Title:
Service Label
Maximum Length:255
The label of the Scope Selection page. -
ServiceName: string
Title:
Service Name
Maximum Length:100
The name of the data service in the scope configuration setup. -
VoName: string
Title:
View Object Name
Maximum Length:100
The name of the view object in the scope configuration setup data.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Scope Configuration Fields
Type:
array
Title:
Scope Configuration Fields
The scope configuration fields resource is used to enable the filtration of the setup data fields for the Functional Setup Manager export process. The resource shows the details of the filter criteria fields.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : publicSectorScopeConfigurations-ScopeConfigurationField-item-response
Type:
Show Source
object
-
AltKeyAttrb: string
Title:
Alternate Key Field
Maximum Length:100
The alternative unique identifier of the scope configuration setup data. -
AltKeyReference: 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: boolean
Title:
Surrogate Field
Maximum Length:1
The attribute to determine whether the scope configuration field setup data has an auto generated unique attribute. -
DeletedFlag: string
Maximum Length:
1
Default Value:N
Indicates the deleted status of the scope configuration field setup. -
FieldLabelString: string
Title:
Label String Key
Maximum Length:160
The attribute label string that is displayed on the Scope Selection page. -
FieldName: string
Title:
Field Name
Maximum Length:100
The attribute name of the scope configuration field setup data. -
FieldType: string
Title:
Field Type
Maximum Length:20
The attribute type of the scope configuration field setup data. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ReturnToFsmFlag: boolean
Title:
Return to Functional Setup Manager
Maximum Length:1
The attribute to determine whether the field value is used as a scope for data filtration. -
ScopeConfigId: string
Title:
Scope Configuration ID
Maximum Length:50
The unique identifier of the scope configuration setup. -
ScopeFieldId: string
Title:
Field ID
Maximum Length:12
The unique identifier of the scope configuration field setup. -
SeedDataLock: integer
(int32)
Default Value:
0
Indicates the seed data lock status of the scope configuration setup.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- ScopeConfigurationField
-
Parameters:
- ScopeConfigId:
$request.path.ScopeConfigId
The scope configuration fields resource is used to enable the filtration of the setup data fields for the Functional Setup Manager export process. The resource shows the details of the filter criteria fields. - ScopeConfigId: