Jump to

• Request
• Response

Update a mapping header definition

patch

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

Request

Path Parameters

• MappingName(required): string
  The unique name for the mapping. This name will be the parent key of all the children tables. Mandatory user defined field.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AgencyId: integer (int32)
  Default Value: 1

  The unique identifier of the agency associated with the mapping. Mandatory field that is system generated.
• DeletedFlag: 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.
• Description: string
  Title: Description

  Maximum Length: 128

  The description of the mapping. Mandatory user defined field.
• Enabled: string
  Title: Enabled

  Maximum Length: 1

  Indicates whether the mapping is complete and available for use. The default value is false. Mandatory user defined field.
• MappingDetail: array Mapping Details
  Title: Mapping Details

  The mapping details resources is used to store the mapping pairs between the source and the target.
• MappingName: string
  Title: Mapping Name

  Maximum Length: 50

  The unique name for the mapping. This name will be the parent key of all the children tables. Mandatory user defined field.
• MappingNavigator: array Mapping Navigators
  Title: Mapping Navigators

  The mapping navigators resource is used to store the status of the setup wizard.
• MappingSource: array Mapping Sources
  Title: Mapping Sources

  The mapping sources resource is used to store the defination of the source for Data Format Exchange.
• MappingTarget: array Mapping Targets
  Title: Mapping Targets

  The mapping targets resource is used to store the definition of the target for Data Format Exchange.
• MappingXml: string (byte)
  The mapping XML string (XSLT) used in the transfer framework. System-generated when mapping list is ready.
• ModuleId: 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.
• SeedDataLock: 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.
• SourceType: 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.
• TargetType: string
  Title: Target Type

  Maximum Length: 30

  Indicates the format of the target data specified in the mapping. For example, CSV. Mandatory user defined field.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":"128",
            "type":"string",
            "description":"The description of the mapping. Mandatory user defined field.",
            "nullable":false
        },
        "MappingXml":{
            "type":"string",
            "description":"The mapping XML string (XSLT) used in the transfer framework. System-generated when mapping list is ready.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency associated with the mapping. Mandatory field that is system generated.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            }
        },
        "SourceType":{
            "title":"Source Type",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the format of the source data specified in the mapping. For example, VO. Mandatory user defined field.",
            "nullable":false
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"1"
            }
        },
        "Enabled":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the mapping is complete and available for use. The default value is false. Mandatory user defined field.",
            "nullable":true
        },
        "ModuleId":{
            "maxLength":"32",
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "MappingDetail":{
            "title":"Mapping Details",
            "type":"array",
            "description":"The mapping details resources is used to store the mapping pairs between the source and the target.",
            "items":{
                "$ref":"#/components/schemas/publicSectorMappingHeaders-MappingDetail-item-patch-request"
            }
        },
        "MappingNavigator":{
            "title":"Mapping Navigators",
            "type":"array",
            "description":"The mapping navigators resource is used to store the status of the setup wizard.",
            "items":{
                "$ref":"#/components/schemas/publicSectorMappingHeaders-MappingNavigator-item-patch-request"
            }
        },
        "TargetType":{
            "title":"Target Type",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the format of the target data specified in the mapping. For example, CSV. Mandatory user defined field.",
            "nullable":false
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.",
            "nullable":true
        },
        "MappingSource":{
            "title":"Mapping Sources",
            "type":"array",
            "description":"The mapping sources resource is used to store the defination of the source for Data Format Exchange.",
            "items":{
                "$ref":"#/components/schemas/publicSectorMappingHeaders-MappingSource-item-patch-request"
            }
        },
        "MappingName":{
            "title":"Mapping Name",
            "maxLength":"50",
            "type":"string",
            "description":"The unique name for the mapping. This name will be the parent key of all the children tables. Mandatory user defined field.",
            "nullable":false
        },
        "MappingTarget":{
            "title":"Mapping Targets",
            "type":"array",
            "description":"The mapping targets resource is used to store the definition of the target for Data Format Exchange.",
            "items":{
                "$ref":"#/components/schemas/publicSectorMappingHeaders-MappingTarget-item-patch-request"
            }
        }
    }
}

