logo
API docs by Redocly

Provisioning (2.03)

Download OpenAPI specification:Download

This Provisioning API provides developers a way to query and update items related to provisioning activities.

System Integrity

Resources related to system integrity.

Health Check

Use to check whether or not the Provisioning service is up and running.

Responses

Provisioning Command

Resources related to provisioning commands.

Search For ProvisioningCommands

Search for provisioning commands.

Available Fields

The following is a list of fields from the mock endpoint and how they can be used within the search.

  • Filterable : command, customerID, parameter1, parameter2, priority, provisioningCommandID, provisioningCompany, provisioningCompanyID, queueDate, requestGUID, responseDate, status, statusID, userID
  • Sortable : command, customerID, parameter1, parameter2, priority, provisioningCommandID, provisioningCompany, provisioningCompanyID, queueDate, requestGUID, responseDate, status, statusID, userID
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=provisioningCommandID eq 1234

A structured search expression in standard OData syntax.

$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=provisioningCompanyID

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order. If no $orderby is specified, the default sort order is descending by provisioningCommandID.

$select
string
Example: $select=provisioningCompanyID

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
number
Example: $skip=10

Number of search results to skip.

$skiptoken
number
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
number
Example: $top=1

Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "@nextLink": "https://subdomain.idibilling.com/provisioning/an_environment/api/odataquery?$filter=name eq",
  • "value": [
    ]
}

Cancel a Provisioning Command

Sets the status of a provisioning command to canceled if it is not already Failed or Succeeded

Authorizations:
SWT
path Parameters
provisioningCommandID
required
number
Example: 1

Unique identifier for the provisioning command to be canceled.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Create a ProvisioningCommand

Create a single provisioning command.

Authorizations:
SWT
header Parameters
contentType
required
string
Example: application/json
Request Body schema: application/json
command
required
string

The command for provisioning to execute.

createUser
required
string

The user that created the provisioning command.

provisioningCompanyID
required
number

The unique identifier of the provisioning company processing the provisioning command.

customerID
number

The unique identifier of the customer associated with the provisioning command.

parameter1
string

A parameter used to process the provisioning command.

parameter2
string

A parameter used to process the provisioning command.

priority
number

The priority of the provisioning command. Provisioning commands with higher priortities are processed first.

requestGUID
string

A Globally Unique Identifier for the provisioning command.

Responses

Request samples

Content type
application/json
{
  • "command": "query",
  • "createUser": "someUser",
  • "provisioningCompanyID": 1,
  • "customerID": 1,
  • "parameter1": 6048675309,
  • "parameter2": "byMdn",
  • "priority": 1,
  • "requestGUID": "d9a6b281-8c4a-4e66-974a-c64c829db114"
}

Response samples

Content type
application/json
{
  • "command": "query",
  • "createUser": "someUser",
  • "customerID": 1,
  • "parameter1": 6048675309,
  • "parameter2": "byMdn",
  • "priority": 1,
  • "provisioningCommandID": 1,
  • "provisioningCompany": "Verizon",
  • "provisioningCompanyID": 1,
  • "queueDate": "3/26/2018 5:35:09 PM",
  • "requestGUID": "d9a6b281-8c4a-4e66-974a-c64c829db114",
  • "response": "SUCCESS",
  • "responseDate": "3/26/2018 5:35:09 PM",
  • "status": "Succeeded",
  • "statusID": 3
}

Retreive a ProvisioningCommand

Access a single provisioning command.

Authorizations:
SWT
path Parameters
provisioningCommandID
required
number
Example: 1

Unique identifier of the provisioning command to retrieve.

Responses

Response samples

Content type
application/json
{
  • "command": "query",
  • "createUser": "someUser",
  • "customerID": 1,
  • "parameter1": 6048675309,
  • "parameter2": "byMdn",
  • "priority": 1,
  • "provisioningCommandID": 1,
  • "provisioningCompany": "Verizon",
  • "provisioningCompanyID": 1,
  • "queueDate": "3/26/2018 5:35:09 PM",
  • "requestGUID": "d9a6b281-8c4a-4e66-974a-c64c829db114",
  • "response": "SUCCESS",
  • "responseDate": "3/26/2018 5:35:09 PM",
  • "status": "Succeeded",
  • "statusID": 3
}

Provisioning Command Template

Resources related to provisioning command templates.

Search For Provisioning Command Templates

Search for provisioning commands.

Available Fields

The following is a list of fields from the mock endpoint and how they can be used within the search.

  • Filterable : provisioningCommandTemplateID, provisioningCommandTemplateTypeID, provisioningCompanyID
  • Sortable : provisioningCommandTemplateID, provisioningCommandTemplateTypeID, provisioningCompany, provisioningCompanyID
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=provisioningCommandID eq 1234

A structured search expression in standard OData syntax.

$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=provisioningCompanyID

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order. If no $orderby is specified, the default sort order is descending by provisioningCommandTemplateID.

$select
string
Example: $select=provisioningCompanyID

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
number
Example: $skip=10

Number of search results to skip.

$skiptoken
number
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
number
Example: $top=1

Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "@nextLink": "https://subdomain.idibilling.com/provisioning/an_environment/api/odataquery?$filter=name eq",
  • "value": [
    ]
}

Send Provisioning Command

Sends a provisioning command based on the template and service provided

Authorizations:
SWT
path Parameters
provisioningCommandTemplateID
required
number
Example: 1

Unique identifier for the provisioning command template that the new provisioning command will be based off of.

header Parameters
contentType
required
string
Example: application/json
Request Body schema: application/json
serviceID
required
number

Service to use for the generation of the provisioning command.

Responses

Request samples

Content type
application/json
{
  • "serviceID": 12
}

Response samples

Content type
application/json
{
  • "reguestGUID": "72adc6d5-204a-44fa-bccf-288afa8590d7"
}

Release Notes

Release Notes 2.03

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.02

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.01

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.00

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.06

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.05

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.04

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.03

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.02

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.01

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.00

  • Added new Provisioning API endpoint