Jump to

• Request
• Response

Create publication maps

post

/fscmRestApi/resources/11.13.18.05/publicationMaps

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

• ActiveFlag(required): boolean
  Title: Active

  Maximum Length: 1

  Value that identifies if the publication map is active or not.
• 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.
• OutputFileType: string
  Maximum Length: 255

  Value that identifies the file type for the publication map output file.
• OutputFileTypeCode(required): 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(required): 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.

{
    "required":[
        "ActiveFlag",
        "OutputFileTypeCode",
        "PublicationMapName"
    ],
    "type":"object",
    "properties":{
        "OutputFileType":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that identifies the file type for the publication map output file.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DelimiterCode":{
            "title":"Delimiter",
            "maxLength":"20",
            "type":"string",
            "description":"Abbreviation that identifies the delimiter for the publication map output file.",
            "nullable":true
        },
        "Delimiter":{
            "maxLength":"255",
            "type":"string",
            "description":"Value the identifies the delimiter for the publication map output file.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PublicationMapId":{
            "type":"integer",
            "description":"Value that uniquely identifies the publication map.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "spokeColumns":{
            "title":"Spoke Attributes",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/publicationMaps-spokeColumns-item-post-request"
            }
        },
        "PublicationMapDescription":{
            "title":"Description",
            "maxLength":"3000",
            "type":"string",
            "description":"Description of the publication map.",
            "nullable":true
        },
        "publicationMapTranslations":{
            "title":"Publication Map Translations",
            "type":"array",
            "description":"A publication map translation lets you translate the publication map name and publication map description to a specified language.",
            "items":{
                "$ref":"#/components/schemas/publicationMaps-publicationMapTranslations-item-post-request"
            }
        },
        "PublicationMapName":{
            "title":"Import Map",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the publication map.",
            "nullable":false
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":"1",
            "type":"boolean",
            "description":"Value that identifies if the publication map is active or not.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OutputFileTypeCode":{
            "title":"File Type",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the file type for the publication map output file.",
            "nullable":false
        }
    }
}

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

• Array of: object schema

{
    "title":"Publication Map Translations",
    "type":"array",
    "description":"A publication map translation lets you translate the publication map name and publication map description to a specified language.",
    "items":{
        "$ref":"#/components/schemas/publicationMaps-publicationMapTranslations-item-post-request"
    }
}

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

• Array of: object publicationMaps-spokeColumns-item-post-request

{
    "title":"Spoke Attributes",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/publicationMaps-spokeColumns-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• Language: string
  Maximum Length: 4

  Value that identifies the language in which the publication map translation is created.
• 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.

{
    "type":"object",
    "properties":{
        "PublicationMapDescription":{
            "maxLength":"3000",
            "type":"string",
            "description":"Description of the publication map.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "Language":{
            "maxLength":"4",
            "type":"string",
            "description":"Value that identifies the language in which the publication map translation is created.",
            "nullable":false
        },
        "PublicationMapName":{
            "maxLength":"80",
            "type":"string",
            "description":"Name of the publication map.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "PublicationMapId":{
            "type":"integer",
            "description":"Value that uniquely identifies the publication map.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "SourceLang":{
            "maxLength":"4",
            "type":"string",
            "description":"Value that identifies the source language from which the publication map translation is created.",
            "nullable":true
        }
    }
}

Nested Schema : publicationMaps-spokeColumns-item-post-request

Type: object

Show Source

• 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(required): 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(required): string
  Maximum Length: 4000

  Name of the spoke system column.

{
    "required":[
        "PublicationMapId",
        "SpokeSystemColumn"
    ],
    "type":"object",
    "properties":{
        "masterDataColumns":{
            "title":"Master Attributes",
            "type":"array",
            "description":"Master data columns mapped with spoke system columns in a publication map. A master data column can be mapped with multiple spoke system columns.",
            "items":{
                "$ref":"#/components/schemas/publicationMaps-spokeColumns-masterDataColumns-item-post-request"
            }
        },
        "Sequence":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "SpokeColumnId":{
            "type":"integer",
            "description":"Value that uniquely identifies the spoke column in a publication map.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PublicationMapId":{
            "type":"integer",
            "description":"Value that uniquely identifies the publication map.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "SpokeSystemColumn":{
            "maxLength":"4000",
            "type":"string",
            "description":"Name of the spoke system column.",
            "nullable":false
        }
    }
}

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

• Array of: object publicationMaps-spokeColumns-masterDataColumns-item-post-request

{
    "title":"Master Attributes",
    "type":"array",
    "description":"Master data columns mapped with spoke system columns in a publication map. A master data column can be mapped with multiple spoke system columns.",
    "items":{
        "$ref":"#/components/schemas/publicationMaps-spokeColumns-masterDataColumns-item-post-request"
    }
}

Nested Schema : publicationMaps-spokeColumns-masterDataColumns-item-post-request

Type: object

Show Source

• 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.
• 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.
• 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.

{
    "type":"object",
    "properties":{
        "AttributeCode":{
            "maxLength":"120",
            "type":"string",
            "description":"Value that uniquely identifies a master data attribute.",
            "nullable":true
        },
        "AttributeGroupCode":{
            "maxLength":"120",
            "type":"string",
            "description":"Value that uniquely identifies the attribute group to which the master data column belongs.",
            "nullable":false
        },
        "EntityName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the object, for example, Item or Structure.",
            "nullable":true
        },
        "EntityCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the object that the master data column belongs to.",
            "nullable":false
        },
        "MapMasterDataId":{
            "type":"integer",
            "description":"Value that uniquely identifies a master data column to spoke column mapping in a publication map.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AttributeGroupName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the attribute group to which the master data column belongs.",
            "nullable":true
        },
        "AttributeName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the master data attribute.",
            "nullable":true
        },
        "SpokeColumnId":{
            "type":"integer",
            "description":"Value that uniquely identifies the spoke column in a publication map.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

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 : publicationMaps-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the publication map.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the publication map.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OutputFileType":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that identifies the file type for the publication map output file.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the publication map.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DelimiterCode":{
            "title":"Delimiter",
            "maxLength":"20",
            "type":"string",
            "description":"Abbreviation that identifies the delimiter for the publication map output file.",
            "nullable":true,
            "x-queryable":true
        },
        "Delimiter":{
            "maxLength":"255",
            "type":"string",
            "description":"Value the identifies the delimiter for the publication map output file.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "spokeColumns":{
            "title":"Spoke Attributes",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/publicationMaps-spokeColumns-item-response"
            }
        },
        "publicationMapTranslations":{
            "title":"Publication Map Translations",
            "type":"array",
            "description":"A publication map translation lets you translate the publication map name and publication map description to a specified language.",
            "items":{
                "$ref":"#/components/schemas/publicationMaps-publicationMapTranslations-item-response"
            }
        },
        "PublicationMapName":{
            "title":"Import Map",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the publication map.",
            "nullable":false,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":"1",
            "type":"boolean",
            "description":"Value that identifies if the publication map is active or not.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PublicationMapId":{
            "type":"integer",
            "description":"Value that uniquely identifies the publication map.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PublicationMapDescription":{
            "title":"Description",
            "maxLength":"3000",
            "type":"string",
            "description":"Description of the publication map.",
            "nullable":true,
            "x-queryable":true
        },
        "OutputFileTypeCode":{
            "title":"File Type",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the file type for the publication map output file.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the publication map.",
            "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 : 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

• Array of: object publicationMaps-publicationMapTranslations-item-response

{
    "title":"Publication Map Translations",
    "type":"array",
    "description":"A publication map translation lets you translate the publication map name and publication map description to a specified language.",
    "items":{
        "$ref":"#/components/schemas/publicationMaps-publicationMapTranslations-item-response"
    }
}

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

• Array of: object publicationMaps-spokeColumns-item-response

{
    "title":"Spoke Attributes",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/publicationMaps-spokeColumns-item-response"
    }
}

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."
        }
    }
}

