Jump to

• Request
• Response

Update a mapping header definition

patch

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

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Path Parameters

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

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorMappingHeaders-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  The unique identifier of the agency associated with the mapping. Mandatory field that is system generated.
• CreatedBy(optional): string
  Maximum Length: 64

  The user who created the mapping.
• CreationDate(optional): string(date-time)
  The date and time when the mapping was created.
• 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.
• Description(optional): string
  Maximum Length: 128

  The description of the mapping. Mandatory user defined field.
• Enabled(optional): string
  Maximum Length: 1

  Indicates whether the mapping is complete and available for use. The default value is false. Mandatory user defined field.
• LastUpdateDate(optional): string(date-time)
  The date and time when the mapping was last updated.
• LastUpdatedBy(optional): string
  Maximum Length: 64

  The user who last updated the mapping.
• links(optional): array Items
  Title: Items

  Link Relations
• MappingDetail(optional): array Mapping Details
  Title: Mapping Details

  The mapping details resources is used to store the mapping pairs between the source and the target.
• MappingName(optional): string
  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(optional): array Mapping Navigators
  Title: Mapping Navigators

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

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

  The mapping targets resource is used to store the definition of the target for Data Format Exchange.
• MappingXml(optional): string
  The mapping XML string (XSLT) used in the transfer framework. System-generated when mapping list is ready.
• 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.
• 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.
• SourceType(optional): string
  Maximum Length: 30

  Indicates the format of the source data specified in the mapping. For example, VO. Mandatory user defined field.
• TargetType(optional): string
  Maximum Length: 30

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

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

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "title":"Items",
    "description":"Link Relations",
    "type":"array",
    "items":{
        "$ref":"#/definitions/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

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

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

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

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

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

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

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

Nested Schema : link

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "href":{
            "title":"hyperlink reference",
            "description":"The URI to the related resource.",
            "type":"string"
        },
        "rel":{
            "title":"relation",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "type":"string"
        }
    }
}

Nested Schema : publicSectorMappingHeaders-MappingDetail-item

Type: object

Show Source

• 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.
• 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.
• 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
  Maximum Length: 50

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

  The field whose value is mapped to the corresponding target field. User defined field.
• TargetColumnName(optional): string
  Maximum Length: 50

  The field containing the result of the field transformation. Mandatory system generated field.
