MTN Group Document API is one of 148 APIs that MTN Group publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Document. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
4 operations
across 2 paths,
and defines 46 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.
Requests are made against 2 base URLs: https://mtn.com/tmf-api/document/v4/, https://mtn.com/tmf-api/documentManagement.
The identity and technical contract details declared by the specification.
RelatedParty
object
Related Entity reference. A related party defines party or party role linked to a specific entity.
8 properties
2 required
CharacteristicRelationship2
object
Another Characteristic that is related to the current Characteristic;
5 properties
DocumentRef
object
7 properties
1 required
DocumentSpecification2
object
A document specification reference
8 properties
ExternalIdentifier
object
An identification of an entity that is owned by or originates in a software system different from the current system, for example a ProductOrder handed off fro…
7 properties
1 required
CharacteristicSpecificationRelationship
object
An aggregation, migration, substitution, dependency or exclusivity relationship between/among Characteristic specifications. The specification characteristic i…
9 properties
ConstraintRef
object
Constraint reference. The Constraint resource represents a policy/rule applied to an entity or entity spec.
8 properties
1 required
DocumentStatusType
string
Possible values for the status of a Document
RelatedParty2
object
Related Entity reference. A related party defines party or party role linked to a specific entity.
8 properties
2 required
Characteristic2
object
Describes a given characteristic of an object or entity through a name/value pair.
8 properties
2 required
AttachmentRefOrValue
object
An attachment by value or by reference. For AttachmentRefOrValue, the attribute type,schemaLocation and referredType are related to the contained entity and no…
14 properties
RelatedEntity
object
A reference to an entity, where the type of the entity is not known in advance.
8 properties
3 required
CharacteristicValueSpecification
object
specification of a value (number or text or an object) that can be assigned to a Characteristic.
11 properties
Error
object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
8 properties
2 required
TargetEntitySchema
object
The reference object to the schema and type of target entity which is described by a specification
2 properties
2 required
Error2
object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
6 properties
2 required
DocumentSpecification
object
A DocumentSpecification provides the characteristics and constraints that describe a particular type of Document. It follows the EntitySpecification pattern, s…
16 properties
DocumentSpecificationStatusType
string
Possible values for the status of a DocumentSpecification
TimePeriod
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
Document_Update
object
A Document describes the meta-data of a Document - such as the name, creationDate and lifecycle status. The (typically binary) body of this document (such as a…
5 properties
Document
object
A Document describes the meta-data of a Document - such as the name, creationDate and lifecycle status. The (typically binary) body of this document (such as a…
19 properties
Characteristic
object
Describes a given characteristic of an object or entity through a name/value pair.
7 properties
2 required
DocumentSpecificationRefOrValue
object
A DocumentSpecificationRefOrValue where you can select between a DocumentSpecification (by Value) or a DocumentSpecificationRef (by Reference)
17 properties
Document_Create
object
Document is a tangible output from an activity Skipped properties: id,href
16 properties
CategoryRef
object
The category for grouping recommendations
8 properties
1 required
CharacteristicRelationship
object
Another Characteristic that is related to the current Characteristic;
6 properties
ApiResponse
object
6 properties
Document2
object
Document is a tangible output from an activity
18 properties
TimePeriod2
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
RelatedEntity2
object
A reference to an entity, where the type of the entity is not known in advance.
8 properties
3 required
Quantity2
object
An amount in a given unit
2 properties
DocumentRef2
object
7 properties
1 required
CharacteristicSpecification
object
This class defines a characteristic specification.
17 properties
CategoryRef_2
object
Category reference. The category resource is used to group product offerings, service and resource candidates in logical containers. Categories can contain oth…
4 properties
DocumentSpecification_2
object
A document specification reference
5 properties
RelatedObject
object
Defines objects linked with trouble ticket.
2 properties
Attachment
object
Complements the description of an element (for instance a product) through video, pictures...
5 properties
TimePeriod_2
object
A base / value business entity used to represent a period of time between two timepoints.
2 properties
Document_Update_2
object
Document is a tangible output from an activity Skipped properties: id,href,id,href
8 properties
DocumentRef_2
object
2 properties
DocumentCharacteristic
object
is a list of name value pairs that define the document characteristics.
2 properties
Document_2
object
Document is a tangible output from an activity
16 properties
RelatedPartyRef
object
RelatedParty reference. A related party defines party or party role linked to a specific entity.
5 properties
DocumentRelationship
object
Another document that is related to the current document;
2 properties
Error_2
object
4 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs MTN Group publishes across the network.
