ProductLine¶

An APS resource of this APS type represents a product line.

A product line includes products that belong to the same vendor and have the same fulfilment parameters.

In this document:

Schema
Properties
Relationship
Custom Operations
Structures
Examples

Schema ¶

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

{
  "name": "ProductLine",
  "id": "http://com.odin.platform/inhouse-products/productLine/1.0",
  "apsVersion": "2.0",
  "implements": [
    "http://aps-standard.org/types/core/resource/1.0",
    "http://aps-standard.org/types/core/profile/service/1.0"
  ],
  "relations": {
    "application": {
      "type": "http://com.odin.platform/inhouse-products/application/1.0",
      "required": true
    },
    "account": {
      "type": "http://parallels.com/aps/types/pa/account/1.2",
      "required": true
    },
    "pdiProducts": {
      "type": "http://com.odin.platform/inhouse-products/pdiProduct/1.0",
      "collection": true
    }
  },
  "properties": {
    "parameters": {
      "type": "array",
      "title": "Parameters",
      "items": {
        "type": "FulfillmentParameter"
      }
    },
    "name": {
      "type": "http://aps-standard.org/types/core/i18n/1.3#MLString",
      "title": "Product Line Name"
    },
    "approvalType": {
      "type": "string",
      "required": true,
      "default": "instant",
      "title": "Approval type",
      "enum": [
        "manual",
        "instant",
        "request-url",
        "external"
      ],
      "enumTitles": [
        "Manual",
        "Instant",
        "Request-URL",
        "External"
      ]
    },
    "baseURL": {
      "type": "string"
    },
    "subscriptionStoppingApprovalType": {
      "type": "string",
      "required": true,
      "default": "instant",
      "title": "Subscription stopping Approval type",
      "enum": [
        "manual",
        "instant",
        "request-url",
        "external"
      ],
      "enumTitles": [
        "Manual",
        "Instant",
        "Request-URL",
        "External"
      ]
    },
    "subscriptionStartingApprovalType": {
      "type": "string",
      "required": true,
      "default": "instant",
      "title": "Subscription starting Approval type",
      "enum": [
        "manual",
        "instant",
        "request-url",
        "external"
      ],
      "enumTitles": [
        "Manual",
        "Instant",
        "Request-URL",
        "External"
      ]
    },
    "subscriptionLimitChangeApprovalType": {
      "type": "string",
      "required": true,
      "default": "instant",
      "title": "Subscription limit change Approval type",
      "enum": [
        "manual",
        "instant",
        "request-url",
        "external"
      ],
      "enumTitles": [
        "Manual",
        "Instant",
        "Request-URL",
        "External"
      ]
    },
    "connectSettings": {
      "type": "ConnectSettings",
      "title": "Connect settings"
    },
    "contentJiraIssueId": {
      "type": "string",
      "title": "Marketing content jira issue ID"
    },
    "templates": {
      "type": "array",
      "title": "Embedding Templates",
      "items": {
        "type": "PdiEmbeddingTemplate"
      }
    },
    "actions": {
      "type": "array",
      "title": "Actions",
      "items": {
        "type": "PdiAction"
      }
    },
    "subscriptionRemovalApprovalType": {
      "type": "string",
      "required": true,
      "default": "instant",
      "title": "Approval type",
      "enum": [
        "manual",
        "instant",
        "request-url",
        "external"
      ],
      "enumTitles": [
        "Manual",
        "Instant",
        "Request-URL",
        "External"
      ]
    },
    "subscriptionActivateScheduledChangesApprovalType": {
      "type": "string",
      "required": true,
      "default": "instant",
      "title": "Approval type",
      "enum": [
        "manual",
        "instant",
        "request-url",
        "external"
      ],
      "enumTitles": [
        "Manual",
        "Instant",
        "Request-URL",
        "External"
      ]
    },
    "subscriptionCancelScheduledChangesApprovalType": {
      "type": "string",
      "required": true,
      "default": "instant",
      "title": "Approval type",
      "enum": [
        "manual",
        "instant",
        "request-url",
        "external"
      ],
      "enumTitles": [
        "Manual",
        "Instant",
        "Request-URL",
        "External"
      ]
    },
    "subscriptionRenewalApprovalType": {
      "type": "string",
      "required": true,
      "default": "instant",
      "title": "Approval type",
      "enum": [
        "manual",
        "instant",
        "request-url",
        "external"
      ],
      "enumTitles": [
        "Manual",
        "Instant",
        "Request-URL",
        "External"
      ]
    },
    "appId": {
      "type": "string",
      "title": "Application id"
    },
    "bssServiceTemplateId": {
      "type": "integer",
      "title": "BSS Service Template Identity"
    },
    "hideCCPScreen": {
      "type": "boolean",
      "title": "Hide CCP Screen from Customer"
    },
    "destroyServiceOnCancel": {
      "type": "boolean",
      "default": "false",
      "title": "Destroy service on cancellation"
    },
    "customIconUrl": {
      "type": "string",
      "default": "false",
      "title": "Custom icon URL"
    }
  },
  "operations": {
    "getMarketingContent": {
      "path": "marketingContent",
      "verb": "GET",
      "response": {
        "type": "object"
      },
      "errorResponse": {
        "type": "object"
      },
      "access": {
        "referrer": true
      },
      "parameters": {
        "thumbnailsWidth": {
          "kind": "query",
          "type": "integer"
        },
        "thumbnailsHeight": {
          "kind": "query",
          "type": "integer"
        }
      }
    },
    "getProductLineMarketingContentAttachment": {
      "path": "marketingContentAttachment",
      "verb": "GET",
      "response": {
        "type": "object"
      },
      "errorResponse": {
        "type": "object"
      },
      "access": {
        "referrer": true
      },
      "parameters": {
        "fieldId": {
          "kind": "query",
          "type": "string"
        },
        "attachmentId": {
          "kind": "query",
          "type": "string"
        },
        "jiraIssueId": {
          "kind": "query",
          "type": "string"
        }
      }
    },
    "uploadLocalization": {
      "path": "uploadLocalization",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      }
    },
    "uploadProducts": {
      "path": "uploadProducts",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      }
    },
    "importProducts": {
      "path": "importProducts",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      }
    },
    "createProductsPlan": {
      "path": "createProductsPlan",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      }
    }
  },
  "structures": {
    "FulfillmentParameter": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "required": true
        },
        "label": {
          "type": "string"
        },
        "labelLoc": {
          "type": "http://aps-standard.org/types/core/i18n/1.3#MLString",
          "title": "Parameter Label"
        },
        "defaultValue": {
          "type": "string",
          "default": ""
        },
        "description": {
          "type": "string",
          "default": ""
        },
        "descriptionLoc": {
          "type": "http://aps-standard.org/types/core/i18n/1.3#MLString",
          "title": "Parameter Description"
        },
        "phase": {
          "type": "string",
          "required": true,
          "default": "activation",
          "title": "Phase",
          "enum": [
            "activation",
            "fulfillment",
            "reseller"
          ],
          "enumTitles": [
            "Activation",
            "Fulfillment",
            "Reseller"
          ]
        },
        "type": {
          "type": "string",
          "required": true,
          "default": "text",
          "title": "Type",
          "enum": [
            "text",
            "dropdown",
            "password",
            "email",
            "checkbox",
            "subdomain",
            "domain",
            "address",
            "phone",
            "url",
            "choice",
            "object"
          ],
          "enumTitles": [
            "Text",
            "Dropdown",
            "Password",
            "Email",
            "Checkbox",
            "Subdomain",
            "Domain",
            "Address",
            "Phone",
            "URL",
            "Choice",
            "Object"
          ]
        },
        "choices": {
          "type": "array",
          "items": {
            "type": "ParameterChoice"
          }
        },
        "minLength": {
          "type": "integer"
        },
        "maxLength": {
          "type": "integer"
        },
        "isRequired": {
          "type": "boolean"
        },
        "showToCustomer": {
          "type": "boolean"
        },
        "placeholder": {
          "type": "string",
          "default": ""
        },
        "hint": {
          "type": "string",
          "default": ""
        },
        "placeholderLoc": {
          "type": "http://aps-standard.org/types/core/i18n/1.3#MLString",
          "title": "Parameter Placeholder"
        },
        "hintLoc": {
          "type": "http://aps-standard.org/types/core/i18n/1.3#MLString",
          "title": "Parameter Hint"
        }
      }
    },
    "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"
        }
      }
    },
    "ParameterChoice": {
      "type": "object",
      "properties": {
        "isDefault": {
          "type": "boolean"
        },
        "label": {
          "type": "string"
        },
        "labelLoc": {
          "type": "http://aps-standard.org/types/core/i18n/1.3#MLString",
          "title": "Choice label"
        },
        "value": {
          "type": "string"
        }
      }
    },
    "ConnectSettings": {
      "type": "object",
      "properties": {
        "enabled": {
          "type": "boolean",
          "required": true
        },
        "fulfillmentSystem": {
          "type": "string"
        },
        "cartValidation": {
          "type": "boolean",
          "required": true,
          "default": "false"
        },
        "tierConfigValidation": {
          "type": "boolean",
          "required": true,
          "default": "false"
        },
        "tierConfigUpdateValidation": {
          "type": "boolean",
          "required": true,
          "default": "false"
        },
        "changeRequestValidation": {
          "type": "boolean",
          "required": true,
          "default": "false"
        },
        "editableOrderingParameters": {
          "type": "boolean",
          "required": true,
          "default": "false"
        },
        "payAsYouGo": {
          "type": "boolean",
          "required": true,
          "default": "false"
        },
        "dynamicPAYG": {
          "type": "boolean",
          "required": true,
          "default": "false"
        }
      }
    },
    "PdiEmbeddingTemplate": {
      "type": "object",
      "properties": {
        "title": {
          "type": "string"
        },
        "titleLoc": {
          "type": "http://aps-standard.org/types/core/i18n/1.3#MLString",
          "title": "Template Title"
        },
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "body": {
          "type": "string"
        },
        "type": {
          "type": "string",
          "title": "Template Type",
          "enum": [
            "inquire",
            "fulfillment"
          ]
        },
        "scope": {
          "type": "string",
          "title": "Template Scope",
          "enum": [
            "asset",
            "tier1",
            "tier2"
          ]
        }
      }
    },
    "PdiTemplateType": {
      "type": "object"
    },
    "PdiScope": {
      "type": "object"
    },
    "PdiAction": {
      "type": "object",
      "properties": {
        "title": {
          "type": "string"
        },
        "titleLoc": {
          "type": "http://aps-standard.org/types/core/i18n/1.3#MLString",
          "title": "Action Title"
        },
        "id": {
          "type": "string"
        },
        "type": {
          "type": "string"
        },
        "scope": {
          "type": "string",
          "title": "Scope",
          "enum": [
            "asset",
            "tier1",
            "tier2"
          ]
        },
        "link": {
          "type": "string"
        }
      }
    }
  }
}

