Get all publication maps
get
/fscmRestApi/resources/11.13.18.05/publicationMaps
Request
Query Parameters
-
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 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- PrimaryKey Finds publication maps according to the primary key criteria.
Finder Variables- PublicationMapId; integer; Value that uniquely identifies a publication map.
- PrimaryKey Finds publication maps according to the primary key criteria.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- ActiveFlag; boolean; Value that identifies if the publication map is active or not.
- CreatedBy; string; User who created the publication map.
- CreationDate; string; Date when the user created the publication map.
- Delimiter; string; Value the identifies the delimiter for the publication map output file.
- DelimiterCode; string; Abbreviation that identifies the delimiter for the publication map output file.
- LastUpdateDate; string; Date when the user most recently updated the publication map.
- LastUpdatedBy; string; User who most recently updated the publication map.
- OutputFileType; string; Value that identifies the file type for the publication map output file.
- OutputFileTypeCode; string; Abbreviation that identifies the file type for the publication map output file.
- PublicationMapDescription; string; Description of the publication map.
- PublicationMapId; integer; Value that uniquely identifies the publication map.
- PublicationMapName; string; Name of the publication map.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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 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
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicationMaps-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Value that identifies if the publication map is active or not. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the publication map. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user created the publication map. -
Delimiter: string
Maximum Length:
255
Value the identifies the delimiter for the publication map output file. -
DelimiterCode: string
Title:
Delimiter
Maximum Length:20
Abbreviation that identifies the delimiter for the publication map output file. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the publication map. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the publication map. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OutputFileType: string
Maximum Length:
255
Value that identifies the file type for the publication map output file. -
OutputFileTypeCode: string
Title:
File Type
Maximum Length:30
Abbreviation that identifies the file type for the publication map output file. -
PublicationMapDescription: string
Title:
Description
Maximum Length:3000
Description of the publication map. -
PublicationMapId: integer
(int64)
Value that uniquely identifies the publication map.
-
PublicationMapName: string
Title:
Import Map
Maximum Length:80
Name of the publication map. -
publicationMapTranslations: array
Publication Map Translations
Title:
Publication Map Translations
A publication map translation lets you translate the publication map name and publication map description to a specified language. -
spokeColumns: array
Spoke Attributes
Title:
Spoke Attributes
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Publication Map Translations
Type:
array
Title:
Publication Map Translations
A 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:
array
Title:
Spoke Attributes
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.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
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:
true
Maximum Length:64
User who created the publication map translation. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user created the publication map translation. -
Language: string
Maximum Length:
4
Value that identifies the language in which the publication map translation is created. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the publication map translation. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the publication map translation. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PublicationMapDescription: string
Maximum Length:
3000
Description of the publication map. -
PublicationMapId: integer
(int64)
Value that uniquely identifies the publication map.
-
PublicationMapName: string
Maximum Length:
80
Name of the publication map. -
SourceLang: string
Maximum Length:
4
Value that identifies the source language from which the publication map translation is created.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicationMaps-spokeColumns-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the publication map spoke column. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user created the publication map spoke column. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the publication map spoke column. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the publication map spoke column. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
masterDataColumns: array
Master Attributes
Title:
Master Attributes
Master 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:
4000
Name of the spoke system column.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Master Attributes
Type:
array
Title:
Master Attributes
Master 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:
120
Value that uniquely identifies a master data attribute. -
AttributeGroupCode: string
Maximum Length:
120
Value that uniquely identifies the attribute group to which the master data column belongs. -
AttributeGroupName: string
Maximum Length:
255
Name of the attribute group to which the master data column belongs. -
AttributeName: string
Maximum Length:
255
Name of the master data attribute. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the master data column mapping in a publication map. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user created the master data column mapping in a publication map. -
EntityCode: string
Maximum Length:
30
Abbreviation that identifies the object that the master data column belongs to. -
EntityName: string
Maximum Length:
255
Name of the object, for example, Item or Structure. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the master data column mapping in a publication map. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the master data column mapping in a publication map. -
links: array
Links
Title:
Links
The 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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- duplicate
-
Creates a copy of the selected publication map to copy to a new publication map.
- getPublishEntitiesList
-
Gets the list of publication entities from a publication map. This action is triggered from the Manage Spoke System page to retrieve publication entities for the selected publication map.