Nested Schema : Mapping Details

Type: array

Title: Mapping Details

The mapping details resources is used to store the mapping pairs between the source and the target.

Show Source

• Array of: object schema

{
    "title":"Mapping Details",
    "type":"array",
    "description":"The mapping details resources is used to store the mapping pairs between the source and the target.",
    "items":{
        "$ref":"#/components/schemas/publicSectorMappingHeaders-MappingDetail-item-patch-request"
    }
}

Nested Schema : Mapping Navigators

Type: array

Title: Mapping Navigators

The mapping navigators resource is used to store the status of the setup wizard.

Show Source

• Array of: object schema

{
    "title":"Mapping Navigators",
    "type":"array",
    "description":"The mapping navigators resource is used to store the status of the setup wizard.",
    "items":{
        "$ref":"#/components/schemas/publicSectorMappingHeaders-MappingNavigator-item-patch-request"
    }
}

Nested Schema : Mapping Sources

Type: array

Title: Mapping Sources

The mapping sources resource is used to store the defination of the source for Data Format Exchange.

Show Source

• Array of: object schema

{
    "title":"Mapping Sources",
    "type":"array",
    "description":"The mapping sources resource is used to store the defination of the source for Data Format Exchange.",
    "items":{
        "$ref":"#/components/schemas/publicSectorMappingHeaders-MappingSource-item-patch-request"
    }
}

Nested Schema : Mapping Targets

Type: array

Title: Mapping Targets

The mapping targets resource is used to store the definition of the target for Data Format Exchange.

Show Source

• Array of: object publicSectorMappingHeaders-MappingTarget-item-patch-request