Properties ¶

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
parameters	Array of FulfillmentParameter	Not Required		The fulfilment parameters of the product line
name	I18n	Not Required		The name of the product line The type of this parameter is MLString.
approvalType	Enum	Required	instant	\| Defines whether subscription creation is approved manually or instantly. The supported values are: `manual` - The Manual type `instant` - The Instant type `request-url` - The URL type `external` - The external (managed by Connect) type
baseURL	String	Not Required		Base URL for ‘URL’ fulfillment type.
subscriptionStoppingApprovalType	Enum	Required	instant	\| Defines whether subscription stopping is approved manually or instantly. The supported values are: `manual` - The Manual type `instant` - The Instant type `request-url` - The URL type `external` - The external (managed by Connect) type
subscriptionStartingApprovalType	Enum	Required	instant	\| Defines whether subscription starting is approved manually or instantly. The supported values are: `manual` - The Manual type `instant` - The Instant type `request-url` - The URL type `external` - The external (managed by Connect) type
subscriptionLimitChangeApprovalType	Enum	Required	instant	\| Defines whether subscription limit change is approved manually or instantly. The supported values are: `manual` - The Manual type `instant` - The Instant type `request-url` - The URL type `external` - The external (managed by Connect) type
connectSettings	ConnectSettings	Not Required		The CloudBlue Connect settings of the product line
contentJiraIssueId	String	Not Required		Jira issue key to display marketing content for product line
templates	Array of PdiEmbeddingTemplate	Not Required		The embedding templates of the product line
actions	Array of PdiAction	Not Required		The actions of the product line
subscriptionRemovalApprovalType	Enum	Required	instant	\| Defines whether subscription removal is approved manually or instantly. The supported values are: `manual` - The Manual type `instant` - The Instant type `request-url` - The URL type `external` - The external (managed by Connect) type
subscriptionActivateScheduledChangesApprovalType	Enum	Required	instant	\| Defines whether activation of scheduled subscription changes is approved manually or instantly. The supported values are: `manual` - The Manual type `instant` - The Instant type `request-url` - The URL type `external` - The external (managed by Connect) type
subscriptionCancelScheduledChangesApprovalType	Enum	Required	instant	\| Defines whether cancelation of scheduled subscription changes is approved manually or instantly. The supported values are: `manual` - The Manual type `instant` - The Instant type `request-url` - The URL type `external` - The external (managed by Connect) type
subscriptionRenewalApprovalType	Enum	Required	instant	\| Defines whether subscription renewal is approved manually or instantly. The supported values are: `manual` - The Manual type `instant` - The Instant type `request-url` - The URL type `external` - The external (managed by Connect) type
appId	String	Not Required		Application id
bssServiceTemplateId	Integer	Not Required		The CloudBlue Commerce identifier of the service template of the product line
hideCCPScreen	Boolean	Not Required
destroyServiceOnCancel	Boolean	Not Required	false
customIconUrl	String	Not Required	false

