Mechanisms for BUS to query and retrieve *ServiceInstances*.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/mef-service-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
openapi: 3.2.0
info:
title: Mef Service API
version: '1.0'
description: 'Operations tagged Service across 3 of this provider''s published API definitions: mef-lso-allegro-service-inventory-management-openapi.yml, mef-lso-interlude-service-inventory-management-openapi.yml, mef-lso-legato-service-inventory-management-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{serverBase}/mefApi/allegro/serviceInventory/v2/
variables:
serverBase:
description: The base of SOF's URL.
default: mplify.net
- url: https://{serverBase}/mefApi/interlude/serviceInventory/v2/
variables:
serverBase:
description: The base of SOF's URL.
default: mplify.net
- url: https://{serverBase}/mefApi/legato/serviceInventory/v7/
variables:
serverBase:
description: The base of SOF's URL.
default: mplify.net
tags:
- name: Service
description: Mechanisms for BUS to query and retrieve *ServiceInstances*.
paths:
/service:
get:
tags:
- Service
summary: Lists services
description: This operation lists Service entities.
operationId: serviceFind
parameters:
- name: state
in: query
description: The state of the service
required: false
schema:
$ref: '#/components/schemas/ServiceStateType'
- name: serviceDate.lt
in: query
description: Less than the date when the service was created (whatever its status)
required: false
schema:
type: string
format: date-time
- name: serviceDate.gt
in: query
description: Greater than the date when the service was created (whatever its status)
required: false
schema:
type: string
format: date-time
- name: startDate.lt
in: query
description: Less than the date when the service starts
required: false
schema:
type: string
format: date-time
- name: startDate.gt
in: query
description: Greater than the date when the service starts
required: false
schema:
type: string
format: date-time
- name: endDate.lt
in: query
description: Less than the date when the service ends
required: false
schema:
type: string
format: date-time
- name: endDate.gt
in: query
description: Greater than the date when the service ends
required: false
schema:
type: string
format: date-time
- name: serviceOrder.id
in: query
description: A reference to a service order related to this service. Must be used together with serviceOrderItem.id
required: false
schema:
type: string
- name: serviceOrderItem.id
in: query
description: A reference to a service order item related to this service. Must be used together with serviceOrder.id
required: false
schema:
type: string
- name: externalId
in: query
description: An externalId provided in the service order
required: false
schema:
type: string
- name: geographicSite.id
in: query
description: A GeographicSite identifier which is associated to this service
required: false
schema:
type: string
- name: geographicAddress.id
in: query
description: A GeographicAddress identifier which is associated to this service
required: false
schema:
type: string
- name: serviceType
in: query
description: Business type of the service
required: false
schema:
type: string
- name: '@type'
in: query
description: The `@type` of `MefServiceConfiguration`. This is used to filter the services by the precise `urn` of the Product Schema they have.
required: false
schema:
type: string
- name: startMode
in: query
description: "This attribute is an enumerated integer that indicates how the \nService is started, such as: 0: Unknown; 1: Automatically by \nthe managed environment; 2: Automatically by the owning device; \n3: Manually by the Provider of the Service; 4: Manually by a \nCustomer of the Provider; 5: Any of the above"
required: false
schema:
type: string
enum:
- '0'
- '1'
- '2'
- '3'
- '4'
- '5'
- name: offset
in: query
description: Requested index for start of item to be provided in response requested by client. Note that the index starts with "0".
required: false
schema:
type: integer
format: int32
- name: limit
in: query
description: Requested number of items to be provided in response requested by client
required: false
schema:
type: integer
format: int32
responses:
'200':
description: OK. (https://tools.ietf.org/html/rfc7231#section-6.3.1)
headers:
X-Pagination-Throttled:
description: 'Used to indicate that result page was throttled to maximum possible size and there are additional results that can be fetched
'
schema:
type: boolean
X-Total-Count:
description: 'The total number of matching items. E.g. if there are 50 matching items in total, but the request has offset=10 and limit=10, then the X-Total-Count is 50.
'
schema:
type: integer
X-Result-Count:
description: The number of items included in the response
schema:
type: integer
content:
application/json;charset=utf-8:
schema:
type: array
items:
$ref: '#/components/schemas/Service'
'400':
description: Bad Request
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error400'
'401':
description: Unauthorized
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error401'
'403':
description: Forbidden
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error403'
'422':
description: Unprocessable entity due to the business validation problems
content:
application/json;charset=utf-8:
schema:
type: array
items:
$ref: '#/components/schemas/Error422'
'500':
description: Internal Server Error
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error500'
deprecated: false
servers:
- url: https://{serverBase}/mefApi/allegro/serviceInventory/v2/
variables:
serverBase:
description: The base of SOF's URL.
default: mplify.net
/service/{id}:
get:
tags:
- Service
summary: Retrieve a service
description: This operation retrieves a service entity.
operationId: serviceGet
parameters:
- name: id
in: path
description: Identifier of the Service instance
required: true
schema:
type: string
responses:
'200':
description: OK. (https://tools.ietf.org/html/rfc7231#section-6.3.1)
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Service'
'400':
description: Bad Request
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error400'
'401':
description: Unauthorized
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error401'
'403':
description: Forbidden
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error403'
'404':
description: Not Found
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error404'
'500':
description: Internal Server Error
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error500'
servers:
- url: https://{serverBase}/mefApi/allegro/serviceInventory/v2/
variables:
serverBase:
description: The base of SOF's URL.
default: mplify.net
components:
schemas:
RelatedPlaceRefOrQuery:
description: Allows pointing to a place by referring to a GeographicAddress, GeographicSite, or providing GeographicAddress by value. It also provides additional information like the `role` the place plays for given Product and `contact` needed access to this place.
type: object
properties:
place:
$ref: '#/components/schemas/PlaceRefOrQuery'
role:
description: Role of this place. The values that can be specified here are described by Product Specification (e.g. "INSTALL_LOCATION").
type: string
contact:
description: The person to call to get access to this place in case such access is required to complete the evaluation of this POQ Item.
type: array
items:
$ref: '#/components/schemas/ContactInformation'
required:
- place
- role
ContactInformation:
description: Contact data for a person or organization that is involved in the product offering qualification. In a given context it is always specified by the SOF (e.g. SOF Contact Information) or by the BUS.
type: object
properties:
number:
description: Phone number
type: string
emailAddress:
description: Email address
type: string
postalAddress:
description: Identifies the postal address of the person or office to be contacted.
$ref: '#/components/schemas/FieldedAddressRepresentation'
organization:
description: The organization or company that the contact belongs to
type: string
name:
description: Name of the contact
type: string
numberExtension:
description: Phone number extension
type: string
required:
- emailAddress
- name
- number
PlaceRefOrQuery:
description: A place described by reference to a Geographic Address, Geographic Site or by Geographic Address Representations.
type: object
discriminator:
propertyName: '@type'
mapping:
GeographicAddressRef: '#/components/schemas/GeographicAddressRef'
GeographicSiteRef: '#/components/schemas/GeographicSiteRef'
GeographicAddress_Query: '#/components/schemas/GeographicAddress_Query'
oneOf:
- $ref: '#/components/schemas/GeographicAddressRef'
- $ref: '#/components/schemas/GeographicSiteRef'
- $ref: '#/components/schemas/GeographicAddress_Query'
GeographicAddressRef:
description: 'A reference to a Geographic Address resource available through Address Validation API.
'
type: object
properties:
href:
description: 'Hyperlink to the referenced Address. Hyperlink MAY be used by the SOF in responses. Hyperlink MUST be ignored by the SOF in case it is provided by the BUS in a request.
'
type: string
id:
description: Identifier of the referenced Geographic Address. This identifier is assigned during a successful address validation request (Geographic Address Management API)
type: string
'@type':
description: Used to unambiguously designate the class type when using `oneOf`
type: string
enum:
- GeographicAddressRef
required:
- '@type'
- id
Error403Code:
description: 'This code indicates that the server understood
the request but refuses to authorize it because
of one of the following error codes:
- accessDenied: Access denied
- forbiddenRequester: Forbidden requester
- tooManyUsers: Too many users'
type: string
enum:
- accessDenied
- forbiddenRequester
- tooManyUsers
Service:
description: The Service instance managed by SOF and retrievable by BA
type: object
properties:
id:
description: unique identifier of a Service
type: string
href:
description: Hyperlink reference to a Service
type: string
description:
description: Free-text description of the service
type: string
endDate:
description: 'Date when the service ends
'
type: string
format: date-time
externalId:
description: ID given by the consumer to facilitate searches
type: string
note:
description: Extra-information about the order; e.g. useful to add extra delivery information that could be useful for a human process
type: array
items:
$ref: '#/components/schemas/Note_BusSof'
place:
description: The relationships between this Service Order Item and one or more Places as defined in the Service Specification.
type: array
items:
$ref: '#/components/schemas/RelatedPlaceRefOrQuery'
relatedContactInformation:
description: Contact information of an individual or organization playing a role for this Service.
type: array
items:
$ref: '#/components/schemas/RelatedContactInformation'
serviceConfiguration:
description: MefServiceConfiguration is used to specify the MEF specific service payload. This field MUST be populated for all item 'actions' other than 'delete'. It MUST NOT be populated when an item `action` is `delete`. The @type is used as a discriminator.
$ref: '#/components/schemas/MefServiceConfiguration'
serviceDate:
description: Date when the service was created (whatever its status).
type: string
serviceOrderItem:
description: A list of service order items related to this service
type: array
items:
$ref: '#/components/schemas/ServiceOrderItemRef'
serviceRelationship:
description: Specifies the type (nature) of the relationship to the related Service. The nature of required relationships varies for Services of different types. For example, a UNI or ENNI Service may not have any relationships, but an Access E-Line may have two mandatory relationships (related to the UNI on one end and the ENNI on the other). More complex Services such as multipoint IP or Firewall Services may have more complex relationships. As a result, the allowed and mandatory `relationshipType` values are defined in the Service Specification.
type: array
items:
$ref: '#/components/schemas/ServiceRelationship'
serviceType:
description: Business type of the service
type: string
startDate:
description: Date when the service starts
type: string
format: date-time
startMode:
description: "This attribute is an enumerated integer that indicates how the \nService is started, such as: 0: Unknown; 1: Automatically by \nthe managed environment; 2: Automatically by the owning device; \n3: Manually by the Provider of the Service; 4: Manually by a \nCustomer of the Provider; 5: Any of the above"
type: string
enum:
- '0'
- '1'
- '2'
- '3'
- '4'
- '5'
state:
description: The life cycle state of the service.
$ref: '#/components/schemas/ServiceStateType'
required:
- id
- state
MefServiceConfiguration:
description: MefServiceConfiguration is used as an extension point for MEF specific service payload. The `@type` attribute is used as a discriminator
type: object
properties:
'@type':
description: The value of the "$id" as defined in the JSON schema of the service.
type: string
required:
- '@type'
discriminator:
propertyName: '@type'
ServiceRef:
description: Reference to a Service instance.
type: object
properties:
href:
description: Hyperlink reference to Service
type: string
id:
description: unique identifier of Service
type: string
required:
- id
LabelRepresentation:
description: A unique identifier controlled by a generally accepted independent administrative authority that specifies a fixed geographical location.
type: object
properties:
label:
description: The unique reference to a Geographic Address assigned by the Administrative Authority.
type: string
administrativeAuthority:
description: The organization or standard from the organization that administers this Geographic Address Label ensuring it is unique within the Administrative Authority.
type: string
language:
description: The language in which the label is expressed. Based on ISO 639:2023
type: string
minLength: 2
maxLength: 2
required:
- administrativeAuthority
- label
BusSofType:
description: An enumeration with BUS and SOF values.
type: string
enum:
- bus
- sof
FieldedAddressRepresentation:
description: A type of Address that has a discrete field and value for each type of boundary or identifier down to the lowest level of detail. For example "street number" is one field, "street name" is another field, etc.
type: object
properties:
streetNr:
description: Number identifying a specific property on a public street. It may be combined with streetNrLast for ranged addresses.
type: string
streetNrSuffix:
description: The first street number suffix (in a street number range) or the suffix for the street number if there is no range
type: string
streetNrLast:
description: Last number in a range of street numbers allocated to an Address
type: string
streetNrLastSuffix:
description: Last street number suffix for a ranged Address
type: string
streetPreDirection:
description: The direction of the street that appears before the Street Name
type: string
streetName:
description: Name of the street or other street type
type: string
streetType:
description: The type of street (e.g., alley, avenue, boulevard, brae, crescent, drive, highway, lane, terrace, parade, place, tarn, way, wharf)
type: string
streetPostDirection:
description: A modifier denoting a relative direction that appears after the Street Name.
type: string
poBox:
description: Number identifying a specific location in a post office.
type: string
locality:
description: An area of defined or undefined boundaries within a local authority or other legislatively defined area.
type: string
city:
description: City in which the Address is located.
type: string
postcode:
description: A descriptor for a postal delivery area used to speed and simplify the delivery of mail (also known as zip code)
type: string
postcodeExtension:
description: 'The extension used on a postal code. Note: there are different use codes for this attribute depending upon the country.'
type: string
stateOrProvince:
description: The State or Province in which the Address is located.
type: string
countryCode:
description: Country in which the Address is located, defined using two characters as defined in ISO 3166
type: string
minLength: 2
maxLength: 2
subUnit:
description: The Sub Unit represented as a list. This is a list to allow complex sub-unit information such as SUITE 42 ROOM A
type: array
items:
$ref: '#/components/schemas/SubUnit'
buildingName:
description: 'The well-known name of a building that is located at this Address (e.g., where there is one Address for a campus).
'
type: string
privateStreetNumber:
description: Street number on a private street within the Address.
type: string
privateStreetName:
description: Private streets internal to a property (e.g., a university) may have internal names that are not recorded by the land title office.
type: string
language:
description: The language in which the address is expressed. It MUST use the ISO 639:2023 two letter code 639:2023
type: string
minLength: 2
maxLength: 2
ServiceRelationship:
description: A relationship to an existing Service. The requirements for usage for given Service are described in the Service Specification.
type: object
properties:
relationshipType:
description: 'Specifies the type (nature) of the relationship to the related
Service. The nature of required relationships varies for Services of
different types. For example, a UNI or ENNI Service may not have any
relationships, but an Access E-Line may have two mandatory
relationships (related to the UNI on one end and the ENNI on the
other). More complex Services such as multipoint IP or Firewall
Services may have more complex relationships. As a result, the
allowed and mandatory `relationshipType` values are defined in the
Service Specification.
'
type: string
service:
description: A reference to a Service
$ref: '#/components/schemas/ServiceRef'
required:
- relationshipType
- service
Error401Code:
description: 'One of the following error codes:
- missingCredentials: No credentials provided.
- invalidCredentials: Provided credentials are invalid or expired'
type: string
enum:
- missingCredentials
- invalidCredentials
Error400:
description: Bad Request. (https://tools.ietf.org/html/rfc7231#section-6.5.1)
allOf:
- $ref: '#/components/schemas/Error'
- type: object
properties:
code:
description: 'One of the following error codes:
- missingQueryParameter: The URI is missing a required query-string parameter
- missingQueryValue: The URI is missing a required query-string parameter value
- invalidQuery: The query section of the URI is invalid.
- invalidBody: The request has an invalid body'
$ref: '#/components/schemas/Error400Code'
required:
- code
Error500:
description: Internal Server Error. (https://tools.ietf.org/html/rfc7231#section-6.6.1)
allOf:
- $ref: '#/components/schemas/Error'
- type: object
properties:
code:
description: 'The following error code:
- internalError: Internal server error - the server encountered an unexpected condition that prevented it from fulfilling the request.'
type: string
enum:
- internalError
required:
- code
GeographicSiteRef:
description: 'A reference to a Geographic Site resource available through Service Site API
'
type: object
properties:
href:
description: 'Hyperlink to the referenced Site. Hyperlink MAY be used by the SOF in responses. Hyperlink MUST be ignored by the SOF in case it is provided by the BUS in a request.
'
type: string
id:
description: Identifier of the referenced Geographic Site.
type: string
'@type':
description: Used to unambiguously designate the class type when using `oneOf`
type: string
enum:
- GeographicSiteRef
required:
- '@type'
- id
Error400Code:
description: 'One of the following error codes:
- missingQueryParameter: The URI is missing a required query-string parameter
- missingQueryValue: The URI is missing a required query-string parameter value
- invalidQuery: The query section of the URI is invalid.
- invalidBody: The request has an invalid body'
type: string
enum:
- missingQueryParameter
- missingQueryValue
- invalidQuery
- invalidBody
GeographicPointRepresentation:
description: 'A GeographicPointRepresentation defines a geographic point through coordinates.
'
type: object
properties:
spatialRef:
description: The spatial reference system used to determine the coordinates. The system used and the value of this field are to be agreed during the onboarding process.
type: string
latitude:
description: The latitude expressed in the format specified by the `spacialRef`
type: string
longitude:
description: The longitude expressed in the format specified by the `spacialRef`
type: string
elevation:
description: The elevation expressed in the format specified by the `spacialRef`
type: string
required:
- latitude
- longitude
- spatialRef
Error401:
description: Unauthorized. (https://tools.ietf.org/html/rfc7235#section-3.1)
allOf:
- $ref: '#/components/schemas/Error'
- type: object
properties:
code:
description: 'One of the following error codes:
- missingCredentials: No credentials provided.
- invalidCredentials: Provided credentials are invalid or expired'
$ref: '#/components/schemas/Error401Code'
required:
- code
SubUnit:
description: Allows for sub unit identification
type: object
properties:
subUnitNumber:
description: The discriminator used for the subunit, often just a simple number but may also be a range.
type: string
subUnitType:
description: The type of subunit e.g. BERTH, FLAT, PIER, SUITE, SHOP, TOWER, UNIT, WHARF.
type: string
required:
- subUnitNumber
- subUnitType
Note_BusSof:
description: Extra information about a given entity. Only useful in processes involving human interaction. Not applicable for an automated process.
type: object
properties:
author:
description: Author of the note
type: string
date:
description: Date of the note
type: string
format: date-time
id:
description: Identifier of the note within its containing entity (may or may not be globally unique, depending on provider implementation)
type: string
source:
description: Indicates if this Note was added by BUS or SOF.
$ref: '#/components/schemas/BusSofType'
text:
description: Text of the note
type: string
required:
- author
- date
- id
- source
- text
RelatedContactInformation:
description: Contact information of an individual or organization playing a role for this Order Item. The rule for mapping a represented attribute value to a `role` is to use the _lowerCamelCase_ pattern. In a given context it is always specified by the SOF (e.g. SOF Contact Information) or by the BUS.
type: object
properties:
role:
description: The role of the particular contact in the request
type: string
number:
description: Phone number
type: string
emailAddress:
description: Email address
type: string
postalAddress:
description: Identifies the postal address of the person or office to be contacted.
$ref: '#/components/schemas/FieldedAddressRepresentation'
organization:
description: The organization or company that the contact belongs to
type: string
name:
description: Name of the contact
type: string
numberExtension:
description: Phone number extension
type: string
required:
- emailAddress
- name
- number
- role
GeographicAddress_Query:
description: A list of representations being a subset of Geographic Address entity. This is to be used when providing a list of representations to validate a Geographic Address
type: object
properties:
fieldedAddressRepresentation:
description: A list of Fielded Address representations
type: array
items:
$ref: '#/components/schemas/FieldedAddressRepresentation'
formattedAddressRepresentation:
description: A list of Formatted Address representations
type: array
items:
$ref: '#/components/schemas/FormattedAddressRepresentation'
geographicPointRepresentation:
description: A list of Geographic Point Address representations
type: array
items:
$ref: '#/components/schemas/GeographicPointRepresentation'
labelRepresentation:
description: A list of Label Address representations
type: array
items:
$ref: '#/components/schemas/LabelRepresentation'
'@type':
description: Used to unambiguously designate the class type when using `oneOf`
type: string
enum:
- GeographicAddress_Query
minProperties: 2
required:
- '@type'
Error:
description: 'Standard Class used to describe API response error Not intended to be used directly. The `code` in the HTTP header is used as a discriminator for the type of error returned in runtime.
'
type: object
properties:
message:
description: Text that provides mode details and corrective actions related to the error. This can be shown to a client user.
type: string
reason:
description: Text that explains the reason for the error. This can be shown to a client user.
type: string
maxLength: 255
referenceError:
description: URL pointing to documentation describing the error
type: string
format: uri
required:
- reason
Error422:
description: Unprocessable entity due to a business validation problem. (https://tools.ietf.org/html/rfc4918#section-11.2)
allOf:
- $ref: '#/components/schemas/Error'
- type: object
properties:
code:
description: "One of the following error codes:\n - missingProperty: The property that was expected is not present in the payload\n - invalidValue: The property has an incorrect value\n - invalidFormat: The property value does not comply with the expected value format\n - referenceNotFound: The object referenced by the property cannot be identified in the target system\n - unexpectedProperty: Additional, not expected property has been provided\n - tooManyRecords: the number of records to be provided in the response exceeds the threshold.\n - otherIssue: Other problem was identified (detailed information provided in a reason
# --- truncated at 32 KB (37 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mef/refs/heads/main/openapi/mef-service-api-openapi.yml