Jump to

• Request
• Response

Create a mapping source

post

/fscmRestApi/resources/11.13.18.05/publicSectorMappingSources

Request

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CsvTemplate: string (byte)
  The CSV file specified by the user that contains the source fields referenced in the data mapping, stored in an alternative field format required for further processing.
• DeletedFlag: string
  Maximum Length: 1

  Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.
• FieldDelimiter: string
  Maximum Length: 10

  The character that separates each field in the source file. For example, a comma.
• Iszipped: string
  Maximum Length: 1

  Indicates whether the source file is in a zipped format. Valid values are Y for zipped, N for not zipped. Default value is N.
• MappingName: string
  Title: Mapping Name

  Maximum Length: 50

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

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

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

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

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

  Maximum Length: 30

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

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

  Maximum Length: 50

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

{
    "type":"object",
    "properties":{
        "FieldDelimiter":{
            "maxLength":"10",
            "type":"string",
            "description":"The character that separates each field in the source file. For example, a comma.",
            "nullable":true
        },
        "RestSoapEndpoint":{
            "maxLength":"128",
            "type":"string",
            "description":"The endpoint of a REST or SOAP service. Mandatory system generated field.",
            "nullable":true
        },
        "SeedDataSource":{
            "maxLength":"512",
            "type":"string",
            "description":"Used by the Seed Data Framework to indicate the source of seed data record. A value of 'BULK_SEED_DATA_SCRIPT' indicates that the record was bulk loaded. Otherwise, specifies the name of the seed data file.",
            "nullable":true
        },
        "SourceType":{
            "title":"Source Type",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the format of the source data specified in the mapping. For example, VO. Mandatory user defined field.",
            "nullable":false
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"1"
            }
        },
        "RecordDelimiter":{
            "maxLength":"10",
            "type":"string",
            "description":"The characters that separate each row of data in the source file. For example, 'END'.",
            "nullable":true
        },
        "TemplateFileName":{
            "maxLength":"50",
            "type":"string",
            "description":"The CSV file specified by the user that contains the source fields referenced in the data mapping.",
            "nullable":true
        },
        "ModuleId":{
            "maxLength":"32",
            "type":"string",
            "description":"The module that owns the row. A module is an entry in the application taxonomy, such as a logical business area. When no module is identified, then the seed data framework does not extract the row as seed data.",
            "nullable":true
        },
        "Iszipped":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the source file is in a zipped format. Valid values are Y for zipped, N for not zipped. Default value is N.",
            "nullable":true
        },
        "CsvTemplate":{
            "type":"string",
            "description":"The CSV file specified by the user that contains the source fields referenced in the data mapping, stored in an alternative field format required for further processing.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.",
            "nullable":true
        },
        "Vo":{
            "title":"Source Name",
            "maxLength":"50",
            "type":"string",
            "description":"The source view to be included in the data mapping. Mandatory user defined field.",
            "nullable":true
        },
        "MappingName":{
            "title":"Mapping Name",
            "maxLength":"50",
            "type":"string",
            "description":"The unique name for the mapping. Mandatory user defined field.",
            "nullable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : publicSectorMappingSources-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date and time when the field transformation was created.
• CsvTemplate: string (byte)
  The CSV file specified by the user that contains the source fields referenced in the data mapping, stored in an alternative field format required for further processing.
• DeletedFlag: string
  Maximum Length: 1

  Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.
• FieldDelimiter: string
  Maximum Length: 10

  The character that separates each field in the source file. For example, a comma.
• Iszipped: string
  Maximum Length: 1

  Indicates whether the source file is in a zipped format. Valid values are Y for zipped, N for not zipped. Default value is N.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

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

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

  Maximum Length: 50

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

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

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

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

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

  Maximum Length: 30

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

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

  Maximum Length: 50

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

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the field transformation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the field transformation was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the field transformation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FieldDelimiter":{
            "maxLength":"10",
            "type":"string",
            "description":"The character that separates each field in the source file. For example, a comma.",
            "nullable":true,
            "x-queryable":true
        },
        "RestSoapEndpoint":{
            "maxLength":"128",
            "type":"string",
            "description":"The endpoint of a REST or SOAP service. Mandatory system generated field.",
            "nullable":true,
            "x-queryable":true
        },
        "SeedDataSource":{
            "maxLength":"512",
            "type":"string",
            "description":"Used by the Seed Data Framework to indicate the source of seed data record. A value of 'BULK_SEED_DATA_SCRIPT' indicates that the record was bulk loaded. Otherwise, specifies the name of the seed data file.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceType":{
            "title":"Source Type",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the format of the source data specified in the mapping. For example, VO. Mandatory user defined field.",
            "nullable":false,
            "x-queryable":true
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "RecordDelimiter":{
            "maxLength":"10",
            "type":"string",
            "description":"The characters that separate each row of data in the source file. For example, 'END'.",
            "nullable":true,
            "x-queryable":true
        },
        "TemplateFileName":{
            "maxLength":"50",
            "type":"string",
            "description":"The CSV file specified by the user that contains the source fields referenced in the data mapping.",
            "nullable":true,
            "x-queryable":true
        },
        "ModuleId":{
            "maxLength":"32",
            "type":"string",
            "description":"The module that owns the row. A module is an entry in the application taxonomy, such as a logical business area. When no module is identified, then the seed data framework does not extract the row as seed data.",
            "nullable":true,
            "x-queryable":true
        },
        "Iszipped":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the source file is in a zipped format. Valid values are Y for zipped, N for not zipped. Default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "CsvTemplate":{
            "type":"string",
            "description":"The CSV file specified by the user that contains the source fields referenced in the data mapping, stored in an alternative field format required for further processing.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "Vo":{
            "title":"Source Name",
            "maxLength":"50",
            "type":"string",
            "description":"The source view to be included in the data mapping. Mandatory user defined field.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MappingName":{
            "title":"Mapping Name",
            "maxLength":"50",
            "type":"string",
            "description":"The unique name for the mapping. Mandatory user defined field.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the field transformation was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

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

Nested Schema : properties

Type: object

Show Source

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

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

Back to Top