• TransformId(optional): 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(optional): string
  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(optional): string
  Maximum Length: 30

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

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "description":"The user who created the field transformation.",
            "type":"string",
            "maxLength":64
        },
        "CreationDate":{
            "description":"The date and time when the field transformation was created.",
            "type":"string",
            "format":"date-time"
        },
        "DeletedFlag":{
            "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.",
            "type":"string",
            "maxLength":1
        },
        "LastUpdateDate":{
            "description":"The date and time when the field transformation was last updated.",
            "type":"string",
            "format":"date-time"
        },
        "LastUpdatedBy":{
            "description":"The user who last updated the field transformation.",
            "type":"string",
            "maxLength":64
        },
        "MappingName":{
            "description":"The unique name for the mapping. Mandatory user defined field.",
            "type":"string",
            "maxLength":50
        },
        "ModuleId":{
            "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.",
            "type":"string",
            "maxLength":32
        },
        "SeedDataLock":{
            "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.",
            "type":"integer",
            "format":"int32"
        },
        "SeedDataSource":{
            "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.",
            "type":"string",
            "maxLength":512
        },
        "SourceColumnName":{
            "description":"The field whose value is mapped to the corresponding target field. User defined field.",
            "type":"string",
            "maxLength":50
        },
        "TargetColumnName":{
            "description":"The field containing the result of the field transformation. Mandatory system generated field.",
            "type":"string",
            "maxLength":50
        },
        "TransformId":{
            "description":"The unique identifier of the source to target field transformation. Value is mandatory and is system-generated after the target file is specified.",
            "type":"integer",
            "format":"int64"
        },
        "TransformParameter":{
            "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.",
            "type":"string",
            "maxLength":50
        },
        "TransformType":{
            "description":"The type of transformation applied to the target field. User defined field. For example, Constant.",
            "type":"string",
            "maxLength":30
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "title":"Items",
    "description":"Link Relations",
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : publicSectorMappingHeaders-MappingNavigator-item

Type: object

Show Source

• 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.
• 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.
• Disabled(optional): 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(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
  Maximum Length: 50

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

  The type of step message. For example, Confirm and Error.
• 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.
• 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.
• StepId(optional): string
  Maximum Length: 18

  The unique identifier for the mapping step.
• Visited(optional): 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":{
        "CreatedBy":{
            "description":"The user who created the field transformation.",
            "type":"string",
            "maxLength":64
        },
        "CreationDate":{
            "description":"The date and time when the field transformation was created.",
            "type":"string",
            "format":"date-time"
        },
        "DeletedFlag":{
            "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.",
            "type":"string",
            "maxLength":1
        },
        "Disabled":{
            "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.",
            "type":"string",
            "maxLength":1
        },
        "LastUpdateDate":{
            "description":"The date and time when the field transformation was last updated.",
            "type":"string",
            "format":"date-time"
        },
        "LastUpdatedBy":{
            "description":"The user who last updated the field transformation.",
            "type":"string",
            "maxLength":64
        },
        "MappingName":{
            "description":"The unique name for the mapping. Mandatory user defined field.",
            "type":"string",
            "maxLength":50
        },
        "MessageType":{
            "description":"The type of step message. For example, Confirm and Error.",
            "type":"string",
            "maxLength":30
        },
        "ModuleId":{
            "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.",
            "type":"string",
            "maxLength":32
        },
        "SeedDataLock":{
            "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.",
            "type":"integer",
            "format":"int32"
        },
        "SeedDataSource":{
            "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.",
            "type":"string",
            "maxLength":512
        },
        "StepId":{
            "description":"The unique identifier for the mapping step.",
            "type":"string",
            "maxLength":18
        },
        "Visited":{
            "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.",
            "type":"string",
            "maxLength":1
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "title":"Items",
    "description":"Link Relations",
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : publicSectorMappingHeaders-MappingSource-item

Type: object

Show Source

• 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
  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
  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
  Maximum Length: 50

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

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "description":"The user who created the field transformation.",
            "type":"string",
            "maxLength":64
        },
        "CreationDate":{
            "description":"The date and time when the field transformation was created.",
            "type":"string",
            "format":"date-time"
        },
        "CsvTemplate":{
            "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.",
            "type":"string",
            "format":"binary"
        },
        "DeletedFlag":{
            "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.",
            "type":"string",
            "maxLength":1
        },
        "FieldDelimiter":{
            "description":"The character that separates each field in the source file. For example, a comma.",
            "type":"string",
            "maxLength":10
        },
        "Iszipped":{
            "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.",
            "type":"string",
            "maxLength":1
        },
        "LastUpdateDate":{
            "description":"The date and time when the field transformation was last updated.",
            "type":"string",
            "format":"date-time"
        },
        "LastUpdatedBy":{
            "description":"The user who last updated the field transformation.",
            "type":"string",
            "maxLength":64
        },
        "MappingName":{
            "description":"The unique name for the mapping. Mandatory user defined field.",
            "type":"string",
            "maxLength":50
        },
        "ModuleId":{
            "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.",
            "type":"string",
            "maxLength":32
        },
        "RecordDelimiter":{
            "description":"The characters that separate each row of data in the source file. For example, 'END'.",
            "type":"string",
            "maxLength":10
        },
        "RestSoapEndpoint":{
            "description":"The endpoint of a REST or SOAP service. Mandatory system generated field.",
            "type":"string",
            "maxLength":128
        },
        "SeedDataLock":{
            "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.",
            "type":"integer",
            "format":"int32"
        },
        "SeedDataSource":{
            "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.",
            "type":"string",
            "maxLength":512
        },
        "SourceType":{
            "description":"Indicates the format of the source data specified in the mapping. For example, VO. Mandatory user defined field.",
            "type":"string",
            "maxLength":30
        },
        "TemplateFileName":{
            "description":"The CSV file specified by the user that contains the source fields referenced in the data mapping.",
            "type":"string",
            "maxLength":50
        },
        "Vo":{
            "description":"The source view to be included in the data mapping. Mandatory user defined field.",
            "type":"string",
            "maxLength":50
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "title":"Items",
    "description":"Link Relations",
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : publicSectorMappingHeaders-MappingTarget-item

Type: object

Show Source

• 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 will be updated with the results of the field 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 target file. For example, a comma.
• GeneratedFileName(optional): string
  Maximum Length: 50

  The system generated name of the output file.
• 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
  Maximum Length: 50

  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 target 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: 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(optional): string
  Maximum Length: 30

  Indicates the format of the target 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 will be updated with the results of the field mapping. This is also the name referred to in UCM.
• Vo(optional): 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":{
        "CreatedBy":{
            "description":"The user who created the field transformation.",
            "type":"string",
            "maxLength":64
        },
        "CreationDate":{
            "description":"The date and time when the field transformation was created.",
            "type":"string",
            "format":"date-time"
        },
        "CsvTemplate":{
            "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.",
            "type":"string",
            "format":"binary"
        },
        "DeletedFlag":{
            "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.",
            "type":"string",
            "maxLength":1
        },
        "FieldDelimiter":{
            "description":"The character that separates each field in the target file. For example, a comma.",
            "type":"string",
            "maxLength":10
        },
        "GeneratedFileName":{
            "description":"The system generated name of the output file.",
            "type":"string",
            "maxLength":50
        },
        "Iszipped":{
            "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.",
            "type":"string",
            "maxLength":1
        },
        "LastUpdateDate":{
            "description":"The date and time when the field transformation was last updated.",
            "type":"string",
            "format":"date-time"
        },
        "LastUpdatedBy":{
            "description":"The user who last updated the field transformation.",
            "type":"string",
            "maxLength":64
        },
        "MappingName":{
            "description":"Unique name for the mapping. Mandatory user defined field.",
            "type":"string",
            "maxLength":50
        },
        "ModuleId":{
            "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.",
            "type":"string",
            "maxLength":32
        },
        "RecordDelimiter":{
            "description":"The characters that separate each row of data in the target file. For example, 'END'.",
            "type":"string",
            "maxLength":10
        },
        "RestSoapEndpoint":{
            "description":"The endpoint of a REST or SOAP service. Mandatory system generated field.",
            "type":"string",
            "maxLength":128
        },
        "SeedDataLock":{
            "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.",
            "type":"integer",
            "format":"int32"
        },
        "SeedDataSource":{
            "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.",
            "type":"string",
            "maxLength":20
        },
        "TargetType":{
            "description":"Indicates the format of the target data specified in the mapping. For example, VO. Mandatory user defined field.",
            "type":"string",
            "maxLength":30
        },
        "TemplateFileName":{
            "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.",
            "type":"string",
            "maxLength":50
        },
        "Vo":{
            "description":"The target view specified by the user that will be updated with the results of the field mapping.",
            "type":"string",
            "maxLength":50
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "title":"Items",
    "description":"Link Relations",
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorMappingHeaders-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  The unique identifier of the agency associated with the mapping. Mandatory field that is system generated.
• CreatedBy(optional): string
  Maximum Length: 64

  The user who created the mapping.
• CreationDate(optional): string(date-time)
  The date and time when the mapping was created.
• 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.
• Description(optional): string
  Maximum Length: 128

  The description of the mapping. Mandatory user defined field.
• Enabled(optional): string
  Maximum Length: 1

  Indicates whether the mapping is complete and available for use. The default value is false. Mandatory user defined field.
• LastUpdateDate(optional): string(date-time)
  The date and time when the mapping was last updated.
• LastUpdatedBy(optional): string
  Maximum Length: 64

  The user who last updated the mapping.
• links(optional): array Items
  Title: Items

  Link Relations
• MappingDetail(optional): array Mapping Details
  Title: Mapping Details

  The mapping details resources is used to store the mapping pairs between the source and the target.
• MappingName(optional): string
  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(optional): array Mapping Navigators
  Title: Mapping Navigators

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

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

  The mapping targets resource is used to store the definition of the target for Data Format Exchange.
• MappingXml(optional): string
  The mapping XML string (XSLT) used in the transfer framework. System-generated when mapping list is ready.
• 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.
• 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.
• SourceType(optional): string
  Maximum Length: 30

  Indicates the format of the source data specified in the mapping. For example, VO. Mandatory user defined field.
• TargetType(optional): string
  Maximum Length: 30

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

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

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "title":"Items",
    "description":"Link Relations",
    "type":"array",
    "items":{
        "$ref":"#/definitions/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

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

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

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

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

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

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

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

Nested Schema : link

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "href":{
            "title":"hyperlink reference",
            "description":"The URI to the related resource.",
            "type":"string"
        },
        "rel":{
            "title":"relation",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "type":"string"
        }
    }
}

Nested Schema : publicSectorMappingHeaders-MappingDetail-item

Type: object

Show Source

• 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.
• 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.
• 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
  Maximum Length: 50

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

  The field whose value is mapped to the corresponding target field. User defined field.
• TargetColumnName(optional): string
  Maximum Length: 50

  The field containing the result of the field transformation. Mandatory system generated field.
• TransformId(optional): 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(optional): string
  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(optional): string
  Maximum Length: 30

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

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "description":"The user who created the field transformation.",
            "type":"string",
            "maxLength":64
        },
        "CreationDate":{
            "description":"The date and time when the field transformation was created.",
            "type":"string",
            "format":"date-time"
        },
        "DeletedFlag":{
            "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.",
            "type":"string",
            "maxLength":1
        },
        "LastUpdateDate":{
            "description":"The date and time when the field transformation was last updated.",
            "type":"string",
            "format":"date-time"
        },
        "LastUpdatedBy":{
            "description":"The user who last updated the field transformation.",
            "type":"string",
            "maxLength":64
        },
        "MappingName":{
            "description":"The unique name for the mapping. Mandatory user defined field.",
            "type":"string",
            "maxLength":50
        },
        "ModuleId":{
            "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.",
            "type":"string",
            "maxLength":32
        },
        "SeedDataLock":{
            "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.",
            "type":"integer",
            "format":"int32"
        },
        "SeedDataSource":{
            "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.",
            "type":"string",
            "maxLength":512
        },
        "SourceColumnName":{
            "description":"The field whose value is mapped to the corresponding target field. User defined field.",
            "type":"string",
            "maxLength":50
        },
        "TargetColumnName":{
            "description":"The field containing the result of the field transformation. Mandatory system generated field.",
            "type":"string",
            "maxLength":50
        },
        "TransformId":{
            "description":"The unique identifier of the source to target field transformation. Value is mandatory and is system-generated after the target file is specified.",
            "type":"integer",
            "format":"int64"
        },
        "TransformParameter":{
            "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.",
            "type":"string",
            "maxLength":50
        },
        "TransformType":{
            "description":"The type of transformation applied to the target field. User defined field. For example, Constant.",
            "type":"string",
            "maxLength":30
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "title":"Items",
    "description":"Link Relations",
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : publicSectorMappingHeaders-MappingNavigator-item

Type: object

Show Source

• 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.
• 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.
• Disabled(optional): 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(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
  Maximum Length: 50

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

  The type of step message. For example, Confirm and Error.
• 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.
• 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.
• StepId(optional): string
  Maximum Length: 18

  The unique identifier for the mapping step.
• Visited(optional): 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":{
        "CreatedBy":{
            "description":"The user who created the field transformation.",
            "type":"string",
            "maxLength":64
        },
        "CreationDate":{
            "description":"The date and time when the field transformation was created.",
            "type":"string",
            "format":"date-time"
        },
        "DeletedFlag":{
            "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.",
            "type":"string",
            "maxLength":1
        },
        "Disabled":{
            "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.",
            "type":"string",
            "maxLength":1
        },
        "LastUpdateDate":{
            "description":"The date and time when the field transformation was last updated.",
            "type":"string",
            "format":"date-time"
        },
        "LastUpdatedBy":{
            "description":"The user who last updated the field transformation.",
            "type":"string",
            "maxLength":64
        },
        "MappingName":{
            "description":"The unique name for the mapping. Mandatory user defined field.",
            "type":"string",
            "maxLength":50
        },
        "MessageType":{
            "description":"The type of step message. For example, Confirm and Error.",
            "type":"string",
            "maxLength":30
        },
        "ModuleId":{
            "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.",
            "type":"string",
            "maxLength":32
        },
        "SeedDataLock":{
            "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.",
            "type":"integer",
            "format":"int32"
        },
        "SeedDataSource":{
            "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.",
            "type":"string",
            "maxLength":512
        },
        "StepId":{
            "description":"The unique identifier for the mapping step.",
            "type":"string",
            "maxLength":18
        },
        "Visited":{
            "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.",
            "type":"string",
            "maxLength":1
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "title":"Items",
    "description":"Link Relations",
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : publicSectorMappingHeaders-MappingSource-item

Type: object

Show Source

• 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
  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
  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
  Maximum Length: 50

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

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "description":"The user who created the field transformation.",
            "type":"string",
            "maxLength":64
        },
        "CreationDate":{
            "description":"The date and time when the field transformation was created.",
            "type":"string",
            "format":"date-time"
        },
        "CsvTemplate":{
            "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.",
            "type":"string",
            "format":"binary"
        },
        "DeletedFlag":{
            "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.",
            "type":"string",
            "maxLength":1
        },
        "FieldDelimiter":{
            "description":"The character that separates each field in the source file. For example, a comma.",
            "type":"string",
            "maxLength":10
        },
        "Iszipped":{
            "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.",
            "type":"string",
            "maxLength":1
        },
        "LastUpdateDate":{
            "description":"The date and time when the field transformation was last updated.",
            "type":"string",
            "format":"date-time"
        },
        "LastUpdatedBy":{
            "description":"The user who last updated the field transformation.",
            "type":"string",
            "maxLength":64
        },
        "MappingName":{
            "description":"The unique name for the mapping. Mandatory user defined field.",
            "type":"string",
            "maxLength":50
        },
        "ModuleId":{
            "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.",
            "type":"string",
            "maxLength":32
        },
        "RecordDelimiter":{
            "description":"The characters that separate each row of data in the source file. For example, 'END'.",
            "type":"string",
            "maxLength":10
        },
        "RestSoapEndpoint":{
            "description":"The endpoint of a REST or SOAP service. Mandatory system generated field.",
            "type":"string",
            "maxLength":128
        },
        "SeedDataLock":{
            "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.",
            "type":"integer",
            "format":"int32"
        },
        "SeedDataSource":{
            "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.",
            "type":"string",
            "maxLength":512
        },
        "SourceType":{
            "description":"Indicates the format of the source data specified in the mapping. For example, VO. Mandatory user defined field.",
            "type":"string",
            "maxLength":30
        },
        "TemplateFileName":{
            "description":"The CSV file specified by the user that contains the source fields referenced in the data mapping.",
            "type":"string",
            "maxLength":50
        },
        "Vo":{
            "description":"The source view to be included in the data mapping. Mandatory user defined field.",
            "type":"string",
            "maxLength":50
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "title":"Items",
    "description":"Link Relations",
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : publicSectorMappingHeaders-MappingTarget-item

Type: object

Show Source

• 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 will be updated with the results of the field 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 target file. For example, a comma.
• GeneratedFileName(optional): string
  Maximum Length: 50

  The system generated name of the output file.
• 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
  Maximum Length: 50

  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 target 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: 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(optional): string
  Maximum Length: 30

  Indicates the format of the target 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 will be updated with the results of the field mapping. This is also the name referred to in UCM.
• Vo(optional): 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":{
        "CreatedBy":{
            "description":"The user who created the field transformation.",
            "type":"string",
            "maxLength":64
        },
        "CreationDate":{
            "description":"The date and time when the field transformation was created.",
            "type":"string",
            "format":"date-time"
        },
        "CsvTemplate":{
            "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.",
            "type":"string",
            "format":"binary"
        },
        "DeletedFlag":{
            "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.",
            "type":"string",
            "maxLength":1
        },
        "FieldDelimiter":{
            "description":"The character that separates each field in the target file. For example, a comma.",
            "type":"string",
            "maxLength":10
        },
        "GeneratedFileName":{
            "description":"The system generated name of the output file.",
            "type":"string",
            "maxLength":50
        },
        "Iszipped":{
            "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.",
            "type":"string",
            "maxLength":1
        },
        "LastUpdateDate":{
            "description":"The date and time when the field transformation was last updated.",
            "type":"string",
            "format":"date-time"
        },
        "LastUpdatedBy":{
            "description":"The user who last updated the field transformation.",
            "type":"string",
            "maxLength":64
        },
        "MappingName":{
            "description":"Unique name for the mapping. Mandatory user defined field.",
            "type":"string",
            "maxLength":50
        },
        "ModuleId":{
            "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.",
            "type":"string",
            "maxLength":32
        },
        "RecordDelimiter":{
            "description":"The characters that separate each row of data in the target file. For example, 'END'.",
            "type":"string",
            "maxLength":10
        },
        "RestSoapEndpoint":{
            "description":"The endpoint of a REST or SOAP service. Mandatory system generated field.",
            "type":"string",
            "maxLength":128
        },
        "SeedDataLock":{
            "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.",
            "type":"integer",
            "format":"int32"
        },
        "SeedDataSource":{
            "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.",
            "type":"string",
            "maxLength":20
        },
        "TargetType":{
            "description":"Indicates the format of the target data specified in the mapping. For example, VO. Mandatory user defined field.",
            "type":"string",
            "maxLength":30
        },
        "TemplateFileName":{
            "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.",
            "type":"string",
            "maxLength":50
        },
        "Vo":{
            "description":"The target view specified by the user that will be updated with the results of the field mapping.",
            "type":"string",
            "maxLength":50
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "title":"Items",
    "description":"Link Relations",
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Back to Top