How to Use The Model API Sandbox

The BIAN Model APIs are meant to provide access to the various artefacts in the BIAN Model.

The BIAN Model API Sandbox can be accessed  here: https://bian-modelapisandbox.azurewebsites.net/. (Please note that https://api.bian.org:4432/ is now defunct and will be decommissioned soon).

The BIAN Model API Sandbox Postman Collection can be accessed here: BIAN Model Access API Sandbox_v1.postman_collection.json

We recommend getting an understanding of the BIAN model before starting to use these APIs. A comprehensive guide to the BIAN model can be found here: Practitioner Guide.

Please DO NOT post any confidential data using this API . Any data posted via this endpoint is accessible to everyone.

The Terms of Service for using this service can be found here.

The BIAN artefacts are:

1. Metas – Meta data on the model data managed by this API – specifically the Organisation and Version.
2. Business Areas
3. Business Domains
4. Service Domains
5. Business Objects
6. Business Object Classes
7. Business Object Enumerations
8. Business Object Data Types
9. Business Object Primitive Types
10. Business Scenarios
11. Scenario Groups – Groups of functionally related business scenarios
12. Service Domain APIs
13. Service Domain Information Html Pages (as in bian.org)

We provide endpoints to access the above information, as well as to provide (POST) BIAN compliant artefacts that you might have implemented to be hosted as ‘Reference Implementations’ within BIAN.

We will also review any reference implementations and add it back to the BIAN model if we find that it enriches the BIAN model.

• Token

  The POST /Token endpoint is required to generate an authentication token to call the POST endpoints.
  The GET endpoints do not need authorisation.

  
  To call the POST /Token endpoint you would need an username and password.

  

  Please expand the /Token endpoint in the API swagger definition to find out more.

