openapi: 3.0.0
info:
version: '3.0'
title: Get Bom Assembly ManufacturerItem API
license:
name: MIT
servers:
- url: https://{endpoint}/services/apexrest/{namespace}/v2
variables:
endpoint:
description: This is the Salesforce instance url. It is the URL when using Salesforce Classic, i.e. propel.my.salesforce.com
namespace:
default: PDLM
description: This value should default to PDLM for production environments. For dev environments, provide the namespace to your dev org.
tags:
- name: ManufacturerItem
paths:
/ManufacturerItem/{ItemId}:
parameters:
- name: ItemId
description: The Salesforce record id of the Item
in: path
required: true
schema:
$ref: '#/components/schemas/ItemId'
post:
summary: Create new Manufacturer Item(s)
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MfrList'
responses:
'200':
description: Successfully created new Manufacturer Item(s)
content:
application/json:
schema:
$ref: '#/components/schemas/NewOrExistingManufacturerItem'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- ManufacturerItem
components:
schemas:
MfrList:
description: Model containing AML list object
type: object
required:
- addAML
properties:
addAML:
type: array
items:
$ref: '#/components/schemas/ManufacturerPart'
Error:
description: A human readable error message or null/blank
type: string
example: Invalid manufacturer/distributor value(s). No items or parts created.
ItemId:
description: The Salesforce record id of the Item
type: string
ManufacturerPart:
description: Model containing Manufacturer Part mappings
type: object
required:
- manufacturer
- mpn
properties:
manufacturer:
type: string
example: United Gas & Oil
mpn:
type: string
distributor:
type: string
example: GenePoint
NewOrExistingManufacturerItem:
description: Model containing newly created Manufacturer Item details
type: object
required:
- attributes
- Name
- Id
properties:
attributes:
type: object
properties:
type:
type: string
example: PDLM__Manufacturer_Item__c
url:
type: string
Name:
type: string
example: MPN-12345
PDLM__Manufacturer__c:
description: The Salesforce record id of the Manufacturer account
type: string
PDLM__Distributor__c:
description: The Salesforce record id of the Distributor account
type: string
Id:
description: The Salesforce record id of the newly created Manufacturer Item
type: string