Relationship ¶

NAME	TYPE	REQUIRED	DESCRIPTION
application	Application	Yes	The APS application that represents the PLM component
account	PAAccount	Yes	The CloudBlue Commerce account that the PLM componentu2019s APS application belongs to
pdiProducts	Collection of PdiProduct	No	Collection of PDI products PdiProduct

Custom Operations ¶

OPERATION	VERB	PATH
getMarketingContent	GET	/marketingContent
getProductLineMarketingContentAttachment	GET	/marketingContentAttachment
uploadLocalization	POST	/uploadLocalization
uploadProducts	POST	/uploadProducts
importProducts	POST	/importProducts
createProductsPlan	POST	/createProductsPlan

getMarketingContent¶

HTTP Request

GET /aps/2/resources/{aps-id}/marketingContent

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
thumbnailsWidth	Integer
thumbnailsHeight	Integer

Returns

getProductLineMarketingContentAttachment¶

HTTP Request

GET /aps/2/resources/{aps-id}/marketingContentAttachment

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
fieldId	String
attachmentId	String
jiraIssueId	String

Returns

uploadLocalization¶

HTTP Request

POST /aps/2/resources/{aps-id}/uploadLocalization

Description

Returns

uploadProducts¶

HTTP Request

POST /aps/2/resources/{aps-id}/uploadProducts