• Metas

  These endpoints manage Meta data related to the BIAN model data. The key attributes are Organisation and Version. eg: Organisation = BIAN and Version = 10.0.0.

  The schema as available in the API definition is as follows:

   

  Below is a list of endpoints to manage the Meta information:

  

  The key endpoint is highlighted in the red box, above.

  Please expand each endpoint in the API definition to find more information and on how to call it.

   

  1. Business Areas

     These group of endpoints provide the ability to GET and POST (if you are providing a reference implementation or feedback) data related to Business Areas.

   

  The schema as available in the API definition is as follows:

  

  Some of the key fields are highlighted in the red boxes, above.

  Below is a list of endpoints to manage the BusinessArea information:

   

  

  The key endpoint is highlighted in the red box, above.

  Please expand each endpoint in the API definition to find more information and on how to call it.

  1. Business Domains

     These group of endpoints provide the ability to GET and POST (if you are providing a reference implementation or feedback) data related to Business Domains.

  The schema as available in the API definition is as follows:

  

  Some of the key fields are highlighted in the red boxes, above.

  Below is a list of endpoints to manage the BusinessDomain information:

  

  The key endpoint is highlighted in the red box, above.

  Please expand each endpoint in the API definition to find more information and on how to call it.

  1. Service Domains

     These group of endpoints provide the ability to GET and POST (if you are providing a reference implementation or feedback) data related to Service Domains.

     The schema as available in the API definition is as follows:

     

     Some of the key fields are highlighted in the red boxes, above.

     Below is a list of endpoints to manage the ServiceDomain information:

     

     Some of the key endpoint are highlighted in the red box, above.

     We recommend starting with one of the /ServiceDomainsBasic endpoints, to get the BianId and Name for each Service Domain. The BianId or Name can then be used to call one of the other endpoints to get detailed information about each Service Domain.

     If you need to have the entire dataset, then please call one of the GET /ServiceDomains endpoints; in this case you will need to use pagination as described in the endpoint description.

     Please expand each endpoint in the API definition to find more information and on how to call it.

  2. Business Objects

     These group of endpoints provide the ability to GET and POST (if you are providing a reference implementation or feedback) data related to Business Objects.

     The schema as available in the API definition is as follows:

     

      

     Some of the key fields such are highlighted in the red boxes, above:

     BianId
     Name
     Description
     FeatureUID – ID of the fields/attributes that belong to this business object
     FeatureName – Name of the field /attribute that belongs to this business object
     OwnerUID
     OwnerNameBelow is a list of endpoints to manage the ServiceDomain information

     

     Some of the key endpoint are highlighted in the red box, above.

     We recommend starting with one of the /BusinessObjectsBasic endpoints, to get the BianId and Name for each Business Object. The BianId or Name can then be used to call one of the other endpoints to get detailed information about each Business Object.

     If you need to have the entire dataset, then please call one of the GET /BusinessObjects endpoints; in this case you will need to use pagination as described in the endpoint description.

     Please expand each endpoint in the API definition to find more information and on how to call it.

  3. Business Object Classes

     These group of endpoints provide the ability to GET and POST (if you are providing a reference implementation or feedback) data related to Business Object Classes.

     The schema as available in the API definition is as follows:

     

     Some of the key fields such are highlighted in the red boxes, above:

     BianId
     Name
     Description
     AttributeList - List of fields/attributes that belong to this business object class

     For each Attribute:

     BianId
     Name
     Description
     And one of:
     a. BOEnumeration – If the attribute is a BO Enumeration, then the BO Enumeration object is defined, else it is null.
     b. BODataType – If the attribute is a BO DataType, then the BO DataType object is defined, else it is null.
     c. BOPrimitiveType – If the attribute is a BO DataType, then the BO DataType object is defined, else it is null.

     

     Some of the key endpoint are highlighted in the red box, above.

     We recommend starting with one of the /BOClassesBasic endpoints, to get the BianId and Name for each Business Object. The BianId or Name can then be used to call one of the other endpoints to get detailed information about each Business Object Class.

     If you need to have the entire dataset, then please call one of the GET /BOClasses endpoints; in this case you will need to use pagination as described in the endpoint description.

     Please expand each endpoint in the API definition to find more information and on how to call it.

  4. Business Object Enumerations

     These group of endpoints provide the ability to GET and POST (if you are providing a reference implementation or feedback) data related to Business Object Enumerations.

     The schema as available in the API definition is as follows:

     

     Some of the key fields such are highlighted in the red boxes, above:

     BianId
     Name
     Description
     AttributeList - List of fields/attributes that belong to this business object enumeration

     For each Attribute:

     BianId
     Name
     Description
     EnumerationLiterals – each EnumerationLiteral is one possible value of the enumeration. Each Enumeration Literal has key attributes such as BianId, Name, and Description.

     

     Some of the key endpoint are highlighted in the red box, above.

     We recommend starting with one of the /BOEnumerationsBasic endpoints, to get the BianId and Name for each Business Object. The BianId or Name can then be used to call one of the other endpoints to get detailed information about each Business Object Enumeration.

     If you need to have the entire dataset, then please call one of the GET /BOEnumerations endpoints; in this case you will need to use pagination as described in the endpoint description.

     Please expand each endpoint in the API definition to find more information and on how to call it.

  5. Business Object Data Types

     These group of endpoints provide the ability to GET and POST (if you are providing a reference implementation or feedback) data related to Business Object Data Types.

     The schema as available in the API definition is as follows:

     

     Some of the key fields such are highlighted in the red boxes, above:

     BianId
     Name
     Description

     

      

     Some of the key endpoint are highlighted in the red box, above.

     We recommend starting with one of the /BODataTypesBasic endpoints, to get the BianId and Name for each Business Object. The BianId or Name can then be used to call one of the other endpoints to get detailed information about each Business Object Data Type.

     If you need to have the entire dataset, then please call one of the GET /BODataTypes endpoints.

     Please expand each endpoint in the API definition to find more information and on how to call it

  6. Business Object Primitive Types

     These group of endpoints provide the ability to GET and POST (if you are providing a reference implementation or feedback) data related to Business Object Primitive Types.

     The schema as available in the API definition is as follows:

     

     Some of the key fields such are highlighted in the red boxes, above:

     BianId
     Name
     Description

     

     Some of the key endpoint are highlighted in the red box, above.

     We recommend starting with one of the /BOPrimitiveTypesBasic endpoints, to get the BianId and Name for each Business Object Primitive Type. The BianId or Name can then be used to call one of the other endpoints to get detailed information about each Business Object Primitive Type.

     If you need to have the entire dataset, then please call one of the GET /BOPrimitiveTypes endpoints.

     Please expand each endpoint in the API definition to find more information and on how to call it

  7. Business Scenarios

     These group of endpoints provide the ability to GET and POST (if you are providing a reference implementation or feedback) data related to Business Scenarios.

     The schema as available in the API definition is as follows:

     

     Some of the key fields such are highlighted in the red boxes, above:

     BianId
     Name
     Description

     ServiceConnections – each ‘ServiceConnection’ contains:

     1. ‘FromServiceConectionPart’ – This is the Service Domain from where the Service Connection originates.  Key attribute: ‘
        ‘ServiceDomainName’
     2. ‘ToServiceConectionPart’ – This is the Service Domain to where the Service Connection is made.  Key attribute: ‘
        ‘ServiceDomainName’ and ‘ServiceOperationDescription’

        

        Some of the key endpoint are highlighted in the red box, above.

        We recommend starting with one of the /BusinessScenariosBasic endpoints, to get the BianId and Name for each Business Object. The BianId or Name can then be used to call one of the other endpoints to get detailed information about each Business Scenario.

        If you need to have the entire dataset, then please call one of the GET /BusinessScenarios endpoints; in this case you will need to use pagination as described in the endpoint description.

        Please expand each endpoint in the API definition to find more information and on how to call it.

  8. Scenario Groups – Groups of functionally related business scenarios

     These group of endpoints provide the ability to GET and POST (if you are providing a reference implementation or feedback) data related to (Business) Scenario Groups.

     The schema as available in the API definition is as follows:

     

     Some of the key fields such are highlighted in the red boxes, above:

     BianId
     Name
     Description

     BusinessScenarios - each BusinessScenario has the attributes needed to define them.

     Some of the key endpoint are highlighted in the red box, above.

     We recommend starting with one of the /ScenarioGroupsBasic endpoints, to get the BianId and Name for each Business Scenario. The BianId or Name can then be used to call one of the other endpoints to get detailed information about each Business Scenario.

     If you need to have the entire dataset, then please call one of the GET /ScenarioGroups endpoints; in this case you will need to use pagination as described in the endpoint description.

     Please expand each endpoint in the API definition to find more information and on how to call it.

  9. Service Domain APIs

     These group of endpoints provide the ability to GET and POST (if you are providing a reference implementation or feedback) data related to Service Domain APIs.

     The schema as available in the API definition is as follows:

     

     Some of the key fields such are highlighted in the red boxes, above:

     BianId
     Name
     Description
     OAS3_YAML – the YAML for the Service Domain API in OAS3 format.

      

     

     Some of the key endpoint are highlighted in the red box, above.

     We recommend starting with one of the GET /ApisBasic endpoints, to get the BianId and Name for each Business Object. The BianId or Name can then be used to call one of the other endpoints to get detailed information about each Service Domain API.

     If you need to have the entire dataset, then please call one of the GET /Apis endpoints.

     Please expand each endpoint in the API definition to find more information and on how to call it.

  10. Service Domain Information Html Pages (as in bian.org)

      These group of endpoints provide the ability to GET and POST (if you are providing a reference implementation or feedback) data related to Service Domain Information Html Pages.

      The schema as available in the API definition is as follows:

      

      Some of the key fields such are highlighted in the red boxes, above:

      BianId
      Name
      WpPageURL – URL of the html page (in the bian.org API Portal)
      HtmlContent – the content of the page in HTML format (in bian.org API Portal).

      The HtmlContent has the following key content:

      1. 1. A link to the BIAN API Console
         2. Executive Summary
         3. Examples of Use
         4. Related Business Scenarios
         5. Core Business Object
         6. Key Features

      

      Some of the key endpoint are highlighted in the red box, above.

      We recommend starting with one of the GET /HtmlPagesBasic endpoints, to get the BianId and Name for each Html Page. The BianId or Name can then be used to call one of the other endpoints to get detailed information about each HtmlPage.

      If you need to have the entire dataset, then please call one of the GET /HtmlPages endpoints.Please expand each endpoint in the API definition to find more information and on how to call it.