TM Forum organization API
Operations for Organization Resource
TM Forum organization API is one of 38 APIs that TM Forum publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include organization. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 5 operations across 2 paths, and defines 119 schemas. It is described by OpenAPI 3.0.1, at version 5.0.0.
Requests are made against a single base URL, https://serverRoot/productCatalogManagement/v5/.
5 operations
2 paths
119 schemas
1 DELETE2 GET1 PATCH1 POST
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 5
Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.
organization 5
Operations for Organization Resource
GET
/organization
TM Forum List or Find Organization Objects
POST
/organization
TM Forum Creates a Organization
GET
/organization/{id}
TM Forum Retrieves a Organization by ID
PATCH
/organization/{id}
TM Forum Updates Partially a Organization
DELETE
/organization/{id}
TM Forum Deletes a Organization
Schemas 119
The contract defines 119 schemas that model the data the API accepts and returns. The most detailed are OtherNameIndividual (12 properties), LanguageAbility (8 properties), Skill (5 properties), JsonPatch (4 properties). Each schema is shown below with its type and property counts.
AgreementRef
object
Agreement reference. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agre…
ContactMedium
EntityRef_FVO
PartyOrPartyRole_FVO
object
Supplier_MVO
object
When business partner is the Supplier
OrganizationChildRelationship_MVO
PartyRoleRef_MVO
Producer
object
Attachment
OtherNameOrganization_FVO
PartyCreditProfile_FVO
PaymentMethodRef
object
PaymentMethod reference. A payment method defines a specific mean of payment (e.g direct debit).
AccountRef
object
Account reference. A account may be a party account or a financial account.
CreditProfile_MVO
OrganizationParentRelationship_MVO
PartyRoleRef_FVO
Party_FVO
Characteristic_FVO
Producer_FVO
object
OrganizationRef_FVO
object
Supplier_FVO
object
When business partner is the Supplier
Organization
OtherNameOrganization
OrganizationRef
object
Extensible_FVO
object
Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
3 properties
1 required
BusinessPartner_FVO
object
When business partner is the BusinessPartner
Consumer_FVO
object
PartyCreditProfile
TaxExemptionCertificate
JsonPatchOperations
array
JSONPatch Operations document as defined by RFC 6902
OrganizationParentRelationship
IndividualStateType
string
Valid values for the lifecycle state of the individual
ContactMedium_MVO
Quantity
object
An amount in a given unit
2 properties
Organization_FVO
CharacteristicRelationship_MVO
PartyRoleRef
Individual_FVO
Attachment_FVO
OrganizationParentRelationship_FVO
CreditProfile
OtherNameIndividual
object
Keeps track of other names, for example the old name of a woman before marriage or an artist name.
12 properties
Entity_FVO
object
Base entity schema for use in TMForum Open-APIs. Property.
PartyRole_FVO
Individual
OrganizationChildRelationship
AttachmentRefOrValue_FVO
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the Attachment entity and not the AttachmentRefOrValue class itself
IndividualIdentification_MVO
PartyCreditProfile_MVO
LanguageAbility
object
Ability of an individual to understand or converse in a language.
8 properties
ExternalIdentifier_MVO
PartyRef_MVO
object
A Party reference
AgreementRef_FVO
object
Agreement reference. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agre…
Party
Disability
object
Lack or inadequate strength or ability.
3 properties
PaymentMethodRef_MVO
object
PaymentMethod reference. A payment method defines a specific mean of payment (e.g direct debit).
RelatedPartyOrPartyRole_MVO
TaxDefinition_MVO
Producer_MVO
object
TaxDefinition_FVO
PartyRef
object
A Party reference
Individual_MVO
BusinessPartner_MVO
object
When business partner is the BusinessPartner
Party_MVO
Entity_MVO
object
Base entity schema for use in TMForum Open-APIs. Property.
TaxExemptionCertificate_MVO
TaxDefinition
OrganizationRef_MVO
object
TaxExemptionCertificate_FVO
Characteristic_MVO
Attachment_MVO
IndividualIdentification
CreditProfile_FVO
OrganizationChildRelationship_FVO
OrganizationIdentification_FVO
PaymentMethodRef_FVO
object
PaymentMethod reference. A payment method defines a specific mean of payment (e.g direct debit).
OrganizationIdentification
Error
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
CharacteristicRelationship
JsonPatch
object
A JSONPatch document as defined by RFC 6902
4 properties
2 required
AccountRef_MVO
object
Account reference. A account may be a party account or a financial account.
Entity
object
Base entity schema for use in TMForum Open-APIs. Property.
TimePeriod
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
Consumer_MVO
object
RelatedPartyOrPartyRole_FVO
ContactMedium_FVO
PartyRoleSpecificationRef
object
Party role specification reference. A party role specification gives additional details on the part played by a party in a given context.
IndividualIdentification_FVO
RelatedPartyOrPartyRole
Organization_MVO
OtherNameOrganization_MVO
OrganizationIdentification_MVO
OrganizationStateType
string
Valid values for the lifecycle state of the organization
AttachmentRefOrValue_MVO
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the Attachment entity and not the AttachmentRefOrValue class itself
AttachmentRef_MVO
CharacteristicRelationship_FVO
PartyRole_MVO
Characteristic
PartyRoleSpecificationRef_MVO
object
Party role specification reference. A party role specification gives additional details on the part played by a party in a given context.
ExternalIdentifier
PartyRoleSpecificationRef_FVO
object
Party role specification reference. A party role specification gives additional details on the part played by a party in a given context.
Addressable
object
Base schema for adressable entities
2 properties
PartyRole
PartyRef_FVO
object
A Party reference
AttachmentRefOrValue
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the Attachment entity and not the AttachmentRefOrValue class itself
PartyOrPartyRole_MVO
object
Skill
object
Skills evaluated for an individual with a level and possibly with a limited validity when an obsolescence is defined (Ex: the first-aid certificate first level…
5 properties
AccountRef_FVO
object
Account reference. A account may be a party account or a financial account.
Addressable_FVO
object
Base schema for adressable entities
1 property
BusinessPartner
object
When business partner is the BusinessPartner
AttachmentRef_FVO
Supplier
object
When business partner is the Supplier
PartyOrPartyRole
object
Extensible
object
Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
3 properties
1 required
EntityRef
ExternalIdentifier_FVO
Consumer
object
AttachmentRef
AgreementRef_MVO
object
Agreement reference. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agre…
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from TM Forum 12
Other APIs TM Forum publishes across the network.
TM Forum agreement API
TM Forum agreementSpecification API
TM Forum billFormat API
TM Forum billingAccount API
TM Forum billingCycleSpecification API
TM Forum billPresentationMedia API
TM Forum cancelProductOrder API
TM Forum cancelServiceOrder API
TM Forum category API
TM Forum customer API
TM Forum events subscription API
TM Forum exportJob API
#organization