Description

Returns

importProducts¶

HTTP Request

POST /aps/2/resources/{aps-id}/importProducts

Description

Returns

createProductsPlan¶

HTTP Request

POST /aps/2/resources/{aps-id}/createProductsPlan

Description

Returns

Structures ¶

FulfillmentParameter¶

A structure of this kind represents a fulfillment parameter of a product line.

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
id	String	Required		The identifier of the fulfillment parameter
label	String	Not Required		The label of the fulfillment parameter
labelLoc	I18n	Not Required		The label of the fulfillment parameter in different languages The type of this parameter is MLString.
defaultValue	String	Not Required		The default value of the fulfillment parameter
description	String	Not Required		The description of the fulfillment parameter
descriptionLoc	I18n	Not Required		The description of the fulfillment parameter in different languages The type of this parameter is MLString.
phase	Enum	Required	activation	The phase of the fulfillment parameter The supported values are: `activation` - The Activation phase `fulfillment` - The Fulfillment phase `reseller` - The Reseller phase
type	Enum	Required	text	\| The type of the fulfillment parameter The supported values are: `text` - The Text type `dropdown` - The Dropdown type `password` - The Password type `email` - The Email type `checkbox` - The Checkbox type `subdomain` - The Subdomain type `domain` - The Domain type `address` - The Address type `phone` - The Phone type `url` - The URL type `choice` - The Choice type `object` - The Object type
choices	Array of ParameterChoice	Not Required		The choices of the fulfillment parameter
minLength	Integer	Not Required		The minimum length of the fulfillment parameter
maxLength	Integer	Not Required		The maximum length of the fulfillment parameter
isRequired	Boolean	Not Required		Defines whether the fulfillment parameter is required.
showToCustomer	Boolean	Not Required		Defines whether the fulfillment parameter is shown to customers.
placeholder	String	Not Required		The placeholder of the fulfillment parameter
hint	String	Not Required		The hint of the fulfillment parameter
placeholderLoc	I18n	Not Required		The placeholder of the fulfillment parameter in different languages The type of this parameter is MLString.
hintLoc	I18n	Not Required		The hint of the fulfillment parameter in different languages The type of this parameter is MLString.

MLString¶

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

NAME	TYPE	ATTRIBUTES	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

ParameterChoice¶

A structure of this kind represents a choice of a fulfillment parameter.

NAME	TYPE	ATTRIBUTES	DESCRIPTION
isDefault	Boolean	Not Required	Defines whether the choice is default.
label	String	Not Required	The label of the choice
labelLoc	I18n	Not Required	The label of the choice
value	String	Not Required	The value of the choice

ConnectSettings¶

A structure of this kind represents the CloudBlue Connect settings of a product line.

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
enabled	Boolean	Required		Defines whether the settings are enabled.
fulfillmentSystem	String	Not Required		The fulfillment system
cartValidation	Boolean	Required	false	Defines whether cart validation is required.
tierConfigValidation	Boolean	Required	false	Defines whether validation of tier configuration setup is required.
tierConfigUpdateValidation	Boolean	Required	false	Defines whether validation of tier configuration update is required.
changeRequestValidation	Boolean	Required	false	Defines whether change request validation is required.
editableOrderingParameters	Boolean	Required	false	Defines whether order parameters are editable.
payAsYouGo	Boolean	Required	false	Defines whether pay as you go is enabled
dynamicPAYG	Boolean	Required	false	Defines whether dynamic PAYG is enabled

