How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

TM Forum Resource Candidate API

The resourceCandidate API from TM Forum — 2 operation(s) for resourcecandidate.

TM Forum Resource Candidate API is one of 38 APIs that TM Forum publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 2 paths, and defines 7 schemas. It is described by OpenAPI 3.2.0, at version 4.0.0.

Requests are made against a single base URL, https://serverRoot/tmf-api/resourceCatalog/v4/.

5 operations 2 paths 7 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
4.0.0
Server
https://serverRoot/tmf-api/resourceCatalog/v4/
Resource Areas
1

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.

resourceCandidate 5
GET
/resourceCandidate
List or find ResourceCandidate objects
listResourceCandidate 3 params → 200400401403404405409500
POST
/resourceCandidate
Creates a ResourceCandidate
createResourceCandidate body → 201400401403405409500
GET
/resourceCandidate/{id}
Retrieves a ResourceCandidate by ID
retrieveResourceCandidate 2 params → 200400401403404405409500
PATCH
/resourceCandidate/{id}
Updates partially a ResourceCandidate
patchResourceCandidate 1 param body → 200400401403404405409500
DELETE
/resourceCandidate/{id}
Deletes a ResourceCandidate
deleteResourceCandidate 1 param → 204400401403404405409500

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are ResourceCandidate (13 properties), ResourceCandidate_Create (11 properties), ResourceCandidate_Update (11 properties), Error (8 properties). Each schema is shown below with its type and property counts.

ResourceCategoryRef
object
The (resource) category resource is used to group resource candidates in logical containers. Categories can contain other categories.
8 properties 1 required
ResourceSpecificationRef
object
Resources are physical or non-physical components (or some combination of these) within an enterprise's infrastructure or inventory. They are typically consume…
8 properties 1 required
ResourceCandidate_Update
object
ResourceCandidate is an entity that makes a resource specification available to a catalog. A ResourceCandidate and its associated resource specification may be…
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
TimePeriod
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
ResourceCandidate
object
ResourceCandidate is an entity that makes a resource specification available to a catalog. A ResourceCandidate and its associated resource specification may be…
13 properties
ResourceCandidate_Create
object
ResourceCandidate is an entity that makes a resource specification available to a catalog. A ResourceCandidate and its associated resource specification may be…
11 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tm-forum-resourcecandidate-api-openapi.yml Raw ↑

Other APIs TM Forum publishes across the network.

TM Forum Agreement API
TM Forum Agreement Specification API
TM Forum Bill Format API
TM Forum Billing Cycle Specification API
TM Forum Bill Presentation Media API
TM Forum Cancel Product Order API
TM Forum Cancel Service Order API
TM Forum Category API
TM Forum Customer API
TM Forum events subscription API
TM Forum Individual API
TM Forum notification listener API
Where this information came from

This is an independent, third-party profile of TM Forum Resource Candidate API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.