Nested Schema : publicationMaps-publicationMapTranslations-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the publication map translation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the publication map translation.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the publication map translation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Language":{
            "maxLength":"4",
            "type":"string",
            "description":"Value that identifies the language in which the publication map translation is created.",
            "nullable":false,
            "x-queryable":true
        },
        "PublicationMapId":{
            "type":"integer",
            "description":"Value that uniquely identifies the publication map.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceLang":{
            "maxLength":"4",
            "type":"string",
            "description":"Value that identifies the source language from which the publication map translation is created.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PublicationMapDescription":{
            "maxLength":"3000",
            "type":"string",
            "description":"Description of the publication map.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "PublicationMapName":{
            "maxLength":"80",
            "type":"string",
            "description":"Name of the publication map.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the publication map translation.",
            "format":"date-time",
            "nullable":true,
            "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 : publicationMaps-spokeColumns-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the publication map spoke column.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "masterDataColumns":{
            "title":"Master Attributes",
            "type":"array",
            "description":"Master data columns mapped with spoke system columns in a publication map. A master data column can be mapped with multiple spoke system columns.",
            "items":{
                "$ref":"#/components/schemas/publicationMaps-spokeColumns-masterDataColumns-item-response"
            }
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the publication map spoke column.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the publication map spoke column.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PublicationMapId":{
            "type":"integer",
            "description":"Value that uniquely identifies the publication map.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Sequence":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SpokeColumnId":{
            "type":"integer",
            "description":"Value that uniquely identifies the spoke column in a publication map.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the publication map spoke column.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SpokeSystemColumn":{
            "maxLength":"4000",
            "type":"string",
            "description":"Name of the spoke system column.",
            "nullable":false,
            "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 : 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

• Array of: object publicationMaps-spokeColumns-masterDataColumns-item-response

{
    "title":"Master Attributes",
    "type":"array",
    "description":"Master data columns mapped with spoke system columns in a publication map. A master data column can be mapped with multiple spoke system columns.",
    "items":{
        "$ref":"#/components/schemas/publicationMaps-spokeColumns-masterDataColumns-item-response"
    }
}

Nested Schema : publicationMaps-spokeColumns-masterDataColumns-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the master data column mapping in a publication map.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the master data column mapping in a publication map.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the master data column mapping in a publication map.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EntityName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the object, for example, Item or Structure.",
            "nullable":true,
            "x-queryable":true
        },
        "MapMasterDataId":{
            "type":"integer",
            "description":"Value that uniquely identifies a master data column to spoke column mapping in a publication map.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AttributeGroupName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the attribute group to which the master data column belongs.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeCode":{
            "maxLength":"120",
            "type":"string",
            "description":"Value that uniquely identifies a master data attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeGroupCode":{
            "maxLength":"120",
            "type":"string",
            "description":"Value that uniquely identifies the attribute group to which the master data column belongs.",
            "nullable":false,
            "x-queryable":true
        },
        "EntityCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the object that the master data column belongs to.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AttributeName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the master data attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "SpokeColumnId":{
            "type":"integer",
            "description":"Value that uniquely identifies the spoke column in a publication map.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the master data column mapping in a publication map.",
            "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"
    }
}

Links

RestLOVDelimiter

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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

RestLovOutputFileType

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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

publicationMapTranslations

Operation: /fscmRestApi/resources/11.13.18.05/publicationMaps/{PublicationMapId}/child/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.

spokeColumns

Operation: /fscmRestApi/resources/11.13.18.05/publicationMaps/{PublicationMapId}/child/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.

Back to Top