Skip to main content

portability_statuses

Creates, updates, deletes, gets or lists a portability_statuses resource.

Overview​

Nameportability_statuses
TypeResource
Idovh.telephony.portability_statuses

Fields​

The following fields are returned by SELECT queries:

A step in the portability process

NameDatatypeDescription
namestringThe name of the portability step (acknowledgmentReceivedFromOperator, belgiumPortabilityRequestCreated, belgiumPortabilityRequestExecutionAcked, belgiumPortabilityRequestExecutionAsked, belgiumPortabilityRequestExecutionCompleted, belgiumPortabilityRequestValidated, belgiumPortabilityRequestWaitingUntilExec, customerFormReceived, customerFormSent, customerFormValidated, finalReportReceivedFromOperator, intermediateReportReceivedFromOperator, numberActivation, requestSentToOperator, sDASequenceReceivedFromOperator)
descriptionstringA brief description of the step
done_datestring (date-time)The date when this step was done (wire: doneDate)
durationobjectThe theoric delay between the previous step's done date and this step's done date
infosobjectAdditional informations about the step
statusstringIndicates if the step is to do, currently doing or done (cancelled, doing, done, error, hold, todo)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectbilling_account, idGet the porting status

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
api_hoststringThe OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
billing_accountstringThe name of your billingAccount (wire: billingAccount)
idintegerThe ID of the portability

SELECT examples​

Get the porting status

SELECT
name,
description,
done_date,
duration,
infos,
status
FROM ovh.telephony.portability_statuses
WHERE billing_account = '{{ billing_account }}' -- required
AND id = '{{ id }}' -- required
;