logo
API docs by Redocly

Provisioning Management REST Service (1.16)

Download OpenAPI specification:Download

The Provisioning Management API provides developers a way to manage their provisioning system.

System Integrity

Resources related to System Integrity.

Health Check

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

Authorizations:
SWT

Responses

Auxiliary Data

List of readonly resources not specific to any one object type. This section will typically contain lookups for type and status information.

List Provisioned Object Transitions

List of available provisioned object transitions. [Rev 1.01]

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : provisionedObjectTransitionID, provisionedObjectStatusID
  • Sortable : name, provisionedObjectStatus
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=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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.

$select
string
Example: $select=field1, field2

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

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

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

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "@nextLink": "https://api.idibilling.com/ProvisioningManagement/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

List Data Types

List of available data types. [Rev 1.06]

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : dataTypeID, description, name, validation, validationRegex, validationRegexStrict
  • Sortable : dataTypeID, description, name, validation, validationRegex, validationRegexStrict
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=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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.

$select
string
Example: $select=field1, field2

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

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

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

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 15,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Global Information

Resources related to Global Information that will provide shared sources for parameters.

Search Global Information Items

Returns the list of global information items.

NOTE: Items that are protected are returned with a null value from this operation.

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : dataTypeID, name
  • Sortable : dataType, dataTypeID, isProtected, name, value
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=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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.

$select
string
Example: $select=field1, field2

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

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

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

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/ProvisioningManagement/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Update Global Information Items

Will update the system with the changes indicated within the global information item collection. Only items contained in the collection will be updated. Items not contained in the collection will remain unchanged.

Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
Array
dataTypeID
integer

ID of the data type for the item.

isProtected
boolean

True if the item is encrypted.

listID
integer

Unique ID of the list the global information item uses. [Rev 1.01]

name
required
string

Name of the item.

remove
boolean

True if the global information item should be removed from the system. Otherwise it will be added.

value
string

String value of the item.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

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

Get a Global Information item

Get a global information item.

NOTE: If the item is protected, the returned value will be decrypted.

Authorizations:
SWT
path Parameters
name
required
string

Unique name for the global information item to retrieve.

Responses

Response samples

Content type
application/json
{
  • "dataType": "Text",
  • "dataTypeID": 3,
  • "isProtected": false,
  • "listID": 2,
  • "name": "Username",
  • "value": "Someone"
}

Retrieve a list of global information items

Retrieve a list of global information items.

NOTE: If any of the items retrieved are protected, their values will be return decrypted.

Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
Array
names
required
Array of String

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

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

Installation Type

Resources related to installation management.

List Installation Types

Lists Installation Types and the active version for each.

Available Fields

The following indicates how each field can be used.

  • Filterable : activeInstallation, activeInstallationID, displayName, installationTypeID, name
  • Sortable : activeInstallation, displayName, name
Authorizations:
SWT

Responses

Response samples