PdiEmbeddingTemplate¶

A structure of this kind represents an embedding template of a product line.

NAME	TYPE	ATTRIBUTES	DESCRIPTION
title	String	Not Required	The title of the template
titleLoc	I18n	Not Required	The title of the template in different languages The type of this parameter is MLString.
id	String	Not Required	The identifier of the template
name	String	Not Required	The name of the template
body	String	Not Required	The body of the template
type	Enum	Not Required	\| The type of the template The supported values are: `inquire` - The Inquire type `fulfillment` - The Fulfillment type
scope	Enum	Not Required	\| The scope of the template The supported values are: `asset` - The Asset scope `tier1` - The Tier 1 scope `tier2` - The Tier 2 scope

PdiTemplateType¶

inquire - The Inquire type

fulfillment - The Fulfillment type

PdiScope¶

asset - The Asset scope
tier1 - The Tier 1 scope
tier2 - The Tier 2 scope

PdiAction¶

A structure of this kind represents an action of a product line.

NAME	TYPE	ATTRIBUTES	DESCRIPTION
title	String	Not Required	The title of the action
titleLoc	I18n	Not Required	The title of the action in different languages The type of this parameter is MLString.
id	String	Not Required	The identifier of the action
type	String	Not Required	The type of the action
scope	Enum	Not Required	\| The scope of the action The supported values are: `asset` - The Asset scope `tier1` - The Tier 1 scope `tier2` - The Tier 2 scope
link	String	Not Required	The link of the action

Examples ¶

In this section:

Obtaining Product Lines

Obtaining Product Lines ¶

To obtain a list of product lines, make a request like this:

GET /aps/2/resources?implementing(http://com.odin.platform/inhouse-products/productLine/1.0)

As a result, you will receive a response like this:

HTTP/1.1 200 OK

[
    {
        "name": {
            "en_US": "PLM Product Line - 1 - In-House Products"
         },
        "approvalType": "instant",
        "connectSettings": {
            "enabled": false,
            "cartValidation": false,
            "tierConfigValidation": false,
            "changeRequestValidation": false,
            "editableOrderingParameters": false
        },
        "bssServiceTemplateId": 5,
        "subscriptionRemovalApprovalType": "instant",
        "subscriptionRenewalApprovalType": "instant",
        "subscriptionStartingApprovalType": "instant",
        "subscriptionStoppingApprovalType": "instant",
        "subscriptionLimitChangeApprovalType": "instant",
        "subscriptionCancelScheduledChangesApprovalType": "instant",
        "subscriptionActivateScheduledChangesApprovalType": "instant",
        "aps": {
            "modified": "2022-04-22T15:07:27Z",
            "id": "fc785b42-7f35-4b7c-9281-ce3791afa053",
            "type": "http://com.odin.platform/inhouse-products/productLine/1.0",
            "status": "aps:ready",
            "revision": 3
        }
    }
]

← PdiProduct

ProvisioningRequestPayload →

CloudBlue Commerce API

Previous topic

Next topic

ProductLine¶

Schema ¶

Properties ¶

Relationship ¶

Custom Operations ¶

getMarketingContent¶

getProductLineMarketingContentAttachment¶

uploadLocalization¶

uploadProducts¶

importProducts¶

createProductsPlan¶

Structures ¶

FulfillmentParameter¶

MLString¶

ParameterChoice¶

ConnectSettings¶

PdiEmbeddingTemplate¶

PdiTemplateType¶

PdiScope¶

PdiAction¶

Examples ¶

Obtaining Product Lines ¶

CloudBlue Commerce API

Previous topic

Next topic

ProductLine¶

Schema¶

Properties¶

Relationship¶

Custom Operations¶

getMarketingContent¶

getProductLineMarketingContentAttachment¶

uploadLocalization¶

uploadProducts¶

importProducts¶

createProductsPlan¶

Structures¶

FulfillmentParameter¶

MLString¶

ParameterChoice¶

ConnectSettings¶

PdiEmbeddingTemplate¶

PdiTemplateType¶

PdiScope¶

PdiAction¶

Examples¶

Obtaining Product Lines¶

Schema ¶

Properties ¶

Relationship ¶

Custom Operations ¶

Structures ¶

Examples ¶

Obtaining Product Lines ¶