Get a mapping source
get
/fscmRestApi/resources/11.13.18.05/publicSectorMappingSources/{publicSectorMappingSourcesUniqID}
Request
Path Parameters
-
publicSectorMappingSourcesUniqID: integer
This is the hash key of the attributes which make up the composite key--- MappingName and SourceType ---for the Mapping Sources resource and used to uniquely identify an instance of Mapping Sources. The client should not generate the hash key value. Instead, the client should query on the Mapping Sources collection resource with a filter on the primary key values in order to navigate to a specific instance of Mapping Sources.
For example: publicSectorMappingSources?q=MappingName=<value1>;SourceType=<value2>
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 : publicSectorMappingSources-item
Type:
Show Source
object
-
CreatedBy(optional):
string
Maximum Length:
64
The user who created the field transformation. -
CreationDate(optional):
string(date-time)
The date and time when the field transformation was created.
-
CsvTemplate(optional):
string(binary)
The CSV file specified by the user that contains the source fields referenced in the data mapping, stored in an alternative field format required for further processing.
-
DeletedFlag(optional):
string
Maximum Length:
1
Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N. -
FieldDelimiter(optional):
string
Maximum Length:
10
The character that separates each field in the source file. For example, a comma. -
Iszipped(optional):
string
Maximum Length:
1
Indicates whether the source file is in a zipped format. Valid values are Y for zipped, N for not zipped. Default value is N. -
LastUpdateDate(optional):
string(date-time)
The date and time when the field transformation was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the field transformation. -
links(optional):
array Items
Title:
Items
Link Relations -
MappingName(optional):
string
Title:
Mapping Name
Maximum Length:50
The unique name for the mapping. Mandatory user defined field. -
ModuleId(optional):
string
Maximum Length:
32
The module that owns the row. A module is an entry in the application taxonomy, such as a logical business area. When no module is identified, then the seed data framework does not extract the row as seed data. -
RecordDelimiter(optional):
string
Maximum Length:
10
The characters that separate each row of data in the source file. For example, 'END'. -
RestSoapEndpoint(optional):
string
Maximum Length:
128
The endpoint of a REST or SOAP service. Mandatory system generated field. -
SeedDataLock(optional):
integer(int32)
Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.
-
SeedDataSource(optional):
string
Maximum Length:
512
Used by the Seed Data Framework to indicate the source of seed data record. A value of 'BULK_SEED_DATA_SCRIPT' indicates that the record was bulk loaded. Otherwise, specifies the name of the seed data file. -
SourceType(optional):
string
Title:
Source Type
Maximum Length:30
Indicates the format of the source data specified in the mapping. For example, VO. Mandatory user defined field. -
TemplateFileName(optional):
string
Maximum Length:
50
The CSV file specified by the user that contains the source fields referenced in the data mapping. -
Vo(optional):
string
Title:
Source Name
Maximum Length:50
The source view to be included in the data mapping. Mandatory user defined field.
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.