Jump to

• Request
• Response
• Examples

Create alternate supplier sites

post

/fscmRestApi/resources/11.13.18.05/channelPrograms/{ProgramId}/child/alternateSupplierSites

Request

Path Parameters

• ProgramId(required): integer(int64)
  Value that uniquely identifies the channel program. It is a primary key that the application generates when it creates the program.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AlternateSupplierSiteId: integer (int64)
  Value that uniquely identifies the alternate supplier site.
• ProcurementBusinessUnit: string
  Name of the procurement business unit.
• ProcurementBusinessUnitId: integer
  Value that uniquely identifies the procurement business unit.
• Supplier: string
  Name of the alternate supplier supporting the channel program.
• SupplierId: integer
  Value that uniquely identifies the alternate supplier.
• SupplierNumber: string
  Number that identifies the alternate supplier.
• SupplierSite: string
  Maximum Length: 240

  Name of the alternate supplier site.
• SupplierSiteAddress: string
  Maximum Length: 4000

  Address of the alternate supplier site.
• SupplierSiteId: integer (int64)
  Value that identifies the alternate supplier site.

{
    "type":"object",
    "properties":{
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the alternate supplier.",
            "nullable":true
        },
        "SupplierSiteAddress":{
            "maxLength":4000,
            "type":"string",
            "description":"Address of the alternate supplier site.",
            "nullable":true
        },
        "AlternateSupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the alternate supplier site.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that identifies the alternate supplier site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SupplierSite":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the alternate supplier site.",
            "nullable":true
        },
        "ProcurementBusinessUnitId":{
            "type":"integer",
            "description":"Value that uniquely identifies the procurement business unit.",
            "nullable":true
        },
        "Supplier":{
            "type":"string",
            "description":"Name of the alternate supplier supporting the channel program.",
            "nullable":true
        },
        "SupplierNumber":{
            "type":"string",
            "description":"Number that identifies the alternate supplier.",
            "nullable":true
        },
        "ProcurementBusinessUnit":{
            "type":"string",
            "description":"Name of the procurement business unit.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : channelPrograms-alternateSupplierSites-item-response

Type: object

Show Source

• AlternateSupplierSiteId: integer (int64)
  Value that uniquely identifies the alternate supplier site.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the record.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the record.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProcurementBusinessUnit: string
  Name of the procurement business unit.
• ProcurementBusinessUnitId: integer
  Value that uniquely identifies the procurement business unit.
• Supplier: string
  Name of the alternate supplier supporting the channel program.
• SupplierId: integer
  Value that uniquely identifies the alternate supplier.
• SupplierNumber: string
  Number that identifies the alternate supplier.
• SupplierSite: string
  Maximum Length: 240

  Name of the alternate supplier site.
• SupplierSiteAddress: string
  Maximum Length: 4000

  Address of the alternate supplier site.
• SupplierSiteId: integer (int64)
  Value that identifies the alternate supplier site.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcurementBusinessUnitId":{
            "type":"integer",
            "description":"Value that uniquely identifies the procurement business unit.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierNumber":{
            "type":"string",
            "description":"Number that identifies the alternate supplier.",
            "nullable":true,
            "x-queryable":true
        },
        "ProcurementBusinessUnit":{
            "type":"string",
            "description":"Name of the procurement business unit.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the alternate supplier.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierSiteAddress":{
            "maxLength":4000,
            "type":"string",
            "description":"Address of the alternate supplier site.",
            "nullable":true,
            "x-queryable":true
        },
        "AlternateSupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the alternate supplier site.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that identifies the alternate supplier site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SupplierSite":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the alternate supplier site.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Supplier":{
            "type":"string",
            "description":"Name of the alternate supplier supporting the channel program.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

This example describes how to create alternate supplier sites.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "server:port/fscmRestApi/resources/latest/channelPrograms/300100546485419/child/alternateSupplierSites"

Example Request Body

The following shows an example of the request body in JSON format.

"{
""Supplier"": ""Supplier3341"",
""SupplierSite"": ""GE PLASTICS_HQ""
	
}"

Example Response Body

The following shows an example of the response body in JSON format.

"{
    ""AlternateSupplierSiteId"": 300100550572294,
    ""Supplier"": ""Supplier3341"",
    ""SupplierId"": 34893,
    ""SupplierNumber"": ""24895"",
    ""SupplierSite"": ""GE PLASTICS_HQ"",
    ""SupplierSiteId"": 34893,
    ""SupplierSiteAddress"": ""500 Oracle Parkway,BRISBANE, CA 94065"",
    ""ProcurementBusinessUnit"": ""Vision Operations"",
    ""ProcurementBusinessUnitId"": 204,
    ""CreatedBy"": ""channel_user"",
    ""CreationDate"": ""2021-06-08T06:07:03+00:00"",
    ""LastUpdatedBy"": ""channel_user"",
    ""LastUpdateDate"": ""2021-06-08T06:07:04.859+00:00"",
    ""links"": [
        {
            ""rel"": ""self"",
            ""href"": ""https://servername/fscmRestApi/resources/version/channelPrograms/300100550572291/child/alternateSupplierSites/300100550572294"",
            ""name"": ""alternateSupplierSites"",
            ""kind"": ""item"",
            ""properties"": {
                ""changeIndicator"": ""ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178""
            }
        },
        {
            ""rel"": ""canonical"",
            ""href"": ""https://servername/fscmRestApi/resources/version/channelPrograms/300100550572291/child/alternateSupplierSites/300100550572294"",
            ""name"": ""alternateSupplierSites"",
            ""kind"": ""item""
        },
        {
            ""rel"": ""parent"",
            ""href"": ""https://servername/fscmRestApi/resources/version/channelPrograms/300100550572291"",
            ""name"": ""channelPrograms"",
            ""kind"": ""item""
        }
    ]
}"

Back to Top