Jump to

• Request
• Response

Get a mapping target

get

/fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingTarget/{MappingTargetUniqID}

Request

Path Parameters

• MappingName(required): string
  The unique name for the mapping. This name will be the parent key of all the children tables. Mandatory user defined field.
• MappingTargetUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- MappingName and TargetType ---for the Mapping Targets resource and used to uniquely identify an instance of Mapping Targets. The client should not generate the hash key value. Instead, the client should query on the Mapping Targets collection resource with a filter on the primary key values in order to navigate to a specific instance of Mapping Targets.
  
  For example: MappingTarget?q=MappingName=<value1>;TargetType=<value2>

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : publicSectorMappingHeaders-MappingTarget-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

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

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

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

  The system generated name of the output file.
• Iszipped: string
  Maximum Length: 1

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

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

  Maximum Length: 64

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

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

  Maximum Length: 50

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

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

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

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

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

  Maximum Length: 30

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

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

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

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

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