Get one publication map
get
/fscmRestApi/resources/11.13.18.05/publicationMaps/{PublicationMapId}
Request
Path Parameters
-
PublicationMapId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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: string
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: string
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 TopResponse
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.
Root Schema : publicationMaps-item-response
Type:
Show Source
object-
ActiveFlag: boolean
Title:
ActiveMaximum Length:1Value that identifies if the publication map is active or not. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the publication map. -
CreationDate: string
(date-time)
Read Only:
trueDate when the user created the publication map. -
Delimiter: string
Maximum Length:
255Value the identifies the delimiter for the publication map output file. -
DelimiterCode: string
Title:
DelimiterMaximum Length:20Abbreviation that identifies the delimiter for the publication map output file. -
IsSeededFlag: boolean
Read Only:
trueMaximum Length:1Value that indicates whether the publication map is predefined. True indicates that the publication map is predefined. False indicates that it's not predefined. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the user most recently updated the publication map. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the publication map. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OutputFileType: string
Maximum Length:
255Value that identifies the file type for the publication map output file. -
OutputFileTypeCode: string
Title:
File TypeMaximum Length:30Abbreviation that identifies the file type for the publication map output file. -
PublicationMapDescription: string
Title:
DescriptionMaximum Length:3000Description of the publication map. -
PublicationMapId: integer
(int64)
Value that uniquely identifies the publication map.
-
PublicationMapName: string
Title:
Import MapMaximum Length:80Name of the publication map. -
publicationMapTranslations: array
Publication Map Translations
Title:
Publication Map TranslationsA publication map translation lets you translate the publication map name and publication map description to a specified language. -
spokeColumns: array
Spoke Attributes
Title:
Spoke AttributesA spoke system represents spoke system columns in a publication map. Spoke system columns that are mapped with master data columns appear in the publication output.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Publication Map Translations
Type:
arrayTitle:
Publication Map TranslationsA publication map translation lets you translate the publication map name and publication map description to a specified language.
Show Source
Nested Schema : Spoke Attributes
Type:
arrayTitle:
Spoke AttributesA spoke system represents spoke system columns in a publication map. Spoke system columns that are mapped with master data columns appear in the publication output.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : publicationMaps-publicationMapTranslations-item-response
Type:
Show Source
object-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the publication map translation. -
CreationDate: string
(date-time)
Read Only:
trueDate when the user created the publication map translation. -
Language: string
Maximum Length:
4Value that identifies the language in which the publication map translation is created. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the user most recently updated the publication map translation. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the publication map translation. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PublicationMapDescription: string
Maximum Length:
3000Description of the publication map. -
PublicationMapId: integer
(int64)
Value that uniquely identifies the publication map.
-
PublicationMapName: string
Maximum Length:
80Name of the publication map. -
SourceLang: string
Maximum Length:
4Value that identifies the source language from which the publication map translation is created.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : publicationMaps-spokeColumns-item-response
Type:
Show Source
object-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the publication map spoke column. -
CreationDate: string
(date-time)
Read Only:
trueDate when the user created the publication map spoke column. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the user most recently updated the publication map spoke column. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the publication map spoke column. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
masterDataColumns: array
Master Attributes
Title:
Master AttributesMaster data columns mapped with spoke system columns in a publication map. A master data column can be mapped with multiple spoke system columns. -
PublicationMapId: integer
(int64)
Value that uniquely identifies the publication map.
-
Sequence: integer
(int64)
Number that uniquely identifies each row in the mapping table. The sequence number for the first row starts with 10 and gets incremented by 10 for each additional row.
-
SpokeColumnId: integer
(int64)
Value that uniquely identifies the spoke column in a publication map.
-
SpokeSystemColumn: string
Maximum Length:
4000Name of the spoke system column.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Master Attributes
Type:
arrayTitle:
Master AttributesMaster data columns mapped with spoke system columns in a publication map. A master data column can be mapped with multiple spoke system columns.
Show Source
Nested Schema : publicationMaps-spokeColumns-masterDataColumns-item-response
Type:
Show Source
object-
AttributeCode: string
Maximum Length:
120Value that uniquely identifies a master data attribute. -
AttributeGroupCode: string
Maximum Length:
120Value that uniquely identifies the attribute group to which the master data column belongs. -
AttributeGroupName: string
Maximum Length:
255Name of the attribute group to which the master data column belongs. -
AttributeName: string
Maximum Length:
255Name of the master data attribute. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the master data column mapping in a publication map. -
CreationDate: string
(date-time)
Read Only:
trueDate when the user created the master data column mapping in a publication map. -
EntityCode: string
Maximum Length:
30Abbreviation that identifies the object that the master data column belongs to. -
EntityName: string
Maximum Length:
255Name of the object, for example, Item or Structure. -
ExpressionId: integer
(int64)
Value that uniquely identifies the transformation expression.
-
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the user most recently updated the master data column mapping in a publication map. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the master data column mapping in a publication map. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MapMasterDataId: integer
(int64)
Value that uniquely identifies a master data column to spoke column mapping in a publication map.
-
SpokeColumnId: integer
(int64)
Value that uniquely identifies the spoke column in a publication map.
-
transformations: array
Transformation Expressions
Title:
Transformation ExpressionsA transformation can be applied on one for more master attributes and the result can be mapped to a spoke column in a publication map.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Transformation Expressions
Type:
arrayTitle:
Transformation ExpressionsA transformation can be applied on one for more master attributes and the result can be mapped to a spoke column in a publication map.
Show Source
Nested Schema : publicationMaps-spokeColumns-masterDataColumns-transformations-item-response
Type:
Show Source
object-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the transformation expression. -
CreationDate: string
(date-time)
Read Only:
trueDate when the user created the transformation expression. -
ExpressionCode: string
Title:
ExpressionMaximum Length:4000Transformation expression with attribute code. -
ExpressionId: integer
(int64)
Value that uniquely identifies the transformation expression.
-
ExpressionName: string
Maximum Length:
255Transformation expression with attribute name. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the user most recently updated the transformation expression. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the transformation expression. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ReturnType: string
Maximum Length:
40Default Value:NULLHolds the return type of the result of the transformation expression.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- RestLOVDelimiter
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_EGI_PUB_DELIMITERS
The following properties are defined on the LOV link relation:- Source Attribute: Delimiter; Target Attribute: Meaning
- Display Attribute: Meaning, LookupCode
- finder:
- RestLovOutputFileType
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_EGI_PUB_OUTPUT_FILE_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: OutputFileType; Target Attribute: Meaning
- Display Attribute: Meaning, LookupCode
- finder:
- publicationMapTranslations
-
Parameters:
- PublicationMapId:
$request.path.PublicationMapId
A publication map translation lets you translate the publication map name and publication map description to a specified language. - PublicationMapId:
- spokeColumns
-
Parameters:
- PublicationMapId:
$request.path.PublicationMapId
A spoke system represents spoke system columns in a publication map. Spoke system columns that are mapped with master data columns appear in the publication output. - PublicationMapId: