ProvisioningRequestPayload

Provisioning request payload.

Schema

The considered APS type (download) extends the Resource APS type(s) and looks as follows:

{
  "name": "ProvisioningRequestPayload",
  "id": "http://com.odin.platform/inhouse-products/ProvisioningRequestPayload/1.0",
  "apsVersion": "2.0",
  "implements": [
    "http://aps-standard.org/types/core/resource/1.0"
  ],
  "properties": {
    "requestId": {
      "type": "string"
    },
    "operation": {
      "type": "string",
      "required": true
    },
    "tenantId": {
      "type": "string",
      "required": true
    },
    "tenant": {
      "type": "RequestUrlTenant",
      "required": true
    },
    "customer": {
      "type": "PAAccount"
    },
    "reseller": {
      "type": "PAAccount"
    },
    "products": {
      "type": "array",
      "required": true,
      "items": {
        "type": "RequestUrlProduct"
      }
    },
    "subscriptionId": {
      "type": "string",
      "required": true
    },
    "subscriptionNumericId": {
      "type": "integer",
      "required": true
    },
    "subscriptionPeriod": {
      "type": "integer"
    },
    "subscriptionPeriodType": {
      "type": "string"
    },
    "billingPeriodType": {
      "type": "string"
    },
    "billingPeriod": {
      "type": "integer"
    },
    "periodTrial": {
      "type": "boolean"
    },
    "plannedDate": {
      "type": "string"
    },
    "vendorSubscriptionId": {
      "type": "string"
    }
  },
  "structures": {
    "RequestUrlTenant": {
      "type": "object",
      "properties": {
        "activationParameters": {
          "type": "array",
          "items": {
            "type": "ExternalMetadataParamValue"
          }
        },
        "fulfillmentParameters": {
          "type": "array",
          "items": {
            "type": "ExternalMetadataParamValue"
          }
        },
        "vendorSubscriptionId": {
          "type": "string"
        }
      }
    },
    "ExternalMetadataParamValue": {
      "type": "object",
      "properties": {
        "key": {
          "type": "string"
        },
        "value": {
          "type": "string"
        },
        "structuredValue": {
          "type": "object"
        }
      }
    },
    "RequestUrlProduct": {
      "type": "object",
      "properties": {
        "name": {
          "type": "MLString"
        },
        "mpn": {
          "type": "string"
        },
        "resourceTypeId": {
          "type": "integer"
        },
        "limit": {
          "type": "integer"
        }
      }
    },
    "MLString": {
      "type": "object",
      "properties": {
        "ar_AE": {
          "type": "string",
          "description": "Arabic, Standard - United Arab Emirates"
        },
        "bg_BG": {
          "type": "string",
          "description": "Bulgarian - Bulgaria"
        },
        "cs_CZ": {
          "type": "string",
          "description": "Czech - Czech Republic"
        },
        "da_DK": {
          "type": "string",
          "description": "Danish - Denmark"
        },
        "de_DE": {
          "type": "string",
          "description": "German - Germany"
        },
        "el_GR": {
          "type": "string",
          "description": "Greek - Greece"
        },
        "en_US": {
          "type": "string",
          "description": "English - United States"
        },
        "es_ES": {
          "type": "string",
          "description": "Spanish - Spain"
        },
        "fr_FR": {
          "type": "string",
          "description": "French - France"
        },
        "he_IL": {
          "type": "string",
          "description": "Hebrew - Israel"
        },
        "iw_IL": {
          "type": "string",
          "description": "Iwrit - Israel"
        },
        "hr_HR": {
          "type": "string",
          "description": "Croatian - Croatia"
        },
        "hu_HU": {
          "type": "string",
          "description": "Hungarian - Hungary"
        },
        "id_ID": {
          "type": "string",
          "description": "Indonesian - Indonesia"
        },
        "it_IT": {
          "type": "string",
          "description": "Italian - Italy"
        },
        "ja_JP": {
          "type": "string",
          "description": "Japanese - Japan"
        },
        "ko_KR": {
          "type": "string",
          "description": "Korean - Korea"
        },
        "kz_KZ": {
          "type": "string",
          "description": "Kazakh - Kazakhstan"
        },
        "mk_MK": {
          "type": "string",
          "description": "Macedonian - Macedonia"
        },
        "nl_NL": {
          "type": "string",
          "description": "Dutch - The Netherlands"
        },
        "no_NO": {
          "type": "string",
          "description": "Norwegian - Norway"
        },
        "pl_PL": {
          "type": "string",
          "description": "Polish - Poland"
        },
        "pt_BR": {
          "type": "string",
          "description": "Portuguese - Brazil"
        },
        "pt_PT": {
          "type": "string",
          "description": "Portuguese - Portugal"
        },
        "ro_RO": {
          "type": "string",
          "description": "Romanian - Romania"
        },
        "ru_RU": {
          "type": "string",
          "description": "Russian - Russia"
        },
        "sv_SE": {
          "type": "string",
          "description": "Swedish - Sweden"
        },
        "th_TH": {
          "type": "string",
          "description": "Thai - Thailand"
        },
        "tr_TR": {
          "type": "string",
          "description": "Turkish - Turkey"
        },
        "zh_CN": {
          "type": "string",
          "description": "Chinese, Simplified - China"
        },
        "sl_SI": {
          "type": "string",
          "description": "Slovenian - Slovenia"
        },
        "sr_RS": {
          "type": "string",
          "description": "Serbian - Serbia"
        },
        "xx_XA": {
          "type": "string",
          "description": "Reserved 1"
        },
        "xx_XB": {
          "type": "string",
          "description": "Reserved 2"
        },
        "xx_XC": {
          "type": "string",
          "description": "Reserved 3"
        },
        "xx_XD": {
          "type": "string",
          "description": "Reserved 4"
        },
        "xx_XE": {
          "type": "string",
          "description": "Reserved 5"
        },
        "xx_XF": {
          "type": "string",
          "description": "Reserved 6"
        },
        "xx_XG": {
          "type": "string",
          "description": "Reserved 7"
        },
        "xx_XH": {
          "type": "string",
          "description": "Reserved 8"
        },
        "xx_XI": {
          "type": "string",
          "description": "Reserved 9"
        },
        "xx_XJ": {
          "type": "string",
          "description": "Reserved 10"
        }
      }
    }
  }
}

Properties

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
requestId	String	Not Required		Defines request id
operation	String	Required		Defines operation name.
tenantId	String	Required		Defines Id (UID) of the tenant.
tenant	RequestUrlTenant	Required		Defines tenant object.
customer	PAAccount	Not Required		Defines customer account.
reseller	PAAccount	Not Required		Defines vendor account. For Reseller’s customer only.
products	Array of RequestUrlProduct	Required		Defines list of products.
subscriptionId	String	Required		Defines subscription Id (UID).
subscriptionNumericId	Integer	Required		Defines subscription numeric Id.
subscriptionPeriod	Integer	Not Required		Defines subscription period.
subscriptionPeriodType	String	Not Required		Defines subscription period type, ‘month’ or ‘year’.
billingPeriodType	String	Not Required		Defines billing period type, ‘month’ or ‘year’.
billingPeriod	Integer	Not Required		Defines billing period.
periodTrial	Boolean	Not Required		Defines if the subscription is trial.
plannedDate	String	Not Required		Defines planned date.
vendorSubscriptionId	String	Not Required		Defines vendor’s subscription Id.

Structures

RequestUrlTenant

Provisioning request tenant.

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
activationParameters	Array of ExternalMetadataParamValue	Not Required		Defines activation parameters.
fulfillmentParameters	Array of ExternalMetadataParamValue	Not Required		Defines fulfillment parameters.
vendorSubscriptionId	String	Not Required		Defines vendor’s subscription ID.

ExternalMetadataParamValue

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
key	String	Not Required
value	String	Not Required
structuredValue	Object	Not Required

RequestUrlProduct

Provisioning request product.

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
name	MLString	Not Required		Defines product name.
mpn	String	Not Required		Defines product MPN.
resourceTypeId	Integer	Not Required		Defines resource type ID.
limit	Integer	Not Required		Defines limit.

MLString

A structure of this kind represents a multi-language string.

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
ar_AE	String	Not Required		The value of the string for Arabic, Standard - United Arab Emirates
bg_BG	String	Not Required		The value of the string for Bulgarian - Bulgaria
cs_CZ	String	Not Required		The value of the string for Czech - Czech Republic
da_DK	String	Not Required		The value of the string for Danish - Denmark
de_DE	String	Not Required		The value of the string for German - Germany
el_GR	String	Not Required		The value of the string for Greek - Greece
en_US	String	Not Required		The value of the string for English - United States
es_ES	String	Not Required		The value of the string for Spanish - Spain
fr_FR	String	Not Required		The value of the string for French - France
he_IL	String	Not Required		The value of the string for Hebrew - Israel
iw_IL	String	Not Required		The value of the string for Iwrit - Israel
hr_HR	String	Not Required		The value of the string for Croatian - Croatia
hu_HU	String	Not Required		The value of the string for Hungarian - Hungary
id_ID	String	Not Required		The value of the string for Indonesian - Indonesia
it_IT	String	Not Required		The value of the string for Italian - Italy
ja_JP	String	Not Required		The value of the string for Japanese - Japan
ko_KR	String	Not Required		The value of the string for Korean - Korea
kz_KZ	String	Not Required		The value of the string for Kazakh - Kazakhstan
mk_MK	String	Not Required		The value of the string for Macedonian - Macedonia
nl_NL	String	Not Required		The value of the string for Dutch - The Netherlands
no_NO	String	Not Required		The value of the string for Norwegian - Norway
pl_PL	String	Not Required		The value of the string for Polish - Poland
pt_BR	String	Not Required		The value of the string for Portuguese - Brazil
pt_PT	String	Not Required		The value of the string for Portuguese - Portugal
ro_RO	String	Not Required		The value of the string for Romanian - Romania
ru_RU	String	Not Required		The value of the string for Russian - Russia
sv_SE	String	Not Required		The value of the string for Swedish - Sweden
th_TH	String	Not Required		The value of the string for Thai - Thailand
tr_TR	String	Not Required		The value of the string for Turkish - Turkey
zh_CN	String	Not Required		The value of the string for Chinese, Simplified - China
sl_SI	String	Not Required		The value of the string for Slovenian - Slovenia
sr_RS	String	Not Required		The value of the string for Serbian - Serbia
xx_XA	String	Not Required		Reserved for future use
xx_XB	String	Not Required		Reserved for future use
xx_XC	String	Not Required		Reserved for future use
xx_XD	String	Not Required		Reserved for future use
xx_XE	String	Not Required		Reserved for future use
xx_XF	String	Not Required		Reserved for future use
xx_XG	String	Not Required		Reserved for future use
xx_XH	String	Not Required		Reserved for future use
xx_XI	String	Not Required		Reserved for future use
xx_XJ	String	Not Required		Reserved for future use

Examples

Please find general description of create-read-update-delete (CRUD) operations with resources, properties, and structures respectively at:

• Provisioning Resources

• Getting a Resource List

• Resource Configuration

• Unprovisioning Resources

← ProductLine

ProvisioningResponsePayload →