Content type
application/json
{
  • "@count": 25,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

List Available Installations

List the available installations for a given installation type.

Available Fields

The following indicates how each field can be used.

  • Filterable : description, name
  • Sortable : installationDate, installationTypeID, name
Authorizations:
SWT
path Parameters
installationTypeId
required
integer

Unique identifier for the installation type.

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Set Active Installation

Sets the current active installation for a give installation type.

Authorizations:
SWT
path Parameters
installationTypeId
required
integer

Unique identifier for the installation type to update.

installationId
required
integer

Unique identifier for the installation to set to active.

Responses

Profile

Resources related to profile creation and management.

Search Profiles

Search for profiles in the system.

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : description, name, profileID
  • Sortable : createDate, createUser, description, lastModifiedDate, lastModifiedUser, name
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=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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.

$select
string
Example: $select=field1, field2

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

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

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

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Create Profile

Create a profile.

Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
description
string

Description of the profile.

name
required
string

Name of the profile.

Array of objects (Scenario)

A list of scenarios to associate with this profile.

Responses

Request samples

Content type
application/json
{
  • "description": "Provisioning description",
  • "name": "Provisioning",
  • "scenarios": []
}

Response samples

Content type
application/json
{
  • "createDate": "2019-08-24T14:15:22Z",
  • "createUser": "jdoe",
  • "description": "Provisioning description",
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "lastModifiedUser": "jdoe",
  • "name": "Provisioning",
  • "profileID": 1
}

Get Profile

Get a profile in the system

Authorizations:
SWT
path Parameters
profileId
required
integer

Unique identifier for the profile to retrieve.

Responses

Response samples

Content type
application/json
{
  • "createDate": "2019-08-24T14:15:22Z",
  • "createUser": "jdoe",
  • "description": "Provisioning description",
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "lastModifiedUser": "jdoe",
  • "name": "Provisioning",
  • "profileID": 1
}

Update Profile

Updates a specific profile by ID.

Note

  • This operation uses the JSON Patch document structure for specifying updates to a Profile, which you can read more about here: JSON Patch (RFC 6902).

Patchable Fields

Allowed patch operations for each patchable property of a profile.

  • addProfileScenarios : add

  • description : add, remove, replace

  • name : replace

  • removeProfileScenarios : add

Authorizations:
SWT
path Parameters
profileId
required
integer
Example: 1

Unique ID of the Profile.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
Array
op
required
string

Indicates what type of JSON Patch operation being requested. Valid values are add, replace, and remove.

path
required
string

Path within the JSON document that should be modified.

value
required
string

If supplied, the new value to be used at the given path by the given operation.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

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

List Allowed Provisionable Object Definitions

Lists the allowed provisionable object definitions for the specified profile.

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : code, name
  • Sortable : code, name
Authorizations:
SWT
path Parameters
profileId
required
integer

Unique ID of the Profile.

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=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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.

$select
string
Example: $select=field1, field2

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

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

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

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Set Allowed Provisionable Object Definitions

Set the allowed provisionable object definitions for the profile.

Authorizations:
SWT
path Parameters
profileId
required
integer
Example: 1

Unique ID of the Profile.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
Array
provisionableObjectDefinitionID
required
integer

IP for the provisionable object definition to add or remove from this profile.

remove
boolean

True if the provisionable object definition should be removed from the list of allowed provisionable object definitions for this profile. Otherwise it will be added.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

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

List Profile Scenarios

Lists out all the scenarios that are associated with the profile.

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : providerActionID, providerID
  • Sortable : providerAction, provider
Authorizations:
SWT
path Parameters
profileId
required
integer

Unique ID of the Profile.

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=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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.

$select
string
Example: $select=field1, field2

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

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

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

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

List Profile Scenario Parameters

Lists all the action parameters associated with this profile scenario.

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : name, scope, sequenceNumber
  • Sortable : name, value
Authorizations:
SWT
path Parameters
profileId
required
integer

Unique identifier for the profile.

scenarioId
required
integer

Unique identifier for the profile scenario.

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=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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.

$select
string
Example: $select=field1, field2

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

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

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

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Update Profile Scenario Parameters

Update the list of parameters for a profile scenario.

Authorizations:
SWT
path Parameters
profileId
required
integer

Unique identifier of the profile.

scenarioId
required
integer

Unique identifier of the profile scenario.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
Array
name
required
string

Name of the parameter.

remove
boolean

True if the parameter should be removed from the scenario. Otherwise the parameter will be added or updated.

scope
string

Scope of the parameter.

value
string

Value of the parameter.

Responses

Request samples

Content type
application/json
[]

Response samples

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

Provider

Resources related to Provider searching.

Search Providers

Search for providers in the system.

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : description, name, providerId
  • Sortable : description, name
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=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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.

$select
string
Example: $select=field1, field2

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

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

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

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Get Provider

Retrieve a specific Provider by its unique identifier.

Authorizations:
SWT
path Parameters
providerId
required
integer

Unique identifier for the provider to retrieve.

Responses

Response samples

Content type
application/json
{
  • "description": "Verizon Wireless Reseller API Provider",
  • "name": "Verizon",
  • "providerID": 1
}

List Available Provider Versions

List the provider versions available for a given provider.

Available Fields

The following indicates how each field can be used.

  • Filterable : installationID, installationTypeID, isActive
  • Sortable : installationDate, isActive
Authorizations:
SWT
path Parameters
providerId
required
integer

Unique identifier for the provider to retrieve the versions for.

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=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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.

$select
string
Example: $select=field1, field2

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

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

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

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

List Provider Actions

List the actions associated with a given provider.

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : description, name, providerID
  • Sortable : description, name
Authorizations:
SWT
path Parameters
providerId
required
integer

Unique identifier for the provider to retrieve the actions for.

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=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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.

$select
string
Example: $select=field1, field2

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

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

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

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Get Provider Action

Retrieve a specific provider action by its unique identifier.

Authorizations:
SWT
path Parameters
providerId
required
integer

Unique identifier for the provider the action is associated to.

actionId
required
integer

Unique identifier for the provider action to retrieve.

Responses

Response samples

Content type
application/json
{
  • "description": "Adds a new subscriber line to verizon.",
  • "name": "AddSubscriber",
  • "providerActionID": 1
}

List Provider Action Data Definitions

Lists out all the data definitions that are associated with the provider action.

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : dataDefinitionID, dataTypeID, description, isRequired, isVisible, name
  • Sortable : dataTypeID, isRequired, isVisible, name, sequenceNumber
Authorizations:
SWT
path Parameters
providerId
required
integer

Unique identifier for the provider the action is associated to.

actionId
required
integer

Unique identifier for the provider action.

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Provisioned Object

Resources related to provisioned object creation and management.

Search Provisioned Objects Extended Information Items

Search for provisioned object extended information items in the system. [Rev 1.02]

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : keyName, provisionedObjectCode, provisionedObjectInternalID, value
  • Sortable : keyName, provisionedObjectCode, provisionedObjectInternalID, value
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=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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.

$select
string
Example: $select=field1, field2

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

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

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

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Request Body schema: application/json
Array
code
required
string

Provisioned object code

internalID
required
string

Provisioned object internal ID.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "@count": 145,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Update Provisioned Objects Extended Information Items

Updates or creates extended information items associated to provisionable objects for a specified InternalID. KeyNames need to match data definitions associated to the provisionable object definition. [Rev 1.11]

Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
Array
code
required
string

Code of the provisioned object.

internalID
required
string

Internal ID of the provisioned object.

keyName
required
string

Key Name of the Extended Information Item.

value
required
string

Value of the Extended Information Item.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

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

Search Provisioned Objects Extended Information Item Expanded

Search for provisioned objects and their associated data definitions and corresponding extended information items. [Rev 1.11]

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : code, dataTypeID, internalID, isRequired, isVisible, name
  • Sortable : code, internalID, name, sequenceNumber
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=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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.

$select
string
Example: $select=field1, field2

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

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

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

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Provisionable Object Definition

Resources related to provisionable object definition creation and management.

Search Provisionable Object Definition

Search for provisionable object definitions in the system.

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : code, description, name
  • Sortable : code, lastModifiedDate, lastModifiedUser, name
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=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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.

$select
string
Example: $select=field1, field2

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

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

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

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Create Provisionable Object Definition

Create a provisionable object definition.

The code of a Provisionable Object Definition must be unique across all Provisionable Object Definitions in the system.

The name of a Provisionable Object Definition must be unique across all Provisionable Object Definitions in the system.

Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
code
required
string

Unique code of the provisionable object definition.

Array of objects (Data Definition)

A list of data definitions to associate with this provisionable object definition.

description
string

Description of the provisionable object definition.

name
required
string

Unique name of the provisionable object definition.

Responses

Request samples

Content type
application/json
{
  • "code": "TestCode",
  • "dataDefinitions": [
    ],
  • "description": "Test Description",
  • "name": "Test Provisionable Object Definition"
}

Response samples

Content type
application/json
{
  • "code": "TestCode",
  • "createDate": "2019-08-24T14:15:22Z",
  • "createUser": "jdoe",
  • "dataDefinitions": [
    ],
  • "description": "Test Description",
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "lastModifiedUser": "jdoe",
  • "name": "Test Provisionable Object Definition",
  • "provisionableObjectDefinitionID": 1
}

Retrieve Provisionable Object Definition Properties

Retrieve a list of data definitions for the specified list of provisionable object definition codes. [Rev 1.02]

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : code, dataDefinitionID, dataTypeID, description, isRequired, isVisible, name
  • Sortable : code, dataTypeID, isRequired, isVisible, name, sequenceNumber
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=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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.

$select
string
Example: $select=field1, field2

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

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

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

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Request Body schema: application/json

List of Provisionable Object Definition Codes.

Array
string

Responses

Request samples

Content type
application/json
[
  • "TestCodeA",
  • "TestCodeB"
]

Response samples

Content type
application/json
[
  • {
    }
]

List Data Definitions

Lists out all the data definitions that are associated with the provisionable object definition.

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : dataDefinitionID, dataTypeID, description, isRequired, isVisible, name
  • Sortable : dataTypeID, isRequired, isVisible, name, sequenceNumber
Authorizations:
SWT
path Parameters
provisionableObjectDefinitionId
required
integer

Unique identifier for the provisionable object definition to retrieve.

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=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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.

$select
string
Example: $select=field1, field2

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

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

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

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Get Provisionable Object Definition

Get a provisionable object definition in the system

Authorizations:
SWT
path Parameters
provisionableObjectDefinitionId
required
integer

Unique identifier for the provisionable object definition to retrieve.

Responses

Response samples

Content type
application/json
{
  • "code": "TestCode",
  • "createDate": "2019-08-24T14:15:22Z",
  • "createUser": "jdoe",
  • "description": "Test Description",
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "lastModifiedUser": "jdoe",
  • "name": "Test Provisionable Object Definition",
  • "provisionableObjectDefinitionID": 1
}

Update Provisionable Object Definition

Updates a specific Provisionable Object Definition.

The code of a Provisionable Object Definition must be unique across all Provisionable Object Definitions in the system.

The name of a Provisionable Object Definition must be unique across all Provisionable Object Definitions in the system.

Note

  • This operation uses the JSON Patch document structure for specifying updates to a Provisionable Object Definition, which you can read more about here: JSON Patch (RFC 6902).

Patchable Fields

Allowed patch operations for each patchable property of a provisionable object definition.

  • code : replace

  • dataDefinitions/#array : add, remove, replace

    • dataTypeID : replace

    • defaultValue : add, remove, replace

    • description : add, remove, replace

    • isRequired : replace

    • isVisible : replace

    • listID : add, remove, replace

    • name : replace

    • transitionOptions : replace [Rev 1.01]

    • variableID : add, remove, replace [Rev 1.06]

  • description : add, remove, replace

  • name : replace

Authorizations:
SWT
path Parameters
provisionableObjectDefinitionId
required
integer
Example: 1

Unique identifier for the Provisionable Object Definition to update.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
Array
op
required
string

Indicates what type of JSON Patch operation being requested. Valid values are add, replace, and remove.

path
required
string

Path within the JSON document that should be modified.

value
required
string

If supplied, the new value to be used at the given path by the given operation.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

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

Retrieve Provisionable Object Definition With Extended Information Items

Retrieve a list of data definitions with a corresponding extended information item for the specified list of provisionable object definition codes and extended information internalIDs. [Rev 1.06]

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : N/A
  • Sortable : N/A
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=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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.

$select
string
Example: $select=field1, field2

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

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

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

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
Array
code
required
string

Unique code of the provisionable object definition.

includeNonVisible
boolean

Indicates whether or not to include data definitions that should not be displayed to an end user. Defaults to false.

internalID
required
string

Provisioned object internal ID.

transitionID
required
integer

Unique identifier for the provisioned object transition.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "@count": 145,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Provisioning Batch

Resources related to Provisioning Batch creation and management.

Complete Provisioning Batch

Attempts to complete the provisioning batch given a provisioning batch ID.

Authorizations:
SWT
path Parameters
provisioningBatchId
required
integer

Unique identifier for the provisioning batch to complete.

Responses

Response samples

Content type
application/json
{
  • "isOpen": false,
  • "wasOpen": true
}

Provisioning Request

Resources related to Provisioning Request creation and management.

Search Provisioning Requests

Search for Provisioning Requests in the system.

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : accountNumber, completeDate, createDate, createUser, isReadOnly, lastModifiedDate, lastModifiedUser, provisioningRequestBatchID, provisioningRequestID, regeneratedFromProvisioingRequestID, rootRegeneratedFromProvisioingRequestID, statusID, workItemInstanceID, wasRegenerated
  • Sortable : accountNumber, completeDate, createDate, createUser, isReadOnly, lastModifiedDate, lastModifiedUser, provisioningRequestID, regenerationCount, status, workItemInstanceID, wasRegenerated
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=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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.

$select
string
Example: $select=field1, field2

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

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

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

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/ProvisioningManagement/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Create Provisioning Request

Create a provisioning request and submits it for provisioning.

Provisioning Request Batching

  • If provisioningRequestBatchID is specified, the new provisioning request will be associated with that existing batch.

  • If provisioningRequestBatchTotalObjectCount is specified (and provisioningRequestBatchID is not specified), then a new provisioning request batch will be created, and the new provisioning request will be associated with that batch.

  • If neither provisioningRequestBatchID nor provisioningRequestBatchTotalObjectCount is specified, then the new provisioning request will not be associated with a provisioning request batch.

Provisioning Request Regeneration

  • If regeneratedFromProvisioningID is specified and is in the status of In Error, the new provisioning request will be associated with the specified provisioning request and its rootRegeneratedFromProvisioningRequestID. The provisioning request specified by regeneratedFromProvisioningID will have its batching information moved to the new request and then be put into a status of Cancelled.
Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
required
object (Account Information)

Account information for the provisioning request.

Array of objects (Extended Information Item)

A list of extended information items to associate with this provisioning request.

isReadOnly
boolean

True if the provisioning request cannot have its state modified [Rev 1.04]

profileID
required
integer

Unique identifier for the profile that should be used when processing this provisioning request.

provisionedObjectCode
string

The provisionable object code for the provisioned object of this request.

provisionedObjectEndDate
string <date-time>

Date and time the provisioned object of this request is ended.

provisionedObjectInternalID
string

Unique, internal identifier for the provisioned object of this request.

provisionedObjectStartDate
string <date-time>

Date and time the provisioned object of this request is started.

provisionedObjectStatusID
integer

Unique identifier for the status of the provisioned object of this request.

provisionedObjectTransitionID
integer

Unique identifier of the transition to use to set the status on the provisioned object. [Rev 1.01]

Note

If transition is specified the provisionedObjectStatusID on the request must match the value in the provisionedObjectStatusID associated with the transition.

provisioningRequestBatchID
integer

Unique identifier of the batch of which provisioning request is a member. If not specified, a new batch will be created and this provisioning request will be its sole member.

provisioningRequestBatchTotalObjectCount
integer

Total number of members in the batch of which provisioning request is a member.

Array of objects (Provisioning Request Link)

A list of links for this request.

Array of objects (ProvisioningRequestVariableOutcome)

A list of variables for the provisioning request and their values. [Rev 1.06]

regeneratedFromProvisioningRequestID
integer

Unique identifier for a provisioning request that this provisioning request was regenerated from. Must be a valid existing provisioning request in the status of In Error [Rev 1.02]

workItemInstanceID
integer

Unique identifier for the work item instance to associate to the provisioning request.

Responses

Request samples

Content type
application/json
{
  • "accountInformation": {
    },
  • "extendedInformationItems": [
    ],
  • "isReadOnly": false,
  • "profileID": 12,
  • "provisionedObjectCode": "POC1",
  • "provisionedObjectEndDate": "2019-08-24T14:15:22Z",
  • "provisionedObjectInternalID": "ID001",
  • "provisionedObjectStartDate": "2019-08-24T14:15:22Z",
  • "provisionedObjectStatusID": 1,
  • "provisionedObjectTransitionID": 1,
  • "provisioningRequestBatchID": 1,
  • "provisioningRequestBatchTotalObjectCount": 10,
  • "provisioningRequestLinks": [
    ],
  • "provisioningRequestVariableOutcomes": [
    ],
  • "regeneratedFromProvisioningRequestID": 12345,
  • "workItemInstanceID": 100001
}

Response samples

Content type
application/json
{
  • "accountInformation": {
    },
  • "completeDate": "2019-08-24T14:15:22Z",
  • "createDate": "2019-08-24T14:15:22Z",
  • "createUser": "jdoe",
  • "isReadOnly": false,
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "lastModifiedUser": "jdoe",
  • "profile": {
    },
  • "profileID": 1,
  • "provisionedObjectCode": "POC1",
  • "provisionedObjectEndDate": "2019-08-24T14:15:22Z",
  • "provisionedObjectInternalID": "ID001",
  • "provisionedObjectStartDate": "2019-08-24T14:15:22Z",
  • "provisionedObjectStatus": "Active",
  • "provisionedObjectStatusID": 1,
  • "provisionedObjectTransition": "Activate",
  • "provisionedObjectTransitionID": 1,
  • "provisioningRequestBatchID": 1,
  • "provisioningRequestBatchTotalObjectCount": 10,
  • "provisioningRequestID": 1,
  • "provisioningRequestLinks": [
    ],
  • "regeneratedFromProvisioningRequestID": 123,
  • "regenerationCount": 2,
  • "reprocessing": false,
  • "rootRegeneratedFromProvisioningRequestID": 122,
  • "status": "Submitted",
  • "statusID": 1,
  • "statusNote": "Errored due to lost connectivity",
  • "wasForced": false,
  • "wasRegenerated": false,
  • "workItemInstanceID": 100001
}

Get Provisioning Request

Retrieve a specific Provisioning Request by its unique identifier.

Authorizations:
SWT
path Parameters
provisioningRequestId
required
integer

Unique identifier for the provisioning request to retrieve.

Responses

Response samples

Content type
application/json
{
  • "accountInformation": {
    },
  • "completeDate": "2019-08-24T14:15:22Z",
  • "createDate": "2019-08-24T14:15:22Z",
  • "createUser": "jdoe",
  • "isReadOnly": false,
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "lastModifiedUser": "jdoe",
  • "profile": {
    },
  • "profileID": 1,
  • "provisionedObjectCode": "POC1",
  • "provisionedObjectEndDate": "2019-08-24T14:15:22Z",
  • "provisionedObjectInternalID": "ID001",
  • "provisionedObjectStartDate": "2019-08-24T14:15:22Z",
  • "provisionedObjectStatus": "Active",
  • "provisionedObjectStatusID": 1,
  • "provisionedObjectTransition": "Activate",
  • "provisionedObjectTransitionID": 1,
  • "provisioningRequestBatchID": 1,
  • "provisioningRequestBatchTotalObjectCount": 10,
  • "provisioningRequestID": 1,
  • "provisioningRequestLinks": [
    ],
  • "regeneratedFromProvisioningRequestID": 123,
  • "regenerationCount": 2,
  • "reprocessing": false,
  • "rootRegeneratedFromProvisioningRequestID": 122,
  • "status": "Submitted",
  • "statusID": 1,
  • "statusNote": "Errored due to lost connectivity",
  • "wasForced": false,
  • "wasRegenerated": false,
  • "workItemInstanceID": 100001
}

Search Provider Call Details

Search for Provider Call Details in the system.

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : correlationID, isResponse, timeStamp
  • Sortable : providerCallDetailID [Rev 1.01], timeStamp
Authorizations:
SWT
path Parameters
provisioningRequestId
required
integer

Unique identifier for the provisioning request.

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=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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.

$select
string
Example: $select=field1, field2

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

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

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

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/ProvisioningManagement/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Create Provider Call Detail

Create a provider call detail for the provisioning request.

Authorizations:
SWT
path Parameters
provisioningRequestId
required
integer

Unique identifier for the provisioning request.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
content
string

The content of the request or response from a provider action.

correlationId
string

ID used to correlate requests and responses.

isResponse
required
boolean

True if the provider call detail represents a response.

providerActionCode
string

Code used for provider action record lookup to associate with this provider call detail.

providerActionCorrelationID
string

ID used to correlate the provider call detail and provider action arguments.[1.06]

Array of objects (Provider Call Detail Component)

A list of provider call detail components to associate with this provider call detail.

timeStamp
required
string <date-time>

Date and time the provider call detail was made.

Responses

Request samples

Content type
application/json
{
  • "content": "Example message content",
  • "correlationId": "8c041095",
  • "isResponse": false,
  • "providerActionCode": "Calix_Disconnect_Service",
  • "providerActionCorrelationID": "8c041095",
  • "providerCallDetailComponents": [
    ],
  • "timeStamp": "2017-12-11T00:33:00.11-05:00"
}

Response samples

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

Get Provider Call Detail

Retrieve a specific Provider Call Detail by its unique identifier.

Authorizations:
SWT
path Parameters
provisioningRequestId
required
integer

Unique identifier for the provisioning request to retrieve.

providerCallDetailId
required
integer

Unique identifier for the provider call detail to retrieve.

Responses

Response samples

Content type
application/json
{
  • "content": "Example message content",
  • "correlationID": "8c041095",
  • "isResponse": false,
  • "provider": "Metaswitch",
  • "providerID": 17,
  • "providerAction": "AddSubscriber",
  • "providerActionID": 23,
  • "providerActionCorrelationID": "8c041095",
  • "providerCallDetailComponents": [
    ],
  • "providerCallDetailID": 1,
  • "timeStamp": "2017-12-11T00:33:00.11-05:00"
}

Complete Provisioning Request

Completes a provisioning request.

Authorizations:
SWT
path Parameters
provisioningRequestId
required
integer

Unique identifier for the provisioning request.

Request Body schema: application/json
force
boolean

Indicates if the completion was forced instead of completing normally.

statusNote
string

Any notes describing the status of the provisioning request.

Responses

Request samples

Content type
application/json
{
  • "force": false,
  • "statusNote": "Completed by John Smith"
}

Response samples

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

Error Provisioning Request

Errors a provisioning request.

Authorizations:
SWT
path Parameters
provisioningRequestId
required
integer

Unique identifier for the provisioning request.

Request Body schema: application/json
statusNote
string

Any notes describing the status of the provisioning request.

Responses

Request samples

Content type
application/json
{
  • "statusNote": "Errored due to lost connectivity"
}

Response samples

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

List Computed Extended Information Items

Lists out all the extended information items associated with the provisioning request merged with the information about the provisionable object that may have been previously provisioned. [Rev 1.01]

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : keyName
  • Sortable : keyName
Authorizations:
SWT
path Parameters
provisioningRequestId
required
integer

Unique identifier for the provisioning request.

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=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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.

$select
string
Example: $select=field1, field2

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

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

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

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "@nextLink": "https://api.idibilling.com/ProvisioningManagement/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Search Computed Extended Information Items Snapshot

Search for the snapshot of computed extended information items assoicated to a provisioning request. [Rev 1.06]

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : keyName
  • Sortable : keyName
Authorizations:
SWT
path Parameters
provisioningRequestId
required
integer

Unique identifier for the provisioning request.

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=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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.

$select
string
Example: $select=field1, field2

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

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

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

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "@nextLink": "https://api.idibilling.com/ProvisioningManagement/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Save a snapshot of Computed Extended Information

Save a snapshot of the computed extended information items and associate it to the provisioning request. [1.06]

Note

  • Calling this endpoint will overwrite the existing snapshot.
Authorizations:
SWT
path Parameters
provisioningRequestId
required
integer

Unique identifier for the provisioning request.

Responses

Response samples

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

List Extended Information Items

Lists out all the extended information items associated with the provisioning request.

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : keyName
  • Sortable : keyName
Authorizations:
SWT
path Parameters
provisioningRequestId
required
integer

Unique identifier for the provisioning request.

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=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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.

$select
string
Example: $select=field1, field2

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

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

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

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "@nextLink": "https://api.idibilling.com/ProvisioningManagement/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Resubmit Provisioning Request

Resubmits a provisioning request that is in error status.

Note

  • If the provisioning request is in error status, this will resubmit the provisioning request.
  • Otherwise, an error is returned.
Authorizations:
SWT
path Parameters
provisioningRequestId
required
integer

Unique identifier for the provisioning request.

Responses

Response samples

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

List Provisioning Request Variable Outcomes

Lists out all the variables and their outcomes associated with the provisioning request. [Rev 1.06]

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : outcomeCode, variableCode
  • Sortable : outcomeCode, variableCode
Authorizations:
SWT
path Parameters
provisioningRequestId
required
integer

Unique identifier for the provisioning request.

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=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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.

$select
string
Example: $select=field1, field2

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

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

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

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/ProvisioningManagement/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Safeguard

Resources related to Safeguard settings that will prevent provisioning requests from being sent to third party systems.

Get Safeguard

Returns the current safeguard settings for the environment.

Responses

Response samples

Content type
application/json
{
  • "isEnabled": true,
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "lastModifiedUser": "jdoe"
}

List Safeguards Bypasses

Returns the list of allowed internal ids that can bypass the safeguard settings.

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : allowedInternalID
  • Sortable : allowedInternalID
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=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

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.

$select
string
Example: $select=field1, field2

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

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

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

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/ProvisioningManagement/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Update Safeguards Bypasses

Updates the list of allowed internal ids that can bypass the safeguard settings. Only internal ids included int the request will be updated.

Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
Array
allowedInternalID
required
string

InternalID to remove or add to the allowed list of internal ids.

remove
boolean

True if the allowed internal id should be removed from the bypass settings. Otherwise it will be added.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

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

Disable Safeguards

Disabled safeguards so that all requests are sent to third party systems.

Authorizations:
SWT

Responses

Response samples

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

Enable Safeguards

Enables safeguards so that only permitted requests are sent to third party systems.

Authorizations:
SWT

Responses

Response samples

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

Variable

Resources related to Variable creation and management. Variables are definitions of data in the system that can have more than one possible value. These possible values are called Outcomes. Variables are used by and can be associated to other components in the system. [Rev 1.06]

Create Variable

Create a Variable. [Rev 1.06]

Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
code
required
string

A unique identifier for the variable.

Note

  • This code must be unique among all variables in the environment.
dataTypeID
required
integer

Unique identifier for the data type of the variable.

isActive
required
boolean

Specifies whether the variable will be active or not. Default is false.

name
required
string

Name of the variable.

Note

  • The name must be unique among all variables in the environment.
Array of objects (Outcome)

List of outcomes to associate with the variable.

Responses

Request samples

Content type
application/json
{
  • "code": "300/200A",
  • "dataTypeID": 1,
  • "isActive": true,
  • "name": "Bandwidth",
  • "outcomes": [
    ]
}

Response samples

Content type
application/json
{
  • "code": "300/200A",
  • "createDate": "2019-08-24T14:15:22Z",
  • "createUser": "janedoe",
  • "dataTypeID": 1,
  • "isActive": true,
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "lastModifiedUser": "janedoe",
  • "name": "Bandwidth",
  • "outcomes": [
    ],
  • "variableID": 1
}

List All Variables

Retrieve all Variables in the environment. [Rev 1.06]

Available Fields

The following indicates how each field can be used.

  • Filterable : code, isActive, name, variableID
  • Sortable : code, createDate, createUser, isActive, lastModifiedDate, lastModifiedUser, name
Authorizations:
SWT

Responses

Response samples

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

Get Variable

Get a Variable in the environment. [Rev 1.06]

Authorizations:
SWT
path Parameters
variableID
required
integer

System-generated unique identifier for the Variable to retrieve.

Responses

Response samples

Content type
application/json
{
  • "code": "300/200A",
  • "createDate": "2019-08-24T14:15:22Z",
  • "createUser": "janedoe",
  • "dataTypeID": 1,
  • "isActive": true,
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "lastModifiedUser": "janedoe",
  • "name": "Bandwidth",
  • "outcomes": [
    ],
  • "variableID": 1
}

Delete Variable

Delete a Variable in the environment. [Rev 1.06]

Authorizations:
SWT
path Parameters
variableID
required
integer

System-generated unique identifier for the Variable to retrieve.

Responses

Response samples

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

Update Variable

Updates a specific Variable. [Rev 1.06]

The name and code of a Variable must be unique across all Variables in the system. The outcomeCode and sequenceNumber of an Outcome must be unique across all Outcomes associated to a single Variable.

Note

  • This operation uses the JSON Patch document structure for specifying updates to a Variable, which you can read more about here: JSON Patch (RFC 6902).

Patchable Fields

Allowed patch operations for each patchable property of a provisionable object definition.

  • code : replace

  • dataTypeID : replace

  • isActive : replace

  • name : replace

  • outcomes/#array : add, remove, replace

    • displayValue : add, remove, replace

    • outcomeCode : replace

    • sequenceNumber : replace

    • value : replace

Authorizations:
SWT
path Parameters
variableID
required
integer
Example: 1

System-generated unique identifier for the Variable to update.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
Array
op
required
string

Indicates what type of JSON Patch operation being requested. Valid values are add, replace, and remove.

path
required
string

Path within the JSON document that should be modified.

value
required
string

If supplied, the new value to be used at the given path by the given operation.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

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

Get Outcomes

Retrieve all Outcomes for a variable in the environment. [Rev 1.06]

Available Fields

The following indicates how each field can be used.

  • Filterable : DisplayValue, OutcomeCode, Value
  • Sortable : DisplayValue, OutcomeCode, SequenceNumber, Value
Authorizations:
SWT
path Parameters
variableID
required
integer

Unique identifier for the variable used to retrieve the related outcomes.

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Release Notes

Release Notes 1.16

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

Release Notes 1.15

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

Release Notes 1.14

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

Release Notes 1.13

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

Release Notes 1.12

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

Release Notes 1.11

Release Notes 1.10

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

Release Notes 1.09

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

Release Notes 1.08

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

Release Notes 1.07

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

Release Notes 1.06

Release Notes 1.05

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

Release Notes 1.04

Release Notes 1.03

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

Release Notes 1.02

Release Notes 1.01

Release Notes 1.00

  • Initial Release