Jump to

• Request
• Response

Update a mapping source

patch

/fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingSource/{MappingSourceUniqID}

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.
• MappingSourceUniqID: integer
  This is the hash key of the attributes which make up the composite key--- MappingName and SourceType ---for the Mapping Sources resource and used to uniquely identify an instance of Mapping Sources. The client should not generate the hash key value. Instead, the client should query on the Mapping Sources collection resource with a filter on the primary key values in order to navigate to a specific instance of Mapping Sources.
  
  For example: MappingSource?q=MappingName=<value1>;SourceType=<value2>

Body ()

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

Root 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
  Title: Mapping Name

  Maximum Length: 50

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

  The module that owns the row. A module is an entry in the application taxonomy, such as a logical business area. When no module is identified, then the seed data framework does not extract the row as seed data.
• RecordDelimiter(optional): string
  Maximum Length: 10

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

  The endpoint of a REST or SOAP service. Mandatory system generated field.
• SeedDataLock(optional): integer(int32)
  Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.
• SeedDataSource(optional): string
  Maximum Length: 512

  Used by the Seed Data Framework to indicate the source of seed data record. A value of 'BULK_SEED_DATA_SCRIPT' indicates that the record was bulk loaded. Otherwise, specifies the name of the seed data file.
• SourceType(optional): string
  Title: Source Type

  Maximum Length: 30

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

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

  Maximum Length: 50

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

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

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

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.

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

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-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
  Title: Mapping Name

  Maximum Length: 50

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

  The module that owns the row. A module is an entry in the application taxonomy, such as a logical business area. When no module is identified, then the seed data framework does not extract the row as seed data.
• RecordDelimiter(optional): string
  Maximum Length: 10

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

  The endpoint of a REST or SOAP service. Mandatory system generated field.
• SeedDataLock(optional): integer(int32)
  Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.
• SeedDataSource(optional): string
  Maximum Length: 512

  Used by the Seed Data Framework to indicate the source of seed data record. A value of 'BULK_SEED_DATA_SCRIPT' indicates that the record was bulk loaded. Otherwise, specifies the name of the seed data file.
• SourceType(optional): string
  Title: Source Type

  Maximum Length: 30

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

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

  Maximum Length: 50

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

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

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

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.

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

Back to Top