{
    "title":"Mapping Targets",
    "type":"array",
    "description":"The mapping targets resource is used to store the definition of the target for Data Format Exchange.",
    "items":{
        "$ref":"#/components/schemas/publicSectorMappingHeaders-MappingTarget-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• DeletedFlag: 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.
• MappingName: string
  Title: Mapping Name

  Maximum Length: 50

  The unique name for the mapping. Mandatory user defined field.
• ModuleId: string
  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.
• SeedDataLock: 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: 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.
• SourceColumnName: string
  Title: Source Field

  Maximum Length: 50

  The field whose value is mapped to the corresponding target field. User defined field.
• TargetColumnName: string
  Title: Target Field

  Maximum Length: 50

  The field containing the result of the field transformation. Mandatory system generated field.
• TransformId: integer (int64)
  The unique identifier of the source to target field transformation. Value is mandatory and is system-generated after the target file is specified.
• TransformParameter: string
  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.
• TransformType: string
  Title: Transform

  Maximum Length: 30

  The type of transformation applied to the target field. User defined field. For example, Constant.

{
    "type":"object",
    "properties":{
        "TargetColumnName":{
            "title":"Target Field",
            "maxLength":"50",
            "type":"string",
            "description":"The field containing the result of the field transformation. Mandatory system generated field.",
            "nullable":false
        },
        "ModuleId":{
            "maxLength":"32",
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "SeedDataSource":{
            "maxLength":"512",
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "TransformParameter":{
            "title":"Transform Parameter",
            "maxLength":"50",
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"1"
            }
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.",
            "nullable":true
        },
        "MappingName":{
            "title":"Mapping Name",
            "maxLength":"50",
            "type":"string",
            "description":"The unique name for the mapping. Mandatory user defined field.",
            "nullable":false
        },
        "TransformType":{
            "title":"Transform",
            "maxLength":"30",
            "type":"string",
            "description":"The type of transformation applied to the target field. User defined field. For example, Constant.",
            "nullable":true
        },
        "TransformId":{
            "type":"integer",
            "description":"The unique identifier of the source to target field transformation. Value is mandatory and is system-generated after the target file is specified.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "SourceColumnName":{
            "title":"Source Field",
            "maxLength":"50",
            "type":"string",
            "description":"The field whose value is mapped to the corresponding target field. User defined field.",
            "nullable":true
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• DeletedFlag: 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.
• Disabled: string
  Maximum Length: 1

  Indicates whether the step has been disabled preventing the user from accessing the step. Valid values are Y for disabled, N for not disabled. Default value is N.
• MappingName: string
  Maximum Length: 50

  The unique name for the mapping. Mandatory user defined field.
• MessageType: string
  Maximum Length: 30

  The type of step message. For example, Confirm and Error.
• ModuleId: 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.
• SeedDataLock: 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: string
  Maximum Length: 512

  Default Value: NVL(SYS_CONTEXT('FND_SDF_CTX', 'SDFFILE'), 'SDFFILE')

  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.
• StepId: string
  Maximum Length: 18

  The unique identifier for the mapping step.
• Visited: string
  Maximum Length: 1

  Indicates whether the step has been visited by the user. Valid values are Y for visited, N for not visited. Default value is N.

{
    "type":"object",
    "properties":{
        "Visited":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the step has been visited by the user. Valid values are Y for visited, N for not visited. Default value is N.",
            "nullable":true
        },
        "ModuleId":{
            "maxLength":"32",
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "StepId":{
            "maxLength":"18",
            "type":"string",
            "description":"The unique identifier for the mapping step.",
            "nullable":false
        },
        "SeedDataSource":{
            "maxLength":"512",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "default":"NVL(SYS_CONTEXT('FND_SDF_CTX', 'SDFFILE'), 'SDFFILE')"
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"1"
            }
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.",
            "nullable":true
        },
        "MappingName":{
            "maxLength":"50",
            "type":"string",
            "description":"The unique name for the mapping. Mandatory user defined field.",
            "nullable":false
        },
        "Disabled":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the step has been disabled preventing the user from accessing the step. Valid values are Y for disabled, N for not disabled. Default value is N.",
            "nullable":true
        },
        "MessageType":{
            "maxLength":"30",
            "type":"string",
            "description":"The type of step message. For example, Confirm and Error.",
            "nullable":true
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• CsvTemplate: string (byte)
  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: 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: string
  Maximum Length: 10

  The character that separates each field in the source file. For example, a comma.
• Iszipped: 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.
• MappingName: string
  Title: Mapping Name

  Maximum Length: 50

  The unique name for the mapping. Mandatory user defined field.
• ModuleId: 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: string
  Maximum Length: 10

  The characters that separate each row of data in the source file. For example, 'END'.
• RestSoapEndpoint: string
  Maximum Length: 128

  The endpoint of a REST or SOAP service. Mandatory system generated field.
• SeedDataLock: 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: 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: 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: string
  Maximum Length: 50

  The CSV file specified by the user that contains the source fields referenced in the data mapping.
• Vo: string
  Title: Source Name

  Maximum Length: 50

  The source view to be included in the data mapping. Mandatory user defined field.

{
    "type":"object",
    "properties":{
        "FieldDelimiter":{
            "maxLength":"10",
            "type":"string",
            "description":"The character that separates each field in the source file. For example, a comma.",
            "nullable":true
        },
        "RestSoapEndpoint":{
            "maxLength":"128",
            "type":"string",
            "description":"The endpoint of a REST or SOAP service. Mandatory system generated field.",
            "nullable":true
        },
        "SeedDataSource":{
            "maxLength":"512",
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "SourceType":{
            "title":"Source Type",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the format of the source data specified in the mapping. For example, VO. Mandatory user defined field.",
            "nullable":false
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"1"
            }
        },
        "RecordDelimiter":{
            "maxLength":"10",
            "type":"string",
            "description":"The characters that separate each row of data in the source file. For example, 'END'.",
            "nullable":true
        },
        "TemplateFileName":{
            "maxLength":"50",
            "type":"string",
            "description":"The CSV file specified by the user that contains the source fields referenced in the data mapping.",
            "nullable":true
        },
        "ModuleId":{
            "maxLength":"32",
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "Iszipped":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the source file is in a zipped format. Valid values are Y for zipped, N for not zipped. Default value is N.",
            "nullable":true
        },
        "CsvTemplate":{
            "type":"string",
            "description":"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.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.",
            "nullable":true
        },
        "Vo":{
            "title":"Source Name",
            "maxLength":"50",
            "type":"string",
            "description":"The source view to be included in the data mapping. Mandatory user defined field.",
            "nullable":true
        },
        "MappingName":{
            "title":"Mapping Name",
            "maxLength":"50",
            "type":"string",
            "description":"The unique name for the mapping. Mandatory user defined field.",
            "nullable":false
        }
    }
}

Nested Schema : publicSectorMappingHeaders-MappingTarget-item-patch-request

Type: object

Show Source

• CsvTemplate: string (byte)
  The CSV file specified by the user that will be updated with the results of the field mapping, stored in an alternative field format required for further processing.
• DeletedFlag: 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: string
  Maximum Length: 10

  The character that separates each field in the target file. For example, a comma.
• GeneratedFileName: string
  Maximum Length: 50

  The system generated name of the output file.
• Iszipped: 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.
• MappingName: string
  Title: Mapping Name

  Maximum Length: 50

  Unique name for the mapping. Mandatory user defined field.
• ModuleId: 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: string
  Maximum Length: 10

  The characters that separate each row of data in the target file. For example, 'END'.
• RestSoapEndpoint: string
  Maximum Length: 128

  The endpoint of a REST or SOAP service. Mandatory system generated field.
• SeedDataLock: 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: string
  Maximum Length: 20

  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.
• TargetType: string
  Title: Target Type

  Maximum Length: 30

  Indicates the format of the target data specified in the mapping. For example, VO. Mandatory user defined field.
• TemplateFileName: string
  Maximum Length: 50

  The CSV file specified by the user that will be updated with the results of the field mapping. This is also the name referred to in UCM.
• Vo: string
  Maximum Length: 50

  The target view specified by the user that will be updated with the results of the field mapping.

{
    "type":"object",
    "properties":{
        "FieldDelimiter":{
            "maxLength":"10",
            "type":"string",
            "description":"The character that separates each field in the target file. For example, a comma.",
            "nullable":true
        },
        "RestSoapEndpoint":{
            "maxLength":"128",
            "type":"string",
            "description":"The endpoint of a REST or SOAP service. Mandatory system generated field.",
            "nullable":true
        },
        "GeneratedFileName":{
            "maxLength":"50",
            "type":"string",
            "description":"The system generated name of the output file.",
            "nullable":true
        },
        "SeedDataSource":{
            "maxLength":"20",
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"1"
            }
        },
        "RecordDelimiter":{
            "maxLength":"10",
            "type":"string",
            "description":"The characters that separate each row of data in the target file. For example, 'END'.",
            "nullable":true
        },
        "TemplateFileName":{
            "maxLength":"50",
            "type":"string",
            "description":"The CSV file specified by the user that will be updated with the results of the field mapping. This is also the name referred to in UCM.",
            "nullable":true
        },
        "ModuleId":{
            "maxLength":"32",
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "Iszipped":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the source file is in a zipped format. Valid values are Y for zipped, N for not zipped. Default value is N.",
            "nullable":true
        },
        "TargetType":{
            "title":"Target Type",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the format of the target data specified in the mapping. For example, VO. Mandatory user defined field.",
            "nullable":false
        },
        "CsvTemplate":{
            "type":"string",
            "description":"The CSV file specified by the user that will be updated with the results of the field mapping, stored in an alternative field format required for further processing.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.",
            "nullable":true
        },
        "Vo":{
            "maxLength":"50",
            "type":"string",
            "description":"The target view specified by the user that will be updated with the results of the field mapping.",
            "nullable":true
        },
        "MappingName":{
            "title":"Mapping Name",
            "maxLength":"50",
            "type":"string",
            "description":"Unique name for the mapping. Mandatory user defined field.",
            "nullable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : publicSectorMappingHeaders-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Default Value: 1

  The unique identifier of the agency associated with the mapping. Mandatory field that is system generated.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the mapping.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the mapping was created.
• DeletedFlag: 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.
• Description: string
  Title: Description

  Maximum Length: 128

  The description of the mapping. Mandatory user defined field.
• Enabled: string
  Title: Enabled

  Maximum Length: 1

  Indicates whether the mapping is complete and available for use. The default value is false. Mandatory user defined field.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the mapping was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the mapping.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MappingDetail: array Mapping Details
  Title: Mapping Details

  The mapping details resources is used to store the mapping pairs between the source and the target.
• MappingName: string
  Title: Mapping Name

  Maximum Length: 50

  The unique name for the mapping. This name will be the parent key of all the children tables. Mandatory user defined field.
• MappingNavigator: array Mapping Navigators
  Title: Mapping Navigators

  The mapping navigators resource is used to store the status of the setup wizard.
• MappingSource: array Mapping Sources
  Title: Mapping Sources

  The mapping sources resource is used to store the defination of the source for Data Format Exchange.
• MappingTarget: array Mapping Targets
  Title: Mapping Targets

  The mapping targets resource is used to store the definition of the target for Data Format Exchange.
• MappingXml: string (byte)
  The mapping XML string (XSLT) used in the transfer framework. System-generated when mapping list is ready.
• ModuleId: 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.
• SeedDataLock: 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.
• SourceType: 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.
• TargetType: string
  Title: Target Type

  Maximum Length: 30

  Indicates the format of the target data specified in the mapping. For example, CSV. Mandatory user defined field.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the mapping.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the mapping was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the mapping.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"128",
            "type":"string",
            "description":"The description of the mapping. Mandatory user defined field.",
            "nullable":false,
            "x-queryable":true
        },
        "MappingXml":{
            "type":"string",
            "description":"The mapping XML string (XSLT) used in the transfer framework. System-generated when mapping list is ready.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency associated with the mapping. Mandatory field that is system generated.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "SourceType":{
            "title":"Source Type",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the format of the source data specified in the mapping. For example, VO. Mandatory user defined field.",
            "nullable":false,
            "x-queryable":true
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "Enabled":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the mapping is complete and available for use. The default value is false. Mandatory user defined field.",
            "nullable":true,
            "x-queryable":true
        },
        "ModuleId":{
            "maxLength":"32",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "MappingDetail":{
            "title":"Mapping Details",
            "type":"array",
            "description":"The mapping details resources is used to store the mapping pairs between the source and the target.",
            "items":{
                "$ref":"#/components/schemas/publicSectorMappingHeaders-MappingDetail-item-response"
            }
        },
        "MappingNavigator":{
            "title":"Mapping Navigators",
            "type":"array",
            "description":"The mapping navigators resource is used to store the status of the setup wizard.",
            "items":{
                "$ref":"#/components/schemas/publicSectorMappingHeaders-MappingNavigator-item-response"
            }
        },
        "TargetType":{
            "title":"Target Type",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the format of the target data specified in the mapping. For example, CSV. Mandatory user defined field.",
            "nullable":false,
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MappingSource":{
            "title":"Mapping Sources",
            "type":"array",
            "description":"The mapping sources resource is used to store the defination of the source for Data Format Exchange.",
            "items":{
                "$ref":"#/components/schemas/publicSectorMappingHeaders-MappingSource-item-response"
            }
        },
        "MappingName":{
            "title":"Mapping Name",
            "maxLength":"50",
            "type":"string",
            "description":"The unique name for the mapping. This name will be the parent key of all the children tables. Mandatory user defined field.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the mapping was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MappingTarget":{
            "title":"Mapping Targets",
            "type":"array",
            "description":"The mapping targets resource is used to store the definition of the target for Data Format Exchange.",
            "items":{
                "$ref":"#/components/schemas/publicSectorMappingHeaders-MappingTarget-item-response"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Mapping Details

Type: array

Title: Mapping Details

The mapping details resources is used to store the mapping pairs between the source and the target.

Show Source

• Array of: object publicSectorMappingHeaders-MappingDetail-item-response

{
    "title":"Mapping Details",
    "type":"array",
    "description":"The mapping details resources is used to store the mapping pairs between the source and the target.",
    "items":{
        "$ref":"#/components/schemas/publicSectorMappingHeaders-MappingDetail-item-response"
    }
}

Nested Schema : Mapping Navigators

Type: array

Title: Mapping Navigators

The mapping navigators resource is used to store the status of the setup wizard.

Show Source

• Array of: object publicSectorMappingHeaders-MappingNavigator-item-response

{
    "title":"Mapping Navigators",
    "type":"array",
    "description":"The mapping navigators resource is used to store the status of the setup wizard.",
    "items":{
        "$ref":"#/components/schemas/publicSectorMappingHeaders-MappingNavigator-item-response"
    }
}

Nested Schema : Mapping Sources

Type: array

Title: Mapping Sources

The mapping sources resource is used to store the defination of the source for Data Format Exchange.

Show Source

• Array of: object publicSectorMappingHeaders-MappingSource-item-response

{
    "title":"Mapping Sources",
    "type":"array",
    "description":"The mapping sources resource is used to store the defination of the source for Data Format Exchange.",
    "items":{
        "$ref":"#/components/schemas/publicSectorMappingHeaders-MappingSource-item-response"
    }
}

Nested Schema : Mapping Targets

Type: array

Title: Mapping Targets

The mapping targets resource is used to store the definition of the target for Data Format Exchange.

Show Source

• Array of: object publicSectorMappingHeaders-MappingTarget-item-response

{
    "title":"Mapping Targets",
    "type":"array",
    "description":"The mapping targets resource is used to store the definition of the target for Data Format Exchange.",
    "items":{
        "$ref":"#/components/schemas/publicSectorMappingHeaders-MappingTarget-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : publicSectorMappingHeaders-MappingDetail-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the field transformation.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the field transformation was created.
• DeletedFlag: 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.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the field transformation was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the field transformation.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MappingName: string
  Title: Mapping Name

  Maximum Length: 50

  The unique name for the mapping. Mandatory user defined field.
• ModuleId: string
  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.
• SeedDataLock: 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: 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.
• SourceColumnName: string
  Title: Source Field

  Maximum Length: 50

  The field whose value is mapped to the corresponding target field. User defined field.
• TargetColumnName: string
  Title: Target Field

  Maximum Length: 50

  The field containing the result of the field transformation. Mandatory system generated field.
• TransformId: integer (int64)
  The unique identifier of the source to target field transformation. Value is mandatory and is system-generated after the target file is specified.
• TransformParameter: string
  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.
• TransformType: string
  Title: Transform

  Maximum Length: 30

  The type of transformation applied to the target field. User defined field. For example, Constant.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the field transformation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the field transformation was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the field transformation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SeedDataSource":{
            "maxLength":"512",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "TransformParameter":{
            "title":"Transform Parameter",
            "maxLength":"50",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "TransformType":{
            "title":"Transform",
            "maxLength":"30",
            "type":"string",
            "description":"The type of transformation applied to the target field. User defined field. For example, Constant.",
            "nullable":true,
            "x-queryable":true
        },
        "TargetColumnName":{
            "title":"Target Field",
            "maxLength":"50",
            "type":"string",
            "description":"The field containing the result of the field transformation. Mandatory system generated field.",
            "nullable":false,
            "x-queryable":true
        },
        "ModuleId":{
            "maxLength":"32",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MappingName":{
            "title":"Mapping Name",
            "maxLength":"50",
            "type":"string",
            "description":"The unique name for the mapping. Mandatory user defined field.",
            "nullable":false,
            "x-queryable":true
        },
        "TransformId":{
            "type":"integer",
            "description":"The unique identifier of the source to target field transformation. Value is mandatory and is system-generated after the target file is specified.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SourceColumnName":{
            "title":"Source Field",
            "maxLength":"50",
            "type":"string",
            "description":"The field whose value is mapped to the corresponding target field. User defined field.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the field transformation was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : publicSectorMappingHeaders-MappingNavigator-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the field transformation.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the field transformation was created.
• DeletedFlag: 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.
• Disabled: string
  Maximum Length: 1

  Indicates whether the step has been disabled preventing the user from accessing the step. Valid values are Y for disabled, N for not disabled. Default value is N.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the field transformation was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the field transformation.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MappingName: string
  Maximum Length: 50

  The unique name for the mapping. Mandatory user defined field.
• MessageType: string
  Maximum Length: 30

  The type of step message. For example, Confirm and Error.
• ModuleId: 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.
• SeedDataLock: 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: string
  Maximum Length: 512

  Default Value: NVL(SYS_CONTEXT('FND_SDF_CTX', 'SDFFILE'), 'SDFFILE')

  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.
• StepId: string
  Maximum Length: 18

  The unique identifier for the mapping step.
• Visited: string
  Maximum Length: 1

  Indicates whether the step has been visited by the user. Valid values are Y for visited, N for not visited. Default value is N.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the field transformation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Visited":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the step has been visited by the user. Valid values are Y for visited, N for not visited. Default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the field transformation was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the field transformation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SeedDataSource":{
            "maxLength":"512",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "default":"NVL(SYS_CONTEXT('FND_SDF_CTX', 'SDFFILE'), 'SDFFILE')",
            "x-queryable":true
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "ModuleId":{
            "maxLength":"32",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "StepId":{
            "maxLength":"18",
            "type":"string",
            "description":"The unique identifier for the mapping step.",
            "nullable":false,
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MappingName":{
            "maxLength":"50",
            "type":"string",
            "description":"The unique name for the mapping. Mandatory user defined field.",
            "nullable":false,
            "x-queryable":true
        },
        "Disabled":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the step has been disabled preventing the user from accessing the step. Valid values are Y for disabled, N for not disabled. Default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "MessageType":{
            "maxLength":"30",
            "type":"string",
            "description":"The type of step message. For example, Confirm and Error.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the field transformation was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : publicSectorMappingHeaders-MappingSource-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the field transformation.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the field transformation was created.
• CsvTemplate: string (byte)
  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: 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: string
  Maximum Length: 10

  The character that separates each field in the source file. For example, a comma.
• Iszipped: 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: string (date-time)
  Read Only: true

  The date and time when the field transformation was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the field transformation.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MappingName: string
  Title: Mapping Name

  Maximum Length: 50

  The unique name for the mapping. Mandatory user defined field.
• ModuleId: 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: string
  Maximum Length: 10

  The characters that separate each row of data in the source file. For example, 'END'.
• RestSoapEndpoint: string
  Maximum Length: 128

  The endpoint of a REST or SOAP service. Mandatory system generated field.
• SeedDataLock: 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: 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: 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: string
  Maximum Length: 50

  The CSV file specified by the user that contains the source fields referenced in the data mapping.
• Vo: string
  Title: Source Name

  Maximum Length: 50

  The source view to be included in the data mapping. Mandatory user defined field.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the field transformation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the field transformation was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the field transformation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FieldDelimiter":{
            "maxLength":"10",
            "type":"string",
            "description":"The character that separates each field in the source file. For example, a comma.",
            "nullable":true,
            "x-queryable":true
        },
        "RestSoapEndpoint":{
            "maxLength":"128",
            "type":"string",
            "description":"The endpoint of a REST or SOAP service. Mandatory system generated field.",
            "nullable":true,
            "x-queryable":true
        },
        "SeedDataSource":{
            "maxLength":"512",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceType":{
            "title":"Source Type",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the format of the source data specified in the mapping. For example, VO. Mandatory user defined field.",
            "nullable":false,
            "x-queryable":true
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "RecordDelimiter":{
            "maxLength":"10",
            "type":"string",
            "description":"The characters that separate each row of data in the source file. For example, 'END'.",
            "nullable":true,
            "x-queryable":true
        },
        "TemplateFileName":{
            "maxLength":"50",
            "type":"string",
            "description":"The CSV file specified by the user that contains the source fields referenced in the data mapping.",
            "nullable":true,
            "x-queryable":true
        },
        "ModuleId":{
            "maxLength":"32",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "Iszipped":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the source file is in a zipped format. Valid values are Y for zipped, N for not zipped. Default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "CsvTemplate":{
            "type":"string",
            "description":"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.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "Vo":{
            "title":"Source Name",
            "maxLength":"50",
            "type":"string",
            "description":"The source view to be included in the data mapping. Mandatory user defined field.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MappingName":{
            "title":"Mapping Name",
            "maxLength":"50",
            "type":"string",
            "description":"The unique name for the mapping. Mandatory user defined field.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the field transformation was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : publicSectorMappingHeaders-MappingTarget-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the field transformation.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the field transformation was created.
• CsvTemplate: string (byte)
  The CSV file specified by the user that will be updated with the results of the field mapping, stored in an alternative field format required for further processing.
• DeletedFlag: 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: string
  Maximum Length: 10

  The character that separates each field in the target file. For example, a comma.
• GeneratedFileName: string
  Maximum Length: 50

  The system generated name of the output file.
• Iszipped: 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: string (date-time)
  Read Only: true

  The date and time when the field transformation was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the field transformation.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MappingName: string
  Title: Mapping Name

  Maximum Length: 50

  Unique name for the mapping. Mandatory user defined field.
• ModuleId: 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: string
  Maximum Length: 10

  The characters that separate each row of data in the target file. For example, 'END'.
• RestSoapEndpoint: string
  Maximum Length: 128

  The endpoint of a REST or SOAP service. Mandatory system generated field.
• SeedDataLock: 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: string
  Maximum Length: 20

  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.
• TargetType: string
  Title: Target Type

  Maximum Length: 30

  Indicates the format of the target data specified in the mapping. For example, VO. Mandatory user defined field.
• TemplateFileName: string
  Maximum Length: 50

  The CSV file specified by the user that will be updated with the results of the field mapping. This is also the name referred to in UCM.
• Vo: string
  Maximum Length: 50

  The target view specified by the user that will be updated with the results of the field mapping.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the field transformation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the field transformation was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the field transformation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FieldDelimiter":{
            "maxLength":"10",
            "type":"string",
            "description":"The character that separates each field in the target file. For example, a comma.",
            "nullable":true,
            "x-queryable":true
        },
        "RestSoapEndpoint":{
            "maxLength":"128",
            "type":"string",
            "description":"The endpoint of a REST or SOAP service. Mandatory system generated field.",
            "nullable":true,
            "x-queryable":true
        },
        "GeneratedFileName":{
            "maxLength":"50",
            "type":"string",
            "description":"The system generated name of the output file.",
            "nullable":true,
            "x-queryable":true
        },
        "SeedDataSource":{
            "maxLength":"20",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "RecordDelimiter":{
            "maxLength":"10",
            "type":"string",
            "description":"The characters that separate each row of data in the target file. For example, 'END'.",
            "nullable":true,
            "x-queryable":true
        },
        "TemplateFileName":{
            "maxLength":"50",
            "type":"string",
            "description":"The CSV file specified by the user that will be updated with the results of the field mapping. This is also the name referred to in UCM.",
            "nullable":true,
            "x-queryable":true
        },
        "ModuleId":{
            "maxLength":"32",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "Iszipped":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the source file is in a zipped format. Valid values are Y for zipped, N for not zipped. Default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "TargetType":{
            "title":"Target Type",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the format of the target data specified in the mapping. For example, VO. Mandatory user defined field.",
            "nullable":false,
            "x-queryable":true
        },
        "CsvTemplate":{
            "type":"string",
            "description":"The CSV file specified by the user that will be updated with the results of the field mapping, stored in an alternative field format required for further processing.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "Vo":{
            "maxLength":"50",
            "type":"string",
            "description":"The target view specified by the user that will be updated with the results of the field mapping.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MappingName":{
            "title":"Mapping Name",
            "maxLength":"50",
            "type":"string",
            "description":"Unique name for the mapping. Mandatory user defined field.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the field transformation was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

MappingDetail

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingDetail

Parameters:

• MappingName: $request.path.MappingName

The mapping details resources is used to store the mapping pairs between the source and the target.

MappingNavigator

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingNavigator

Parameters:

• MappingName: $request.path.MappingName

The mapping navigators resource is used to store the status of the setup wizard.

MappingSource

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingSource

Parameters:

• MappingName: $request.path.MappingName

The mapping sources resource is used to store the defination of the source for Data Format Exchange.

MappingTarget

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingTarget

Parameters:

• MappingName: $request.path.MappingName

The mapping targets resource is used to store the definition of the target for Data Format Exchange.

Back to Top