Jump to

• Request
• Response

Add spoke columns

post

/fscmRestApi/resources/11.13.18.05/publicationMaps/{PublicationMapId}/child/spokeColumns

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=

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

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

{
    "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 : schema

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-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 : 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-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

masterDataColumns

Operation: /fscmRestApi/resources/11.13.18.05/publicationMaps/{PublicationMapId}/child/spokeColumns/{SpokeColumnId}/child/masterDataColumns

Parameters:

• PublicationMapId: $request.path.PublicationMapId
• SpokeColumnId: $request.path.SpokeColumnId

Master data columns mapped with spoke system columns in a publication map. A master data column can be mapped with multiple spoke system columns.

Back to Top