creating bmc asset management web services-v7-20151201_0806

Upload: ashraf-kamal-khalid

Post on 19-Feb-2018

217 views

Category:

Documents


0 download

TRANSCRIPT

  • 7/23/2019 Creating BMC Asset Management Web Services-V7-20151201_0806

    1/51

    BMC Software Confidential. BladeLogic Confidentia

    BMC Asset Management version 8.1.01

    URL:

    Date: 01-Dec-2015 08:06

    https://docs.bmc.com/docs/pages/viewpage.action?

    pageId=599219853

  • 7/23/2019 Creating BMC Asset Management Web Services-V7-20151201_0806

    2/51

    Creating BMC Asset Management web services BMC Software Confidential. BladeLogic Confidential.

    BMC Asset Management 8.1.01 Page of2 51

    Table of Contents

    1 AST_PurchaseRequisitionInterface_Create_WS ___________________________________________________ 51.1 Create_PurchaseRequisition _______________________________________________________________ 5

    2 AST_PurchaseRequisition_QueryModify_WS _____________________________________________________ 12

    2.1 Query_PurchaseRequisition ______________________________________________________________ 12

    2.2 AST-PurchaseRequisitionInterface (Query) __________________________________________________ 12

    2.3 Update_PurchaseRequisition _____________________________________________________________ 17

    3 AST_PurchaseOrder_QueryModify_WS _________________________________________________________ 23

    3.1 Query_PurchaseOrder __________________________________________________________________ 23

    3.2 Update_PurchaseOrder __________________________________________________________________ 26

    4 AST_PurchaseLineItem_QueryModify_WS _______________________________________________________ 30

    4.1 Query_PurchaseLineItem ________________________________________________________________ 304.2 Update_PurchaseLineItem _______________________________________________________________ 34

    5 AST_WorkInfoInterface_Create_WS ____________________________________________________________ 37

    5.1 Create_WorkInfo _______________________________________________________________________ 37

    6 AST_PurchaseOrder_WS and AST_PurchaseOrder_WS_noDate _____________________________________ 39

    6.1 Update_PO_Confirmation ________________________________________________________________ 40

    6.2 Get_Specific_PO _______________________________________________________________________ 40

    6.3 Get_List_Of_New_POs __________________________________________________________________ 42

    7 AST_PurchaseOrderInterface_WS _____________________________________________________________ 44

    7.1 PO_Modify_Service _____________________________________________________________________ 44

    7.2 PO_Query_Service _____________________________________________________________________ 45

    7.3 PO_GetListofNewPO_Service _____________________________________________________________ 46

    8 AST_CIUnavailabilityInterface_WS _____________________________________________________________ 48

    8.1 GetListOfUnavailability function ____________________________________________________________ 48

    9 Index ____________________________________________________________________________________ 49

  • 7/23/2019 Creating BMC Asset Management Web Services-V7-20151201_0806

    3/51

    Creating BMC Asset Management web services BMC Software Confidential. BladeLogic Confidential.

    BMC Asset Management 8.1.01 Page of3 51

    In BMC Asset Management, you can use web services to query and update purchase requisitions, purchase line

    items, purchase work information records, purchase orders, and purchase returns.

    The following is a list of the interface forms available for BMC Asset Management. These interface forms are

    described as used by web services in the sections that follow.

    AST:PurchaseRequisitionInterface_Create creates a purchase requisition and related work information

    record.

    AST:PurchaseLineItemInterface_Create creates a purchase line item and related work information record A

    purchase order can be created depending on the input status.

    AST:WorkInfoInterface_Create creates a work information record for either purchase requisition or purchase

    line item.

    AST:PurchaseRequisitionInterface queries and modifies a purchase requisition.

    AST:PurchaseOrderInterface queries and modifies a purchase order.

    AST:PurchaseLineItemInterface queries and modifies a purchase line item.

    The interface create forms can have the following sectional headers under which fields are grouped. Some fields

    shown on the interface forms are not mapped in the web services because they are either set by workflow or system-

    generated. Fields where values are input are described in the web service mapping tables.

    Required Input Field Values Fields where a value must be input

    Conditional Required Input Field Values Fields that may require a value depending on other fields which are

    input

    Optional Input Field Values Fields where a value can optionally be input

    Fields Set through Workflow Fields that are set by workflow, and therefore do not require any input value

    Fields Set through Workflow or Input Values Fields that can be set by workflow but also support the option of

    inputting a valueChange Management Integration fields Fields that can be used if BMC Change Management is installed

    PO Creation Field Values Fields that can be input if creating a Purchase Order

    Reference Numbers Generated Fields that are generated as a result of the create operation

    More operations are available via web services. The following is a list of the web services available for BMC Asset

    Management. These web services are described in the topics in this section.

    AST_PurchaseRequisitionInterface_Create_WS (see page 5)- supports the creation of parent purchase

    requisitions and child purchase line items It also supports the creation of a work information record for parent

    and child items. A purchase order can be created depending on the status of the purchase requisition and

    purchase line items.

    AST_PurchaseRequisition_QueryModify_WS (see page 12) queries and modifies purchase requisitions

    and its work information records and purchase line items

    AST_PurchaseOrder_QueryModify_WS (see page 23) queries and modifies purchase orders and its

    purchase line items

    AST_PurchaseLineItem_QueryModify_WS (see page 30) queries and modifies purchase line items and its

    work information records and return records

  • 7/23/2019 Creating BMC Asset Management Web Services-V7-20151201_0806

    4/51

    Creating BMC Asset Management web services BMC Software Confidential. BladeLogic Confidential.

    BMC Asset Management 8.1.01 Page of4 51

    AST_WorkInfoInterface_Create_WS (see page 37) supports the creation of work information records for

    either a purchase requisition or purchase line item

    Note

    The following existing web services will be phased out as the functionality becomes available in the above

    new web services.

    AST_PurchaseOrder_WS (see page 39) updates and queries both purchase orders with the date included

    and purchase order line items

    AST_PurchaseOrder_WS_noDate (see page 39) updates and queries both purchase orders without the

    date and purchase order line items

    AST_PurchaseOrderInterface_WS (see page 44) updates and queries purchase orders with the date, but

    without purchase order line items

    AST_CIUnavailabilityInterface_WS (see page 48) queries for a list of Unavailability records that are related

    to a CI.

  • 7/23/2019 Creating BMC Asset Management Web Services-V7-20151201_0806

    5/51

    Creating BMC Asset Management web services BMC Software Confidential. BladeLogic Confidential.

    BMC Asset Management 8.1.01 Page of5 51

    1 AST_PurchaseRequisitionInterface_Create_WSThe purchase requisition create web service is a complex web service based on the PurchaseRequisitionCreate.xsd

    file, which is also provided. This web service contains one operation.

    Create_PurchaseRequisition (see page 5)

    1.1 Create_PurchaseRequisitionThis operation lets you create parent purchase requisitions and child purchase line items. It also creates a work

    information record for parent and child items if input values are supplied.

    Recommendation

    If you are creating a purchase requisition with a status higher than In Preparation, provide all the purchase

    line items while using the Create_PurchaseRequisition operation.

    The following table lists input values for the parent level of the Create_PurchaseRequisition operation and maps to the

    AST:PurchaseRequisitionInterface_Create form.

    Input field values

    DB field on interfaceform

    Displayed on web services Notes

    zID_Action Action Required field "CREATE" is the only keyword supported and must be in uppercase

    Status Status Required field Accepted status values: In Preparation, On Order, Partially Received,

    Received, Closed, and Cancelled

    Date Required DateRequired Required field

    Description Description Required field

    Justification Justification Required field

    For_Company RequestedForCompany Required field

    Requested_For_PersonID RequestedForPersonID Required if RequestedForFullName is not provided

    For_Full Name RequestedForFullName Required if RequestedForPersonID is not provided

    Login Name RequestedForLoginName

    For_Phone RequestedForPhoneNumber

    For_Department RequestedForDepartment

  • 7/23/2019 Creating BMC Asset Management Web Services-V7-20151201_0806

    6/51

    Creating BMC Asset Management web services BMC Software Confidential. BladeLogic Confidential.

    BMC Asset Management 8.1.01 Page of6 51

    DB field on interface

    form

    Displayed on web services Notes

    Manager Name ManagerFullName By default this is the manager of the Requested For person, and is used as the first

    approver by the provided process. If the status is In Preparation. then a value is

    recommended. A Full Name other than the actual manager can be supplied.

    Manager Login Name ManagerLoginName Login identifier of the value supplied for Manager Name

    By_Company RequestedByCompany Required field

    Requested_By_PersonID RequestedByPersonID Required if RequestedByFullName is not provided

    By_Full Name RequestedByFullName Required if RequestedByPersonID is not provided

    Requester Login Name RequestedByLoginName

    By_Phone RequestedByPhoneNumber

    By_Department RequestedByDepartment

    Shipping Instructions ShippingInstructions

    PRNumber PRNumber Available for storing external procurement system reference number

    DataTags DataTags Hidden field that can store a tag identifier

    Install Needed InstallNeeded Supported values are Yes or No

    Cost Center CostCenter

    Accounting Code AccountingCode

    Project Number ProjectNumber

    Budget Code BudgetCode

    z1D_Activity_Type WorkInfoType Required if creating a work information record

    z1D_ActivityDate_tab WorkInfoDate Required if creating a work information record

    z1D_Communication

    Source

    WorkInfoSource Required if creating a work information record

    z1D_Summary WorkInfoSummary Required if creating a work information record

    z1D_Details WorkInfoNotes Required if creating a work information record

    z1D_Secure_Log WorkInfoLocked Required if creating a work information record

    z1D_View Access WorkInfoViewAccess Required if creating a work information record. Supported values are "Internal" or

    "External."

    z2AF_Act_Attachment_1

    /attachmentName

    WorkInfoAttachment1Name Optional if creating a work information record

    z2AF_Act_Attachment_1

    /attachmentData

    WorkInfoAttachment1Data Optional if creating a work information record

    z2AF_Act_Attachment_1

    /attachmentOrigSize

    WorkInfoAttachment1OrigSize Optional if creating a work information record

  • 7/23/2019 Creating BMC Asset Management Web Services-V7-20151201_0806

    7/51

    Creating BMC Asset Management web services BMC Software Confidential. BladeLogic Confidential.

    BMC Asset Management 8.1.01 Page of7 51

    DB field on interface

    form

    Displayed on web services Notes

    z2AF_Act_Attachment_2

    /attachmentName

    WorkInfoAttachment2Name Optional if creating a work information record

    z2AF_Act_Attachment_2

    /attachmentData

    WorkInfoAttachment2Data Optional if creating a work information record

    z2AF_Act_Attachment_2

    /attachmentOrigSize

    WorkInfoAttachment2OrigSize Optional if creating a work information record

    z2AF_Act_Attachment_3

    /attachmentName

    WorkInfoAttachment3Name Optional if creating a work information record

    z2AF_Act_Attachment_3

    /attachmentData

    WorkInfoAttachment3Data Optional if creating a work information record

    z2AF_Act_Attachment_3

    /attachmentOrigSize

    WorkInfoAttachment3OrigSize Optional if creating a work information record

    BillToAddr_Street BillToStreet Bill To fields are required and will be set based on Requested For.

    BillToAddr_City Name+ BillToCity

    BillToAddr_State Prov+ BillToStateProv

    BillToAddr_Postal Code+ BillToPostalCode

    BillToAddr_Country+ BillToCountry

    ShipToAddr_Street ShipToStreet Ship To fields are required and will be set based on Requested For.

    ShipToAddr_City Name+ ShipToCity

    ShipToAddr_State Prov+ ShipToStateProv

    ShipToAddr_Postal

    Code+

    ShipToPostalCode

    ShipToAddr_Country+ ShipToCountry

    Assigned Support

    Company

    SupportCompany Assigned field values can be automatically set by workflow if a Group Assignment General

    event is defined.

    Assigned Support

    Organization

    SupportOrganization

    Assigned Group AssignedGroup

    Assignee Assignee

    TemplateInstanceID ChangeTemplateInstanceID Integration available if Change Management is installed. Specify the CHG Template ID

    (FieldID 179) which can be found in the CHG:Template form. If value is supplied then

    Installed Needed should be set to Yes.

    The following table lists input values for the child level of the Create_PurchaseRequisition operation and maps to the

    form.AST:PurchaseLineItemInterface_Create

    Input field values

  • 7/23/2019 Creating BMC Asset Management Web Services-V7-20151201_0806

    8/51

    Creating BMC Asset Management web services BMC Software Confidential. BladeLogic Confidential.

    BMC Asset Management 8.1.01 Page of8 51

    DB field on interface form Displayed on web services Notes

    zID_Action Action Required field "CREATE" is the only keyword supported and must be in upper case.

    Part Number PartNumber Required field

    Short Description Description Required field

    Status Status Required field Accepted status values: In Preparation, On Order, Partially Received,

    Received, and Cancelled.

    Asset Class ID AssetClassID Required field in the format of CI Keyword, for example BMC_COMPUTERSYSTEM.

    Unit of Measure UnitOfMeasure

    Required Qty* RequiredQty Required field

    Total Received Qty TotalReceivedQty Required if auto receive is set to yes and CI Type is Software Class or if Status is

    Received.

    Unit Price/currencyValue UnitPriceAmount I f a value is provided, must provide the currency code. If Unit Pr ice is 0 and if the order

    status is "In Preparation", then the Status of PLI will switch to Pending Pricing.

    Unit Price/currencyCode UnitPriceCurrency Code Must provide a currency value if currency code is provided.

    Estimated Price

    /currencyValue

    EstimatedPriceAmount If a value is provided, must provide the currency code.

    Estimated Price

    /currencyCode

    EstimatedPriceCurrencyCode Must provide a currency value if currency code is provided.

    Actual Price/currencyValue ActualPriceAmount I f a value is provided, must provide the currency code.

    Actual Price/currencyCode ActualPriceCurrency Code Must provide a currency value if currency code is provided.

    Taxable Taxable Set to "Yes" if Tax Amount is supplied.

    Tax Amount/currencyValue TaxAmount If a value is provided, must provide the currency code.

    Tax Amount/currencyCode TaxCurrencyCode Must provide a currency value if currency code is provided.

    Tax Rate TaxRate If Taxable = "Yes", must provide rate.

    Shipping & Handling

    /currencyValue

    ShippingAndHandling

    Amount

    If a value is provided, must provide the currency code.

    Shipping & Handling

    /currencyCode

    ShippingAndHandling

    CurrencyCode

    Must provide a currency value if currency code is provided.

    Product Categorization Tier

    1

    ProductTier1 Required if CI Type is Software Class.

    Product Categorization Tier

    2

    ProductTier2 Required if CI Type is Software Class.

    Product Categorization Tier

    3

    ProductTier3 Required if CI Type is Software Class.

    Model ProductName Required if CI Type is Software Class.

    Version Number ModelVersion

  • 7/23/2019 Creating BMC Asset Management Web Services-V7-20151201_0806

    9/51

    Creating BMC Asset Management web services BMC Software Confidential. BladeLogic Confidential.

    BMC Asset Management 8.1.01 Page of9 51

    DB field on interface form Displayed on web services Notes

    MarketVersion MarketVersion Required if CI Type is Software Class.

    Manufacture Name+ Manufacturer Required if CI Type is Software Class.

    Supplier Name+ SupplierName Required for most Status values. If Supplier is not filled in while In Preparation then the

    Status will switch to Pending Pricing.

    Date Required DateRequired Required field

    Date Ordered DateOrdered Required if Status is On Order or greater.

    Estimated Receiving Date DateToReceive

    LicenseCertificateType CertificatePurchaseType Required if Software Contract ID is used

    Software Contract ID SoftwareContractID Either SoftwareContractID or Cert ificate ID is required if CI Type is Software Class.

    LicenseTypeGUID LicenseType Required if Software Contract ID is used. Need to provide the license type GUID. In order

    to get this, user must go to the interface form and use the drop down box to select the

    type. The GUID will be displayed when type is selected.

    zID_CertificateID CertificateID Either SoftwareContractID or Certificate ID is required if CI Type is Software Class. If the

    CertificateID is specified, it must be a valid Certificate ID and should not be related to

    another purchase line item.

    PRNumber PRNumber Available for storing external procurement system reference number.

    PO Number PONumber Available for storing external purchase order reference number.

    Quote Number QuoteNumber

    QuoteDesc QuoteInfo

    Data Tags Data Tags Hidden field that can store a tag identifier.

    Cost Center CostCenter Required if Software Contract ID is used.

    Accounting Code AccountingCode

    Project Number ProjectNumber

    Budget Code BudgetCode

    Attachment1

    /attachmentName

    PLIAttachment1Name

    Attachment1

    /attachmentData

    PLIAttachment1Data

    Attachment1

    /attachmentOrigSize

    PLIAttachment1OrigSize

    Notes to Purchasing NotesToPurchasing

    Notes to Supplier NotesToSupplier

    Notes EnterNotes

    zID_Activity_Type WorkInfoType Required if creating a work information record.

  • 7/23/2019 Creating BMC Asset Management Web Services-V7-20151201_0806

    10/51

    Creating BMC Asset Management web services BMC Software Confidential. BladeLogic Confidential.

    BMC Asset Management 8.1.01 Page of10 51

    DB field on interface form Displayed on web services Notes

    zID_ActivityDate_Tab WorkInfoDate Required if creating a work information record.

    zID_CommunicationSource WorkInfoSource Required if creating a work information record.

    zID_Summary WorkInfoSummary Required if creating a work information record.

    zID_Detailes WorkInfoNotes Required if creating a work information record.

    z2AF_Act_Attachment_1

    /attachmentName

    WorkInfoAttachment1Name Optional if creating a work information record.

    z2AF_Act_Attachment_1

    /attachmentData

    WorkInfoAttachment1 Data Optional if creating a work information record.

    z2AF_Act_Attachment_1

    /attachmentOrigSize

    WorkInfoAttachment1

    OrigSize

    Optional if creating a work information record.

    z2AF_Act_Attachment_2

    /attachmentName

    WorkInfoAttachment2 Name Optional if creating a work information record.

    z2AF_Act_Attachment_2

    /attachmentData

    WorkInfoAttachment2 Data Optional if creating a work information record.

    z2AF_Act_Attachment_2

    /attachmentOrigSize

    WorkInfoAttachment2

    OrigSize

    Optional if creating a work information record.

    z2AF_Act_Attachment_3

    /attachmentName

    WorkInfoAttachment3 Name Optional if creating a work information record.

    z2AF_Act_Attachment_3

    /attachmentData

    WorkInfoAttachment3 Data Optional if creating a work information record.

    z2AF_Act_Attachment_3

    /attachmentOrigSize

    WorkInfoAttachment3

    OrigSize

    Optional if creating a work information record.

    zID_Secure_Log WorkInfoLocked Required if creating a work information record.

    zID_View_Access WorkInfoViewAccess Required if creating a work information record. Supported values are "Internal" or

    "External."

    Buyer Name BuyerName Will be stored in the Purchase Order if one is generated.

    OrderConfirmationTypeCode ConfirmationCode Will be stored in the Purchase Order if one is generated.

    Payment Terms PaymentTerms Will be stored in the Purchase Order if one is generated.

    Freight Terms FreightTerms Will be stored in the Purchase Order if one is generated.

    Ship Via ShipVia Will be stored in the Purchase Order if one is generated.

    Shipping Options ShippingOptions Will be stored in the Purchase Order if one is generated.

    The following table lists output values for the parent level of the Create_PurchaseRequisition operation from the AST:

    form.PurchaseRequisitionInterface_Create

    Output field values

  • 7/23/2019 Creating BMC Asset Management Web Services-V7-20151201_0806

    11/51

    Creating BMC Asset Management web services BMC Software Confidential. BladeLogic Confidential.

    BMC Asset Management 8.1.01 Page of11 51

    DB field on interface

    form

    Displayed on web

    services

    Notes

    instanceId InstanceID Unique identifier generated for each purchase

    requisition.

    Requisition ID RequisitionID Unique visible Requisition ID system generated.

    The following table lists output values for the child level of the Create_PurchaseRequisition operation from the AST:

    form.PurchaseLineItemInterface_Create

    Output field values

    DB field on interface

    form

    Displayed on web

    services

    Notes

    instanceId InstanceID Unique identifier generated for each line

    item.

  • 7/23/2019 Creating BMC Asset Management Web Services-V7-20151201_0806

    12/51

    Creating BMC Asset Management web services BMC Software Confidential. BladeLogic Confidential.

    BMC Asset Management 8.1.01 Page of12 51

    2 AST_PurchaseRequisition_QueryModify_WSThis is a complex web service based on the file, which is provided with thePurchaseRequisitionQueryModify.xsd

    application. This web service supports two operations, which are query and modify.

    Query_PurchaseRequisition (see page 12)

    AST-PurchaseRequisitionInterface (Query) (see page 12)

    Update_PurchaseRequisition (see page 17)

    2.1 Query_PurchaseRequisitionThis operation supports a qualification to query for parent requisitions. It will also return related children purchase line

    items and work information records for each purchase requisition found, based on the qualification entered.

    Depending on how general the qualification is, startRecord and maxLimit can be used to determine how many records

    should be shown at a time.

    The following table lists input values for the parent level of the Query_PurchaseRequisition operation against AST:

    PurchaseRequisitionInterface form.

    Input field values

    DB field on interface

    form

    Displayed on web

    services

    Notes

    Qualification AR System qualification

    required.

    startRecord

    maxLimit

    2.2 AST-PurchaseRequisitionInterface (Query)The following table lists output values for the parent level of the Query_PurchaseRequisition operation and maps to

    the AST:PurchaseRequisitionInterface form.

    Output field values

    DB field on interface form Displayed on web services Notes

    instanceId InstanceID Returns unique instance ID of the purchase

    requisition.

    Requisition ID RequisitionID Returns unique visible Requisition ID.

  • 7/23/2019 Creating BMC Asset Management Web Services-V7-20151201_0806

    13/51

    Creating BMC Asset Management web services BMC Software Confidential. BladeLogic Confidential.

    BMC Asset Management 8.1.01 Page of13 51

    DB field on interface form Displayed on web services Notes

    Status Status

    Date Required DateRequired

    Description Description

    Justification Justification

    For_Company RequestedForCompany

    For_Full Name RequestedForFullName

    For_Phone RequestedForPhoneNumber

    For_Department RequestedForDepartment

    Manager Name ManagerFullName

    Manager Login Name ManagerLoginName

    By_Company RequestedByCompany

    Requested_By_PersonID RequestedByPersonID

    By_Full Name RequestedByFullName

    Requester Login Name RequestedByLoginName

    By_Phone RequestedByPhoneNumber

    By_Department RequestedByDepartment

    Shipping Instructions ShippingInstructions

    PRNumber PRNumber

    DataTags DataTags

    Install Needed InstallNeeded

    Cost Center CostCenter

    Accounting Code AccountingCode

    Project Number ProjectNumber

    Budget Code BudgetCode

    BillToAddr_Street BillToStreet

    BillToAddr_City Name+ BillToCity

    BillToAddr_State Prov+ BillToStateProv

    BillToAddr_Postal Code+ BillToPostalCode

    BillToAddr_Country+ BillToCountry

    ShipToAddr_Street ShipToStreet

  • 7/23/2019 Creating BMC Asset Management Web Services-V7-20151201_0806

    14/51

    Creating BMC Asset Management web services BMC Software Confidential. BladeLogic Confidential.

    BMC Asset Management 8.1.01 Page of14 51

    DB field on interface form Displayed on web services Notes

    ShipToAddr_City Name+ ShipToCity

    ShipToAddr_State Prov+ ShipToStateProv

    ShipToAddr_Postal Code+ ShipToPostalCode

    ShipToAddr_Country+ ShipToCountry

    Assigned Support Company SupportCompany

    Assigned Support

    Organization

    SupportOrganization

    Assigned Group AssignedGroup

    Assignee Assignee

    Change Template ChangeTemplateName

    TemplateInstanceID ChangeTemplateInstanceID

    The following table lists output values for the child level of the Query_PurchaseRequisition operation and maps to the

    AST:PurchaseRequisitionWorkLog form.

    Output field values

    DB field on interface form Displayed on web services Notes

    InstanceId WorkInfoInstanceId The unique Instance ID for the work information record.

    PR Instance ID SourceInstanceID This is the foreign key, purchase requisition Instance ID, which the work information

    record is linked to.

    Work Log Type WorkInfoType

    Work Log Date WorkInfoDate

    Communication Source WorkInfoSource

    Description WorkInfoSummary

    Detailed Description WorkInfoNotes

    Secure Work log WorkInfoLocked

    View Access WorkInfoViewAccess

    z2AF Work Log01

    /attachmentName

    WorkInfoAttachment1Name

    z2AF Work Log01

    /attachmentData

    WorkInfoAttachment1Data

    z2AF Work Log01

    /attachmentOrigSize

    WorkInfoAttachment1OrigSize

    WorkInfoAttachment2Name

  • 7/23/2019 Creating BMC Asset Management Web Services-V7-20151201_0806

    15/51

    Creating BMC Asset Management web services BMC Software Confidential. BladeLogic Confidential.

    BMC Asset Management 8.1.01 Page of15 51

    DB field on interface form Displayed on web services Notes

    z2AF Work Log02

    /attachmentName

    z2AF Work Log02

    /attachmentData

    WorkInfoAttachment2Data

    z2AF Work Log02

    /attachmentOrigSize

    WorkInfoAttachment2OrigSize

    z2AF Work Log03

    /attachmentName

    WorkInfoAttachment3Name

    z2AF Work Log03

    /attachmentData

    WorkInfoAttachment3Data

    z2AF Work Log03

    /attachmentOrigSize

    WorkInfoAttachment3OrigSize

    The following table lists output values for the child level of the Update_Requisition operation and maps to the AST:

    PurchaseLineItem form.

    Output field values

    DB field on interface form Displayed on web services Notes

    instanceId InstanceID Returns unique identifier, purchase line item Instance

    ID.

    Part Number PartNumber

    Description Description

    Status Status

    Asset Class CIType

    Unit of Measure UnitOfMeasure

    Required Qty* RequiredQty

    Total Received Qty TotalReceivedQty

    Unit Price/currencyValue UnitPriceAmount

    Unit Price/currencyCode UnitPriceCurrencyCode

    Estimated Price/currencyValue EstimatedPriceAmount

    Estimated P rice/currencyCode EstimatedPriceCurrencyCode

    Actual Price/currencyValue ActualPriceAmount

    Actual Price/currencyCode ActualPriceCurrencyCode

    Taxable Taxable

    Tax Amount/currencyValue TaxAmount

  • 7/23/2019 Creating BMC Asset Management Web Services-V7-20151201_0806

    16/51

    Creating BMC Asset Management web services BMC Software Confidential. BladeLogic Confidential.

    BMC Asset Management 8.1.01 Page of16 51

    DB field on interface form Displayed on web services Notes

    Tax Amount/currencyCode TaxCurrencyCode

    Shipping & Handling

    /currencyValue

    ShippingAndHandlingAmount

    Shipping & Handling

    /currencyCode

    ShippingAndHandlingCurrency

    Code

    Product Categorization Tier 1 ProductTier1

    Product Categorization Tier 2 ProductTier2

    Product Categorization Tier 3 ProductTier3

    Model ProductName

    Version Number ModelVersion

    MarketVersion MarketVersion

    Manufacture Name+ Manufacturer

    Supplier Name+ SupplierName

    Requisition ID RequisitionID

    Order ID OrderID

    Quote Number QuoteNumber

    QuoteDesc QuoteInfo

    PRNumber PRNumber

    PO Number PONumber

    Data Tags Data Tags

    Date Required DateRequired

    Date Ordered DateOrdered

    Estimated Receiving Date DateToReceive

    Notes to Purchasing NotesToPurchasing

    Notes to Supplier NotesToSupplier

    LicenseCertificateType CertificatePurchaseType

    Software Contract ID SoftwareContractID

    zID_LicenseType LicenseType

    zID_CertificateID CertificateID

    Cost Center CostCenter

    Accounting Code AccountingCode

  • 7/23/2019 Creating BMC Asset Management Web Services-V7-20151201_0806

    17/51

    Creating BMC Asset Management web services BMC Software Confidential. BladeLogic Confidential.

    BMC Asset Management 8.1.01 Page of17 51

    DB field on interface form Displayed on web services Notes

    Project Number ProjectNumber

    Budget Code BudgetCode

    Attachment1/attachmentName PLIAttachment1Name

    Attachment1/attachmentData PLIAttachment1Data

    Attachment1/attachmentOrigSize PLIAttachment1OrigSize

    Audit Trail ReadNotes

    2.3 Update_PurchaseRequisitionThis operation supports the update of an existing parent purchase requisition, and updates to related children

    purchase line items and work information records. The qualification entered determines which purchase requisitions

    are updated, only child records related to the parent can be updated. In addition children purchase line items and workinformation records can also be created.

    The following table lists input values for the parent level of the Update_PurchaseRequisition operation and maps to

    the AST:PurchaseRequisitionInterface form.

    Input field values

    DB field on interface form Displayed on web services Notes

    Qualification AR System qualification required and is based on AST:PurchaseRequisitionInterface

    fields.

    instanceId InstanceID

    Requisition ID RequisitionID

    Status Status

    Date Required DateRequired

    Description Description

    Justification Justification

    For_Company RequestedForCompany

    Requested_For_PersonID RequestedForPersonID

    For_Full Name RequestedForFullName

    Login Name RequestedForLoginName

    For_Phone RequestedForPhoneNumber

    For_Department RequestedForDepartment

    Manager Name ManagerFullName

  • 7/23/2019 Creating BMC Asset Management Web Services-V7-20151201_0806

    18/51

    Creating BMC Asset Management web services BMC Software Confidential. BladeLogic Confidential.

    BMC Asset Management 8.1.01 Page of18 51

    DB field on interface form Displayed on web services Notes

    Manager Login Name ManagerLoginName

    By_Company RequestedByCompany

    Requested_By_PersonID RequestedByPersonID

    By_Full Name RequestedByFullName

    Requester Login Name RequestedByLoginName

    By_Phone RequestedByPhoneNumber

    By_Department RequestedByDepartment

    Shipping Instructions ShippingInstructions

    PRNumber PRNumber

    DataTags DataTags

    Install Needed InstallNeeded

    Cost Center CostCenter

    Accounting Code AccountingCode

    Project Number ProjectNumber

    Budget Code BudgetCode

    BillToAddr_Street BillToStreet

    BillToAddr_City Name+ BillToCity

    BillToAddr_State Prov+ BillToStateProv

    BillToAddr_Postal Code+ BillToPostalCode

    BillToAddr_Country+ BillToCountry

    ShipToAddr_Street ShipToStreet

    ShipToAddr_City Name+ ShipToCity

    ShipToAddr_State Prov+ ShipToStateProv

    ShipToAddr_Postal Code+ ShipToPostalCode

    ShipToAddr_Country+ ShipToCountry

    Assigned Support Company SupportCompany

    Assigned Support

    Organization

    SupportOrganization

    Assigned Group AssignedGroup

    Assignee Assignee

    TemplateInstanceID ChangeTemplateInstanceID

  • 7/23/2019 Creating BMC Asset Management Web Services-V7-20151201_0806

    19/51

    Creating BMC Asset Management web services BMC Software Confidential. BladeLogic Confidential.

    BMC Asset Management 8.1.01 Page of19 51

    The following table lists input values for the child level of the Update _PurchaseRequisition operation and maps to the

    AST:PurchaseRequisitionWorkLog form.

    Input field values

    DB field on form Displayed on web services Notes

    InstanceId WorkInfoInstanceId Provides the work information Instance ID to be updated. If a new Instance ID is provided (one

    that is not in the database), a new work information record will be created.

    PR Instance ID SourceInstanceID This is the foreign key, purchase requisition Instance ID, which the work information is linked

    to, and required if creating a new work information record.

    Work Log Type WorkInfoType Required if creating a work information record. Supported values are: Detailed Clarification,

    Purchase Requisition Task, General Information, Email System,and Paging System.

    Work Log Date WorkInfoDate Required if creating a work information record.

    Communication

    Source

    WorkInfoSource Required if creating a work information record. Supported values are: Email, Fax, Phone, Voice

    Mail, Walk In, Pager, System Assignment, Web, and Other.

    Description WorkInfoSummary Required if creating a work information record.

    Detailed Description WorkInfoNotes Optional if creating a work information record.

    Secure Work log WorkInfoLocked Required if creating a work information record. Supported values are "Yes" or "No."

    View Access WorkInfoViewAccess Required if creating a work information record. Supported values are "Internal" or "Public."

    z2AF Work Log01

    /attachmentName

    WorkInfoAttachment1Name Optional if creating a work information record.

    z2AF Work Log01

    /attachmentData

    WorkInfoAttachment1Data Optional if creating a work information record.

    z2AF Work Log01/attachmentOrigSize

    WorkInfoAttachment1OrigSize Optional if creating a work information record.

    z2AF Work Log02

    /attachmentName

    WorkInfoAttachment2Name Optional if creating a work information record.

    z2AF Work Log02

    /attachmentData

    WorkInfoAttachment2Data Optional if creating a work information record.

    z2AF Work Log02

    /attachmentOrigSize

    WorkInfoAttachment2OrigSize Optional if creating a work information record.

    z2AF Work Log03

    /attachmentName

    WorkInfoAttachment3Name Optional if creating a work information record.

    z2AF Work Log03

    /attachmentData

    WorkInfoAttachment3Data Optional if creating a work information record.

    z2AF Work Log03

    /attachmentOrigSize

    WorkInfoAttachment3OrigSize Optional if creating a work information record.

    The following table lists input values for the child level of the Update_PurchaseRequisition operation and maps to the

    AST:PurchaseLineItem form.

  • 7/23/2019 Creating BMC Asset Management Web Services-V7-20151201_0806

    20/51

    Creating BMC Asset Management web services BMC Software Confidential. BladeLogic Confidential.

    BMC Asset Management 8.1.01 Page of20 51

    Input field values

    DB field on form Displayed on web

    services

    Notes

    instanceId InstanceID Provide the purchase line item Instance ID to be updated. If a new Instance ID is provided, a

    purchase line item will be created.

    Part Number PartNumber Required if creating a new purchase line item.

    Description Description Required if creating a new purchase line item.

    Status Status Required if creating a new purchase line item.

    Asset Class ID AssetClassID Required if creating a new purchase line item in the format of CI Keyword. For example,

    BMC_COMPUTERSYSTEM.

    Asset Class AssetClass Required if creating a new purchase line item in the format of Proper Name of CI.

    RequestedFor_Company RequestedForCompany Required if creating a new purchase line item.

    Unit of Measure UnitOfMeasure Required if creating a new purchase line item.

    Required Qty* RequiredQty Required if creating a new purchase line item.

    Received Qty ReceivedQty

    Unit Price/currencyValue UnitPriceAmount If a value is provided, must provide the currency code.

    Unit Price/currencyCode UnitPriceCurrencyCode Must provide a currency value if currency code is provided.

    Estimated Price

    /currencyValue

    EstimatedPriceAmount If a value is provided, must provide the currency code.

    Estimated Price

    /currencyCode

    EstimatedPriceCurrency

    Code

    Must provide a currency value if currency code is provided.

    Actual Price

    /currencyValue

    ActualPriceAmount If a value is provided, must provide the currency code.

    Actual Price

    /currencyCode

    ActualPriceCurrency

    Code

    Must provide a currency value if currency code is provided.

    Taxable Taxable Supported values are "Yes" or "No".

    Tax Amount

    /currencyValue

    TaxAmount If a value is provided, must provide the currency code.

    Tax Amount

    /currencyCode

    TaxCurrencyCode Must provide a currency value if currency code is provided.

    Tax Rate TaxRate If Taxable = "Yes", must provide rate.

    Shipping & Handling

    /currencyValue

    ShippingAndHandling

    Amount

    If a value is provided, must provide the currency code.

    Shipping & Handling

    /currencyCode

    ShippingAndHandling

    CurrencyCode

    Must provide a currency value if currency code is provided.

    Product Categorization

    Tier 1

    ProductTier1 Required if creating a new purchase line item, and CI Type is Software Class.

  • 7/23/2019 Creating BMC Asset Management Web Services-V7-20151201_0806

    21/51

    Creating BMC Asset Management web services BMC Software Confidential. BladeLogic Confidential.

    BMC Asset Management 8.1.01 Page of21 51

    DB field on form Displayed on web

    services

    Notes

    Product Categorization

    Tier 2

    ProductTier2 Required if creating a new purchase line item, and CI Type is Software Class.

    Product Categorization

    Tier 3

    ProductTier3 Required if creating a new purchase line item, and CI Type is Software Class.

    Model ProductName Required if creating a new purchase line item, and CI Type is Software Class.

    Version Number ModelVersion

    MarketVersion MarketVersion Required if creating a new purchase line item, and CI Type is Software Class.

    Manufacture Name+ Manufacturer Required if creating a new purchase line item, and CI Type is Software Class.

    Supplier Name+ SupplierName Required if creating a new purchase line item.

    Date Required DateRequired Required if creating a new purchase line item.

    Date Ordered DateOrdered Required if creating a new purchase line item, CI Type is Software Class, and Auto receive is set

    to "Yes" or if Status is On Order or higher.

    Estimated Receiving

    Date

    DateToReceive

    LicenseCertificateType CertificatePurchaseType Required if creating a new purchase line item, and Software Contract ID is provided.

    Software Contract ID SoftwareContractID Either SoftwareContractID or Certificate ID is required if creating a new line, and CI Type is

    Software Class.

    zID_LicenseType LicenseType Required if Software Contract ID is provided. Need to provide the license type GUID. In order to

    get this, user must go to the interface form and use the drop down box to select the type. The

    GUID will be displayed when type is selected. This value is the value used.

    zID_CertificateID CertificateID Either SoftwareContractID or Certificate ID is required if CI Type is Software Class. If theCertificateID is specified, it must be a valid Certificate ID and should not be related to another

    purchase line item.

    PRNumber PRNumber

    PO Number PO]Number

    Quote Number QuoteNumber

    QuoteDesc QuoteInfo

    Data Tags Data Tags

    Cost Center CostCenter Required if creating a new purchase line item, and Software Contract ID is provided.

    Accounting Code AccountingCode

    Project Number ProjectNumber

    Budget Code BudgetCode

    Attachment1

    /attachmentName

    PLIAttachment1Name

  • 7/23/2019 Creating BMC Asset Management Web Services-V7-20151201_0806

    22/51

    Creating BMC Asset Management web services BMC Software Confidential. BladeLogic Confidential.

    BMC Asset Management 8.1.01 Page of22 51

    DB field on form Displayed on web

    services

    Notes

    Attachment1

    /attachmentData

    PLIAttachment1Data

    Attachment1

    /attachmentOrigSize

    PLIAttachment1OrigSize

    Notes to Purchasing NotesToPurchasing

    Notes to Supplier NotesToSupplier

    The following table lists output values for the parent level of the Update_PurchaseRequisition operation from the AST:

    PurchaseRequisitionInterface form.

    Output field values

    DB field on interface

    form

    Displayed on web

    services

    Notes

    InstanceId InstanceID Unique identifier for each updated purchase requisition.

    Requisition ID RequisitionID Unique visible Requisition ID for each updated purchase

    requisition.

    The following table lists output values for the child level of the Update_PurchaseRequisition operation from the AST:

    PurchaseRequisitionWorkLog form.

    Output field values

    DB field on interface

    form

    Displayed on web

    services

    Notes

    InstanceId InstanceID Unique identifier for each updated or added work information

    record.

    The following table lists output values for the child level of the Update_PurchaseRequisition operation from the AST:

    PurchaseLineItem form.

    Output field values

    DB field on interface

    form

    Displayed on web

    services

    Notes

    InstanceId InstanceID Unique identifier for each updated or added purchase line

    item.

  • 7/23/2019 Creating BMC Asset Management Web Services-V7-20151201_0806

    23/51

    Creating BMC Asset Management web services BMC Software Confidential. BladeLogic Confidential.

    BMC Asset Management 8.1.01 Page of23 51

    3 AST_PurchaseOrder_QueryModify_WSThis is a complex web service based on the file, which is provided with thePurchaseOrderQueryModify.xsd

    application. This web service contains the following two operations:

    Query_PurchaseOrder (see page 23)

    Update_PurchaseOrder (see page 26)

    3.1 Query_PurchaseOrderThis operation supports a qualification to query for purchase orders. It will also return related children purchase line

    items for each purchase order found, based on the qualification entered. Depending on how general the qualification

    is, startRecord and maxLimit can be used to determine how many records should be shown at a time.

    The following table lists input values for the Query_PurchaseOrder operation against the parent AST:

    PurchaseOrderInterface form.

    Input field values

    DB field on interface

    form

    Displayed on web

    services

    Notes

    Qual ification AR System qualification required and is based on AST:PurchaseOrderInterface

    fields.

    startRecord

    maxLimit

    The following table lists output values for the parent level of the Query_PurchaseOrder operation and maps to the

    AST:PurchaseOrderInterface form.

    Output field values

    DB field on interface form Displayed on web services Notes

    Order ID OrderID Returns unique system-generated Order

    ID.

    Status Status

    PO Number PONumber

    Date Ordered DateOrdered

    Payment Terms PaymentTerms

    Buyer Buyer

  • 7/23/2019 Creating BMC Asset Management Web Services-V7-20151201_0806

    24/51

    Creating BMC Asset Management web services BMC Software Confidential. BladeLogic Confidential.

    BMC Asset Management 8.1.01 Page of24 51

    DB field on interface form Displayed on web services Notes

    Requested By+ RequestedBy

    Supplier Name+ SupplierName

    Notes to Supplier NotesToSupplier

    Tax Rate TaxRate

    Tax Amount/currencyValue TaxAmount

    Tax Amount/currencyCode TaxCurrencyCode

    Shipping & Handling

    /currencyValue

    ShippingAndHandlingAmount

    Shipping & Handling

    /currencyCode

    ShippingAndHandlingCurrency

    Code

    BillToAddr_Street BillToStreet

    BillToAddr_City Name+ BillToCity

    BillToAddr_State/Prov BillToStateProv

    BillToAddr_Postal Code BillToPostalCode

    BillToAddr_Country BillToCountry

    ShipToAddr_Street ShipToStreet

    ShipToAddr_City Name+ ShipToCity

    ShipToAddr_State/Prov ShipToStateProv

    ShipToAddr_Postal Code ShipToPostalCode

    ShipToAddr_Country ShipToCountry

    Freight Terms FreightTerms

    Ship Via ShipVia

    Shipping Options ShippingOption

    OrderConfirmation Type Code OrderConfirmationTypeCode

    WebServiceOrder WebServiceOrder

    The following table lists output values for the child level of the Query_PurchaseOrder operation and maps to the AST:

    PurchaseLineItem form.

    Output field values

    DB field on form Displayed on web services Notes

    instanceId InstanceID Returns unique identifier, purchase line item Instance

    Id.

  • 7/23/2019 Creating BMC Asset Management Web Services-V7-20151201_0806

    25/51

    Creating BMC Asset Management web services BMC Software Confidential. BladeLogic Confidential.

    BMC Asset Management 8.1.01 Page of25 51

    DB field on form Displayed on web services Notes

    Part Number PartNumber

    Description Description

    Status Status

    Asset Class CIType

    RequestedForCompany RequesterCompany

    Unit of Measure ProductUnitOfMeasureCode

    Required Qty* RequiredQty

    Total Received Qty TotalReceivedQty

    Unit Price/currencyValue UnitPriceAmount

    Unit Price/currencyCode UnitPriceCurrencyCode

    Estimated Price/currencyValue EstimatedPriceAmount

    Estimated P rice/currencyCode EstimatedPriceCurrencyCode

    Actual Price/currencyValue ActualPriceAmount

    Actual Price/currencyCode ActualPriceCurrencyCode

    Taxable Taxable

    Tax Amount/currencyValue TaxAmount

    Tax Amount/currencyCode TaxCurrencyCode

    Shipping & Handling

    /currencyValue

    ShippingAndHandling Amount

    Shipping & Handling

    /currencyCode

    ShippingAndHandling

    CurrencyCode

    Product Categorization Tier 1 Tier1

    Product Categorization Tier 2 Tier2

    Product Categorization Tier 3 Tier3

    Model ProductName

    Version Number ModelVersion

    MarketVersion MarketVersion

    Manufacture Name+ Manufacturer

    Supplier Name+ SupplierName

    Requisition ID RequisitionID

    Order ID OrderID

  • 7/23/2019 Creating BMC Asset Management Web Services-V7-20151201_0806

    26/51

    Creating BMC Asset Management web services BMC Software Confidential. BladeLogic Confidential.

    BMC Asset Management 8.1.01 Page of26 51

    DB field on form Displayed on web services Notes

    Quote Number QuoteNumber

    QuoteDesc QuoteInfo

    Date Required DateRequired

    Date Ordered DateOrdered

    Estimated Receiving Date DateToReceive

    Notes to Purchasing NotesToPurchasing

    Notes to Supplier NotesToSupplier

    Cost Center CostCenter

    Accounting Code AccountingCode

    Project Number ProjectNumber

    Budget Code BudgetCode

    Attachment1/attachmentName DetailsAttachment1Name

    Attachment1/attachmentData DetailsAttachment1Data

    Attachment1/attachmentOrigSize DetailsAttachment1OrigSize

    Audit Trail ReadNotes

    LicenseCertificateType PurchaseType

    Software Contract ID SoftwareContractID

    zID_LicenseType LicenseType

    zID_CertificateID CertificateID

    3.2 Update_PurchaseOrderThis operation supports the update of a purchase order plus updates to existing purchase line items. The qualification

    entered determines which purchase order is updated. Only child records related to the parent can be updated.

    The following table lists the input values for the parent level of the Update_PurchaseOrder operation and maps to the

    AST:PurchaseOrderInterface form.

    Input field values

    DB field on interface form Displayed on web services Notes

    Qualification AR System qualification required, and is based on AST:PurchaseOrderInterface

    fields.

    Order ID OrderID

  • 7/23/2019 Creating BMC Asset Management Web Services-V7-20151201_0806

    27/51

    Creating BMC Asset Management web services BMC Software Confidential. BladeLogic Confidential.

    BMC Asset Management 8.1.01 Page of27 51

    DB field on interface form Displayed on web services Notes

    Supplier Name+ SupplierName

    Status Status

    PO Number PONumber Available for storing external purchase order reference number.

    Payment Terms PaymentTerms

    Buyer Buyer

    Requested By+ RequestedBy

    Notes to Supplier NotesToSupplier

    Tax Rate TaxRate

    Tax Amount/currencyValue TaxAmount Must provide currency value if currency code provided.

    Tax Amount/currencyCode TaxCurrencyCode Must provide currency code if currency value provided.

    Shipping & Handling/currencyValue

    ShippingAndHandling Amount Must provide currency value if currency code provided.

    Shipping & Handling

    /currencyCode

    ShippingAndHandling

    CurrencyCode

    Must provide currency code if currency value provided.

    BillToAddr_Street BillToStreet

    BillToAddr_City Name+ BillToCity

    BillToAddr_State/Prov BillToStateProv

    BillToAddr_Postal Code BillToPostalCode

    BillToAddr_Country BillToCountry

    ShipToAddr_Street ShipToStreet

    ShipToAddr_City Name+ ShipToCity

    ShipToAddr_State/Prov ShipToStateProv

    ShipToAddr_Postal Code ShipToPostalCode

    ShipToAddr_Country ShipToCountry

    Freight Terms FreightTerms

    Ship Via ShipVia

    Shipping Options ShippingOption

    OrderConfirmation Type Code OrderConfi rmationType Code

    WebServiceOrder WebServiceOrder

    The following table lists input values for the child level of the Update_PurchaseOrder operation and maps to the AST:

    PurchaseLineItem form.

  • 7/23/2019 Creating BMC Asset Management Web Services-V7-20151201_0806

    28/51

    Creating BMC Asset Management web services BMC Software Confidential. BladeLogic Confidential.

    BMC Asset Management 8.1.01 Page of28 51

    Input field values

    DB field on interface form Displayed on web

    services

    Notes

    instanceId InstanceID Provide the purchase line item Instance ID to be

    updated.

    Unit Price/currencyValue UnitPriceAmount Must provide currency value if currency code provided.

    Unit Price/currencyCode UnitPriceCurrencyCode Must supply currency code if currency value provided.

    Taxable Taxable

    Quote Number QuoteNumber

    QuoteDesc QuoteInfo

    EstimatedReceivingDate DateToReceive

    Notes to Purchasing NotesToPurchasing

    Notes to Supplier NotesToSupplier

    Cost Center CostCenter

    Accounting Code AccountingCode

    Project Number ProjectNumber

    Budget Code BudgetCode

    Attachment1/attachmentName DetailsAttachment1Name

    Attachment1/attachmentData DetailsAttachment1Data

    Attachment1/attachmentOrigSize

    DetailsAttachment1OrigSize

    Received Qty ReceivedQty

    The following table lists output values for the parent level of the Update_PurchaseOrder operation from the AST:

    PurchaseOrderInterface form.

    Output field values

    DB field on interface

    form

    Displayed on web

    services

    Notes

    instanceId InstanceID Unique identifier for each updated purchaseorder.

    The following table lists output values for the child level of the Update_PurchaseOrder operation from the AST:

    PurchaseLineItem form.

    Output field values

  • 7/23/2019 Creating BMC Asset Management Web Services-V7-20151201_0806

    29/51

    Creating BMC Asset Management web services BMC Software Confidential. BladeLogic Confidential.

    BMC Asset Management 8.1.01 Page of29 51

    DB field on interface

    form

    Displayed on web

    services

    Notes

    instanceId InstanceID Unique identifier for each updated purchase line

    item.

  • 7/23/2019 Creating BMC Asset Management Web Services-V7-20151201_0806

    30/51

    Creating BMC Asset Management web services BMC Software Confidential. BladeLogic Confidential.

    BMC Asset Management 8.1.01 Page of30 51

    4 AST_PurchaseLineItem_QueryModify_WSThis is a complex web service based on the PurchaseLineItemQueryModify.xsd file, which is provided with the

    application. This web service contains the following two operations:

    Query_PurchaseLineItem (see page 30)

    Update_PurchaseLineItem (see page 34)

    4.1 Query_PurchaseLineItemThe query operation supports a qualification to query for purchase line items. It will also return related children work

    information and return records for each purchase line item found, based on the qualification entered. Depending on

    how general the qualification is, startRecord and maxLimit can be used to determine how many records should be

    shown at a time.

    The following table lists input values for the Query_PurchaseLineItem operation against the parent AST:

    PurchaseLineItemInterface form.

    Input field values

    DB field on interface

    form

    Displayed on web

    services

    Notes

    Qualification AR System qualif icat ion required and is based on AST:PurchaseLineItemInterface

    fields.

    startRecord

    maxLimit

    The following table lists output values for the parent level of the Query_PurchaseLineItem operation and maps to the

    AST:PurchaseLineItemInterface form.

    Output field values

    DB field on interface form Displayed on web services Notes

    InstanceID InstanceID Returns unique identifier, purchase line item Instance

    Id.

    Part Number PartNumber

    Description ItemDescription

    Status ItemStatus

    Asset Class CIType

  • 7/23/2019 Creating BMC Asset Management Web Services-V7-20151201_0806

    31/51

    Creating BMC Asset Management web services BMC Software Confidential. BladeLogic Confidential.

    BMC Asset Management 8.1.01 Page of31 51

    DB field on interface form Displayed on web services Notes

    RequestedFor_Company RequesterCompany

    Unit of Measure UnitOfMeasure

    Required Qty RequiredQty

    Received Qty ReceivedQty

    Total Received Qty TotalReceivedQty

    Unit Price/currencyValue UnitPriceAmount

    Unit Price/currencyCode UnitPriceCurrencyCode

    Estimated Price/currencyValue EstimatedPriceAmount

    Estimated Price/currencyCode EstimatedPriceCurrencyCode

    Actual Price/currencyValue ActualPriceAmount

    Actual Price/currencyCode ActualPriceCurrencyCode

    Taxable Taxable

    Tax Amount/currencyValue TaxAmount

    Tax Amount/currencyCode TaxCurrencyCode

    ShippingAndHandling

    /currencyValue

    ShippingAndHandlingAmount

    ShippingAndHandling

    /currencyCode

    ShippingAndHandling

    CurrencyCode

    Product Categorization Tier 1 ProductTier1

    Product Categorization Tier 2 ProductTier2

    Product Categorization Tier 3 ProductTier3

    ProductName Model

    ModelVersion VersionNumber

    MarketVersion MarketVersion

    Manufacturer ManufacturerName+

    SupplierName Supplier Name+

    RequisitionID Requisition ID

    OrderID Order ID

    QuoteNumber Quote Number

    QuoteDesc QuoteInfo

    PRNumber PRNumber

  • 7/23/2019 Creating BMC Asset Management Web Services-V7-20151201_0806

    32/51

    Creating BMC Asset Management web services BMC Software Confidential. BladeLogic Confidential.

    BMC Asset Management 8.1.01 Page of32 51

    DB field on interface form Displayed on web services Notes

    PO Number PONumber

    Data Tags DataTags

    Date Required DateRequired

    Date Ordered DateOrdered

    EstimatedReceivingDate DateToReceive

    Notes to Purchasing NotesToPurchasing

    Notes to Supplier NotesToSupplier

    Cost Center CostCenter

    Accounting Code AccountingCode

    Project Number ProjectNumber

    Budget Code BudgetCode

    Attachment1/attachmentName PLIAttachmentName

    Attachment1/attachmentData PLIAttachmentData

    Attachment1/attachmentOrigSize PLIAttachmentOrigSize

    Audit Trail ReadNotes

    License Certificate Type CertificatePurchaseType

    Software Contract ID Software Contract ID

    zID_LicenseType LicenseType

    zID_LicenseCertificateID CertificateID

    The following table lists output values for the child level of the Query_PurchaseLineItem operation and maps to the

    AST:PurchaseRequisitionWorkLog form.

    Output field values

    DB field on interface form Displayed on web services Notes

    InstanceId WorkInfoInstanceID The unique Instance ID for the work information record.

    Purchase Line Item Instance ID SourceInstanceID This is the foreign key, purchase line item Instance ID, which the work information

    record is linked to.

    Work Log Type WorkInfoType

    Work Log Date WorkInfoDate

    Communication Source WorkInfoSource

    Description WorkInfoSummary

  • 7/23/2019 Creating BMC Asset Management Web Services-V7-20151201_0806

    33/51

    Creating BMC Asset Management web services BMC Software Confidential. BladeLogic Confidential.

    BMC Asset Management 8.1.01 Page of33 51

    DB field on interface form Displayed on web services Notes

    Detailed Description WorkInfoNotes

    Secure Work Log WorkInfoLocked

    View Access WorkInfoViewAccess

    z2AF Work Log01

    /attachmentName

    WorkInfoAttachment1Name

    z2AF Work Log01

    /attachmentData

    WorkInfoAttachment1Data

    z2AF Work Log01

    /attachmentOrigSize

    WorkInfoAttachment1OrigSize

    z2AF Work Log02

    /attachmentName

    WorkInfoAttachment2Name

    z2AF Work Log02

    /attachmentData

    WorkInfoAttachment2Data

    z2AF Work Log02

    /attachmentOrigSize

    WorkInfoAttachment2OrigSize

    z2AF Work Log03

    /attachmentName

    WorkInfoAttachment3Name

    z2AF Work Log03

    /attachmentData

    WorkInfoAttachment3Data

    z2AF Work Log03

    /attachmentOrigSize

    WorkInfoAttachment3OrigSize

    The following table lists output values for the child level of the Query_PurchaseLineItem operation and maps to the

    AST:PurchaseReturn form.

    Output field values

    DB field on interface

    form

    Displayed on web

    services

    Notes

    Instanceid InstanceID Returns unique identifier.

    Line Item Instance ID LineItemInstanceID Purchase line item Instance

    ID.

    Type Type

    RMA Number RMANumber

    Quantity to Return QuantityToReturn

    Reason for Return ReasonForReturn

    Replacement Received ReplacementReceived

  • 7/23/2019 Creating BMC Asset Management Web Services-V7-20151201_0806

    34/51

    Creating BMC Asset Management web services BMC Software Confidential. BladeLogic Confidential.

    BMC Asset Management 8.1.01 Page of34 51

    4.2 Update_PurchaseLineItemThis operation supports the update of an existing purchase line item, and updates to related children work information

    and return records. The qualification entered determines which purchase line items are updated. Only child records

    related to the parent can be updated. In addition, children work information and return records can also be created.

    The following table lists the input values for the parent level of the Update_PurchaseLineItem operation and maps to

    the AST:PurchaseLineItemInterface form.

    Input field values

    DB field on interface form Displayed on web

    services

    Notes

    Qualification AR System qualification

    required.

    Unit Price/currencyValue UnitPriceAmount

    Unit Price/currencyCode UnitPriceCurrencyCode

    Taxable Taxable

    Quote Number QuoteNumber

    QuoteDesc QuoteInfo

    EstimatedReceivingDate DateToReceive

    Notes to Purchasing NotesToPurchasing

    Notes to Supplier NotesToSupplier

    Cost Center CostCenter

    Accounting Code AccountingCode

    Project Number ProjectNumber

    Budget Code BudgetCode

    Attachment1/attachmentName DetailsAttachment1Name

    Attachment1/attachmentData DetailsAttachment1Data

    Attachment1

    /attachmentOrigSize

    DetailsAttachment1OrigSize

    Received Qty ReceivedQty

    The following table lists input values for the child level of the Update_PurchaseLineItem operation and maps to the

    AST:PurchaseRequisitionWorkLog form.

    Input field values

  • 7/23/2019 Creating BMC Asset Management Web Services-V7-20151201_0806

    35/51

    Creating BMC Asset Management web services BMC Software Confidential. BladeLogic Confidential.

    BMC Asset Management 8.1.01 Page of35 51

    DB field on form Displayed on web services Notes

    InstanceId WorkInfoInstanceID If a new Instance ID is provided (one that is not in the database), a new work information record

    will be created. If existing instance Id is provided the matching work information record will be

    updated.

    Purchase Line Item

    Instance ID

    SourceInstanceID This is the foreign key, purchase line item Instance ID, which the work information record is

    linked to. Required if creating a new work information record.

    Work Log Type WorkInfoType Required if creating a work information record. Supported values are: Detailed Clarification,

    Purchase Requisition Task, General Information, Email System and Paging System.

    Work Log Submit

    Date

    WorkInfoDate Required if creating a work information record.

    Communication

    Source

    WorkInfoSource Required if creating a work information record. Supported values are: Email, Fax, Phone, Voice

    Mail, Walk In, Pager, System Assignment, Web and Other.

    Description WorkInfoSummary Required if creating a work information record.

    Detailed Description WorkInfoNotes Required if creating a work information record.

    Secure Work Log WorkInfoLocked Required if creating a work information record. Supported values are: "Yes" or "No."

    View Access WorkInfoViewAccess Required if creat ing a work information record. Supported values are: "Internal" or "Public."

    z2AF Work Log01

    /attachmentName

    WorkInfoAttachment1Name Optional if creating a work information record.

    z2AF Work Log01

    /attachmentData

    WorkInfoAttachment1Data Optional if creating a work information record.

    z2AF Work Log01

    /attachmentOrigSize

    WorkInfoAttachment1OrigSize Optional if creating a work information record.

    z2AF Work Log02

    /attachmentName

    WorkInfoAttachment2Name Optional if creating a work information record.

    z2AF Work Log02

    /attachmentData

    WorkInfoAttachment2Data Optional if creating a work information record.

    z2AF Work Log02

    /attachmentOrigSize

    WorkInfoAttachment2OrigSize Optional if creating a work information record.

    z2AF Work Log03

    /attachmentName

    WorkInfoAttachment3Name Optional if creating a work information record.

    z2AF Work Log03

    /attachmentData

    WorkInfoAttachment3Data Optional if creating a work information record.

    z2AF Work Log03

    /attachmentOrigSize

    WorkInfoAttachment3OrigSize Optional if creating a work information record.

    The following table lists input values for the child level of the Update_PurchaseLineItem operation and maps to the

    form.AST:PurchaseReturn

    Input field values

  • 7/23/2019 Creating BMC Asset Management Web Services-V7-20151201_0806

    36/51

    Creating BMC Asset Management web services BMC Software Confidential. BladeLogic Confidential.

    BMC Asset Management 8.1.01 Page of36 51

    DB field on

    form

    Displayed on web

    services

    Notes

    Instanceid Instanceid If a new Instance ID is provided, a purchase return will be created and this is the typical usage. If existing

    Instance ID is provided updates can be made.

    Line Item

    Instance ID

    LineItem InstanceID Purchase line item Instance Id is required.

    Type Type Required field "Replace" and "Return."

    RMA Number RMANumber Required field

    Quantity to

    Return

    QuantityToReturn Required field

    Reason for

    Return

    ReasonForReturn Required field

    The following table lists output values for the parent level of the Update_PurchaseLineItem operation from the AST:

    PurchaseLineItemInterface form.

    Output field values

    DB field on

    form

    Displayed on web

    services

    Notes

    InstanceId InstanceID Unique identifier for each updated purchase line

    item.

    The following table lists output values for the child level of the Update_PurchaseLineItem operation from the AST:

    PurchaseRequisitionWorkLog form.

    Output field values

    DB field on

    form

    Displayed on web

    services

    Notes

    InstanceId WorkInfoInstanceID Unique identi fier for each updated or added work information

    record.

    The following table lists output values for the child level of the Update_PurchaseLineItem operation from the AST:

    PurchaseReturn form.

    Output field values

    DB field on

    form

    Displayed on web

    services

    Notes

    Instanceid ReturnsInstanceID Unique identifier for each updated or added purchase

    return.

  • 7/23/2019 Creating BMC Asset Management Web Services-V7-20151201_0806

    37/51

    Creating BMC Asset Management web services BMC Software Confidential. BladeLogic Confidential.

    BMC Asset Management 8.1.01 Page of37 51

    5 AST_WorkInfoInterface_Create_WSThis is a simple web service. It contains one operation and supports the creation of a work information record for

    either a purchase requisition or purchase line item.

    Create_WorkInfo (see page 37)

    5.1 Create_WorkInfoThe following table describes the input field values for this function.

    Input field values

    DB field on form Displayed on webservices

    Notes

    zID_Action zID_Action Required field with two keywords supported; "CREATEPR" to create a work information for purchase

    requisition and "CREATEPLI" to create a work information record for a purchase line item.

    SourceInstanceID SourceInstanceID Required field Provide either the purchase requisition Instance Id or the purchase line item Instance

    Id.

    Work Log Type Work_Log_Type Required for creating a work information record. Supported values are Detailed Clarification,

    Purchase Requisition Task, General Information, Email System and Paging System.

    Description Description Required for creating a work information record.

    Secure Work Log Secure_Work_Log Required for creating a work information record. Supported values are "Yes" or "No."

    View Access View_Access Required for creating a work information record. Supported values are "Internal" or "Publ ic."

    Status Status Required for creating a work information record.

    Work Log Submit

    Date

    Work_Log_Submit_Date Required for creating a work information record.

    Submitter Submitter Required for creating a work information record.

    Assigned To Assigned_To Optional for creating a work information record.

    Short Description Short_Description Required for creating a work information record.

    Assignee Groups Assignee_Groups

    Vendor Assignee

    Groups

    Vendor_Assignee_Groups

    Requisition ID Requisition_ID Set using workflow.

    PRNumber PRNumber Set using workflow.

    Data Tags Data Tags Optional for creating a work information record.

  • 7/23/2019 Creating BMC Asset Management Web Services-V7-20151201_0806

    38/51

    Creating BMC Asset Management web services BMC Software Confidential. BladeLogic Confidential.

    BMC Asset Management 8.1.01 Page of38 51

    DB field on form Displayed on web

    services

    Notes

    Notes Notes Optional for creating a work information record.

    Work Log Submitter Work_Log_Submitter Optional for creating a work information record.

    z2AF Work Log01

    /attachmentName

    WorkInfoAttachment1

    Name

    Optional for creating a work information record.

    z2AF Work Log01

    /attachmentData

    WorkInfoAttachment1

    Data

    Optional for creating a work information record.

    z2AF Work Log01

    /attachmentOrigSize

    WorkInfoAttachment1

    OrigSize

    Optional for creating a work information record.

    z2AF Work Log02

    /attachmentName

    WorkInfoAttachment2

    Name

    Optional for creating a work information record.

    z2AF Work Log02

    /attachmentData

    WorkInfoAttachment2

    Data

    Optional for creating a work information record.

    z2AF Work Log02

    /attachmentOrigSize

    WorkInfoAttachment2

    OrigSize

    Optional for creating a work information record.

    z2AF Work Log03

    /attachmentName

    WorkInfoAttachment3

    Name

    Optional for creating a work information record.

    z2AF Work Log03

    /attachmentData

    WorkInfoAttachment3

    Data

    Optional for creating a work information record.

    z2AF Work Log03

    /attachmentOrigSize

    WorkInfoAttachment3

    OrigSize

    Optional for creating a work information record.

    Number of

    Attachments

    Number_of_Attachments Optional for creating a work information record.

    Communication

    Source

    Communication_Source Recommended for creating a work information record.

    Work Log Date Work_Log_Date Recommended for creating a work information record.

    The following table lists output values for the AST:WorkInfoInterface_Create form.

    Output field values

    DB field on

    form

    Displayed on web

    services

    Notes

    InstanceID InstanceID Unique identifier generated for a work informationrecord.

  • 7/23/2019 Creating BMC Asset Management Web Services-V7-20151201_0806

    39/51

    Creating BMC Asset Management web services BMC Software Confidential. BladeLogic Confidential.

    BMC Asset Management 8.1.01 Page of39 51

    6 AST_PurchaseOrder_WS and

    AST_PurchaseOrder_WS_noDateThis section describes the inputs and outputs for the following web services:

    AST_PurchaseOrder_WS

    AST_PurchaseOrder_WS_noDate

    Note

    With a few noted exceptions, these web services share the same mapping structure. See the columnNotes

    in the following tables for details about the exceptions.

    The qualifications across these two web services differ from each other as described in the following table:

    Qualifications

    Web service Qualifications

    AST_PurchaseOrder_WS This function has a value of 1 (Yes) for the WebServiceOrder field on the AST:PurchaseOrder form. For the

    Get_List_Of_New_Pos functions, you must set the OrderConfirmationTypeCode field to null on the AST:

    PurchaseOrder form.

    AST_PurchaseOrder_WS_noDate This function has a value of 0 (No) for the WebServiceOrder field on the AST:PurchaseOrder form. For theGet_List_Of_New_Pos functions, you must set the OrderConfirmationTypeCode field to null on the AST:

    PurchaseOrder form.

    Note

    The and fields appear on the Tracking tab of theWebServiceOrder OrderConfirmationTypeCode AST:

    form.PurchaseOrder

    For details of the related functions, see:

    Update_PO_Confirmation (see page 40)

    Get_Specific_PO (see page 40)

    Get_List_Of_New_POs (see page 42)

  • 7/23/2019 Creating BMC Asset Management Web Services-V7-20151201_0806

    40/51

    Creating BMC Asset Management web services BMC Software Confidential. BladeLogic Confidential.

    BMC Asset Management 8.1.01 Page of40 51

    6.1 Update_PO_ConfirmationUse the Update_PO_Confirmation function to update information about a specific purchase order and its set of line

    items. The following table describes the field values required to use this function.

    Input field values

    Field DB name on form Displayed on web services Notes

    N/A POID Qualification to search on

    Supplier Name+ Supplier Used in AST_ PurchaseOrder_ WS qualification only

    PO Number PONumber

    Freight Terms Freight Terms

    Ship Via ShipVia

    Shipping Options ShippingOption

    currencyValue ShippingCost.

    MonetaryAmount

    Shipping & Handling field on AST: PurchaseOrder

    currencyCode ShippingCost.CurrencyCode Shipping & Handling field on AST: PurchaseOrder

    Tax Rate TaxRate

    OrderConfirmationTypeCode OrderConfirmationTypeCode

    AST:PurchastLineItem getListValues Line items are a subset of a purchase order. A one-to-many relationship is defined for line

    items to purchase orders.

    instanceId ItemID

    currencyValue UnitPrice.MonetaryAmount

    currencyCode UnitPrice.CurrencyCode

    6.2 Get_Specific_POThis function returns the values of a specific purchase order and its line items.

    Input field values

    Displayed on web

    services

    Notes

    PONumber Qualification on which to

    search

    Supplier

  • 7/23/2019 Creating BMC Asset Management Web Services-V7-20151201_0806

    41/51

    Creating BMC Asset Management web services BMC Software Confidential. BladeLogic Confidential.

    BMC Asset Management 8.1.01 Page of41 51

    The following table lists the output field values.

    Output field values

    Displayed on web services Notes

    POID

    PONumber

    POStatus

    DateOrdered

    Supplier

    Buyer

    NotesToSupplier

    FreightTerms

    ShipVia

    ShippingOption

    ShippingCost.MonetaryAmount

    ShippingCost.CurrencyCode

    TotalPrice.MonetaryAmount

    TotalPrice.CurrencyCode

    BillingTo.AddressLine1

    BillingTo.AddressCity

    BillingTo.AddressState

    Bill ingTo.AddressPostalCode

    BillingTo.AddressCountry

    ShippingTo.AddressLine1

    ShippingTo.AddressCity

    ShippingTo.AddressState

    ShippingTo.

    AddressPostalCode

    ShippingTo.AddressCountry

    Item Line items on a purchase order. It has a one-to-many relationship with purchase

    order.

    ItemID

    PartNumber

  • 7/23/2019 Creating BMC Asset Management Web Services-V7-20151201_0806

    42/51

    Creating BMC Asset Management web services BMC Software Confidential. BladeLogic Confidential.

    BMC Asset Management 8.1.01 Page of42 51

    Displayed on web services Notes

    ItemDescription

    ItemStatus

    Quantity

    ProductUnitOfMeasureCode

    UnitPrice.MoneteryAmount

    UnitPrice.CurrencyCode

    QuoteNumber

    Taxable

    6.3 Get_List_Of_New_POsThis function returns the values for a list of purchase orders and its line items.

    Input field values

    Displayed on web

    services

    Supplier

    The following table lists the output field values.

    Output field values

    Displayed on web services Notes

    POID

    PONumber

    POStatus

    DateOrdered Only displayed in the AST_PurchaseOrder_WS web service

    Supplier

    Buyer

    NotesToSupplier

    FreightTerms

    ShipVia

    ShippingOption

    ShippingCost.MonetaryAmount

  • 7/23/2019 Creating BMC Asset Management Web Services-V7-20151201_0806

    43/51

    Creating BMC Asset Management web services BMC Software Confidential. BladeLogic Confidential.

    BMC Asset Management 8.1.01 Page of43 51

    Displayed on web services Notes

    ShippingCost.CurrencyCode

    BillingTo.AddressLine1

    BillingTo.AddressCity

    BillingTo.AddressState

    Bill ingTo.AddressPostalCode

    BillingTo.AddressCountry

    ShippingTo.AddressLine1

    ShippingTo.AddressCity

    ShippingTo.AddressState

    ShippingTo.

    AddressPostalCode

    ShippingTo.AddressCountry

    OrderConfirmationTypeCode

    Item Line item for purchase order. It has a one-to-many relationship with purchase

    order.

    ItemID

    PartNumber

    ItemDescription

    ItemStatus

    Quantity

    ProductUnitOfMeasureCode

    UnitPrice.MoneteryAmount

    UnitPrice.CurrencyCode

    QuoteNumber

    Taxable

  • 7/23/2019 Creating BMC Asset Management Web Services-V7-20151201_0806

    44/51

    Creating BMC Asset Management web services BMC Software Confidential. BladeLogic Confidential.

    BMC Asset Management 8.1.01 Page of44 51

    7 AST_PurchaseOrderInterface_WSThe purchase order interface web service lets you modify and query purchase order records through an interface

    form. The AST_PurchaseOrder_WS and AST_PurchaseOrder_WS_noDateweb services also perform these

    functions, but interact directly with the AST:PurchaseOrder form.

    PO_Modify_Service (see page 44)

    PO_Query_Service (see page 45)

    PO_GetListofNewPO_Service (see page 46)

    7.1 PO_Modify_ServiceThis function updates a purchase order by way of the AST:PurchaseOrderInterface form. You cannot update the line

    items for a purchase.

    Input field values

    DB field on interface

    form

    Displayed on web

    services

    Notes

    N/A POID A qualification to search

    on

    N/A Supplier Used for qualification

    Requisition ID Requisition_ID

    PO Number PONumber

    Notes to Supplier NotesToSupplier

    Status Status

    WebServiceOrder

    Buyer Buyer

    Date Ordered Date_Ordered

    Payment Terms Payment_Terms

    Tax Rate Tax_Rate

    BillToAddr_City_Name+ BillToAddr_City_Name

    BillToAddr_Country BillToAddr_Country

    BillToAddr_PostalCode+ BillToAddr_PostalCode

    BillToAddr_State/Prov BillToAddr_State_Prov

  • 7/23/2019 Creating BMC Asset Management Web Services-V7-20151201_0806

    45/51

    Creating BMC Asset Management web services BMC Software Confidential. BladeLogic Confidential.

    BMC Asset Management 8.1.01 Page of45 51

    DB field on interface

    form

    Displayed on web

    services

    Notes

    ShipToAddr_Street ShipToAddr_Street

    ShipToAddr_City_Name+ ShipToAddr_City_Name

    ShipToAddr_Country ShipToAddr_Country

    ShipToAddr_PostalCode+ ShipToAddr_PostalCode

    ShipToAddr_State/Prov ShipToAddr_State_Prov

    ShipToAddr_Street ShipToAddr_Street

    7.2 PO_Query_ServiceThe PO_Query_Service function returns a specific purchase order by way of the AST:PurchaseOrderInterface form.

    Note

    A query cannot return line item values for a purchase order.

    Input field values

    Displayed on web

    services

    Notes

    Order_ID Used as a

    qualification

    The following table lists the output field values.

    Output field values

    Displayed on web services

    Order_ID

    PO_Number

    Status

    Supplier_Name

    Buyer

    Notes_to_Supplier

    Freight_Terms

    Payment_terms

  • 7/23/2019 Creating BMC Asset Management Web Services-V7-20151201_0806

    46/51

    Creating BMC Asset Management web services BMC Software Confidential. BladeLogic Confidential.

    BMC Asset Management 8.1.01 Page of46 51

    Displayed on web services

    ShippingVia

    ShippingOptions

    OrderConfirmationTypeCode

    BillToAddr_City_Name+

    BillToAddr_Country

    BillToAddr_PostalCode+

    BillToAddr_State/Prov

    ShipToAddr_Street

    ShipToAddr_City_Name+

    ShipToAddr_Country

    ShipToAddr_PostalCode+

    ShipToAddr_State/Prov

    ShipToAddr_Street

    7.3 PO_GetListofNewPO_ServiceThe PO_GetListofNewPO_Service function returns a group of purchase orders by way of the AST:

    PurchaseOrderInterface form.

    Note

    This function cannot return the line item values for a purchase order.

    Input field values

    Displayed on web

    services

    Notes

    Qualification A valid AR System

    qualification

    The following table lists the output field values.

    Output field values

    Displayed on web services

    Order_ID

  • 7/23/2019 Creating BMC Asset Management Web Services-V7-20151201_0806

    47/51

    Creating BMC Asset Management web services BMC Software Confidential. BladeLogic Confidential.

    BMC Asset Management 8.1.01 Page of47 51

    Displayed on web services

    PO_Number

    Status

    Supplier_Name

    Notes_to_Supplier

    Buyer

    Date_Ordered

    Freight_Terms

    Payment_Terms

    OrderConformationTypeCode

    ShipVia

    Shipping_Options

    BillToAddr_City_Name

    BillToAddr_Country

    BillToAddr_PostalCode

    BillToAddr_State/Prov

    ShipToAddr_Street

    ShipToAddr_City_Name

    ShipToAddr_Country

    ShipToAddr_PostalCode

    ShipToAddr_State/Prov

    ShipToAddr_Street

  • 7/23/2019 Creating BMC Asset Management Web Services-V7-20151201_0806

    48/51

    Creating BMC Asset Management web services BMC Software Confidential. BladeLogic Confidential.

    BMC Asset Management 8.1.01 Page of48 51

    8 AST_CIUnavailabilityInterface_WSThe AST_CIUnavailabilityInterface_WS allows for a user to query for a list of unavailability records that are associated

    with a CI.

    GetListOfUnavailability function (see page 48)

    8.1 GetListOfUnavailability functionThe GetListOfUnavailability function returns a list of unavailable CIs by the way of the AST: CI Unavailablity join form.

    Input field values

    Displayed on webservices

    Notes

    Qualification A valid AR System

    qualification

    The following table lists the output field values.

    Output field values

    Displayed on web

    services

    ActualEndDate

    ActualStartDate

    CIName

    CIReconID

    CrossReferenceID

    Description

    ScheduledEndDate

    ScheduledStartDate

    UnavailabilityClass

    UnavailabilityStatus

    UnavailabilityType

  • 7/23/2019 Creating BMC Asset Management Web Services-V7-20151201_0806

    49/51

    Creating BMC Asset Management web services BMC Software Confidential. BladeLogic Confidential.

    BMC Asset Management 8.1.01 Page of49 51

    Index

    AAst Purchaserequisitioninterface Query 12

    CCreate Purchaserequisition 5

    Create Workinfo 37

    GGet List Of New Pos 42

    Getlistofunavailability 48

    Get Specific Po 40

    PPo Getlistofnewpo Service 46

    Po Modify Service 44

    Po Query Service 45

    QQuery Purchaselineitem 30

    Query Purchaseorder 23

    Query Purchaserequisition 12

    RReference , , , , , , , , , , , , , , , , , , , , ,3 5 5 12 12 12 17 23 30 30 34 37 37 39 40 42 44 44 45 46 48

    48

  • 7/23/2019 Creating BMC Asset Management Web Services-V7-20151201_0806

    50/51

    Creating BMC Asset Management web services BMC Software Confidential. BladeLogic Confidential.

    BMC Asset Management 8.1.01 Page of50 51

    UUpdate Po Confirmation 40

    Update Purchaselineitem 34

    Update Purchaseorder 26

    Update Purchaserequisition 17

    WWeb Services , , , , , , , , , , , , , , , , , , , ,3 5 5 12 23 23 26 30 30 34 37 37 39 40 40 42 44 44 45 46

    ,48 48

  • 7/23/2019 Creating BMC Asset Management Web Services-V7-20151201_0806

    51/51

    Creating BMC Asset Mana