1. REST API for Oracle Public Sector Compliance and Regulation Cloud
  2. Tasks
  3. Mapping Headers

Get a mapping header definition

get

/fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}

Request

Path Parameters
  • The unique name for the mapping. This name will be the parent key of all the children tables. Mandatory user defined field.
Query Parameters
  • 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>
  • 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 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Body ()
Root Schema : publicSectorMappingHeaders-item
Type: object
Show Source
Nested Schema : Mapping Details
Type: array
Title: Mapping Details
The sector mapping headers resource is used to store Data Format Exchange header information.
Show Source
Nested Schema : Mapping Navigators
Type: array
Title: Mapping Navigators
The sector mapping headers resource is used to store Data Format Exchange header information.
Show Source
Nested Schema : Mapping Sources
Type: array
Title: Mapping Sources
The sector mapping headers resource is used to store Data Format Exchange header information.
Show Source
Nested Schema : Mapping Targets
Type: array
Title: Mapping Targets
The sector mapping headers resource is used to store Data Format Exchange header information.
Show Source
Nested Schema : publicSectorMappingHeaders-MappingDetail-item
Type: object
Show Source
  • Maximum Length: 64
    The user who created the field transformation.
  • The date and time when the field transformation was created.
  • 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.
  • The date and time when the field transformation was last updated.
  • Maximum Length: 64
    The user who last updated the field transformation.
  • Items
  • Title: Mapping Name
    Maximum Length: 50
    The unique name for the mapping. Mandatory user defined field.
  • Maximum Length: 32
    Used by the Seed Data Framework to indicate the module that owns the row. A module is an entry in Application Taxonomy such as a Logical Business Area. When the MODULE_ID column exists and the owner of the row is not specified, the Seed Data Framework will not extract the row as seed data.
  • 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.
  • 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.
  • Title: Source Field
    Maximum Length: 50
    The field whose value is mapped to the corresponding target field. User defined field.
  • Title: Target Field
    Maximum Length: 50
    The field containing the result of the field transformation. Mandatory system generated field.
  • The unique identifier of the source to target field transformation. Value is mandatory and is system-generated after the target file is specified.
  • Title: Transform Parameter
    Maximum Length: 50
    The parameter used to determine the value of the target field. User defined field. For example, if the target field is Effective Date and the Transform option is Constant, the Transform Parameter might be 01/01/2018.
  • Title: Transform
    Maximum Length: 30
    The type of transformation applied to the target field. User defined field. For example, Constant.
Nested Schema : publicSectorMappingHeaders-MappingNavigator-item
Type: object
Show Source
Nested Schema : publicSectorMappingHeaders-MappingSource-item
Type: object
Show Source
Nested Schema : publicSectorMappingHeaders-MappingTarget-item
Type: object
Show Source
Back to Top