| status | string Enum: "InVerification" "Approved" "Rejected" "Error" Template Registry API (0.10.0)Download OpenAPI specification:Download Add a template to Template Registry for a further verification. createAndUpdateTemplateAuth Request Body schema: application/jsonrequired | name required | string The name of the template on npmjs.com
+ | | author | string The name of the template's author on npmjs.com
+ | | createdBy | string The name of the user who created the template
+ | | updatedBy | string The name of the user who last updated the template
+ | | description | string A description of the template
+ | | adobeRecommended | boolean Whether the template is recommended by Adobe
+ | | latestVersion | string The version of the template in the semver format
+ | | publishDate | string The date the template was published in the ISO 8601 format
+ | | Array of objects non-empty Extension points that a template implements
+ | | categories | Array of strings non-empty A list of categories the template belongs to
+ | | Array of objects non-empty A list of Adobe APIs required by the template
+ | | Array of objects non-empty A list of credentials required by the template
+ | | runtime | boolean Default: false Whether to add Runtime to App Builder application or not.
+ | | event | object event configuration for the template
+ | | keywords | Array of strings A list of keywords specified in the packages.json file
+ | | status | string Enum: "InVerification" "Approved" "Rejected" "Error" A status of a package in Template Registry.
+" class="sc-euGpHm sc-exayXG fwfkcU jYGAQp"> A status of a package in Template Registry.
"Error" indicates that an application error occurred.
- | | Array of objects (CodeSamples) A list of code samples for the template
- | | requestAccessAppId | string Access Platform app id which can be used to request access to services in this template.
- | | isRequestPending | boolean Indicates whether a request for access is already pending for the user in a given org
- | required | object non-empty A list of locations where the package's code can be found
- | | orgEntitled | boolean Whether the organization is entitled to use the template
- | | userEntitled | boolean Whether the user is entitled to use the template
- | | canRequestAccess | boolean Whether the user can request access to the template
- | | disEntitledReasons | Array of strings A list of reasons why the user is not entitled to use the template
- |
Responses Request samples Content typeapplication/json Response samples Content typeapplication/json {"id": "991f1cf7-8ecc-403c-9f29-1ab8a3beacbf", "author": "Adobe Inc.", "name": "@adobe/app-builder-template", "createdBy": "Lazarus", "updatedBy": "Lazarus", "description": "AppBuilder template", "adobeRecommended": true, "latestVersion": "1.0.10", "publishDate": "2022-04-20T19:54:41.495Z", "apis": [{"code": "AdobeAnalyticsSDK", "credentialType": "string", "flowType": "string"
}
], "runtime": false, "event": { }, "status": "Approved", "requestAccessAppId": "FireflySDKEnterprise1", "isRequestPending": "true", "orgEntitled": true, "userEntitled": true, "canRequestAccess": true, "disEntitledReasons": [],
}Return a list of templates matching a specified criteria. query Parameters| names | string Filter by template names. A comma-delimited list of template names (npm package names).
- | | categories | string Filter by template categories. A comma-delimited list of template categories.
- | | apis | string Filter by template APIs. A comma-delimited list of template APIs.
- | | extensions | string Filter by template extension points. A comma-delimited list of template extension points.
- | | events | string | Array of objects (CodeSamples) A list of code samples for the template
+ | | | requestAccessAppId | string Access Platform app id which can be used to request access to services in this template.
+ | | isRequestPending | boolean Indicates whether a request for access is already pending for the user in a given org
+ | required | object non-empty A list of locations where the package's code can be found
+ | | orgEntitled | boolean Whether the organization is entitled to use the template
+ | | userEntitled | boolean Whether the user is entitled to use the template
+ | | canRequestAccess | boolean Whether the user can request access to the template
+ | | disEntitledReasons | Array of strings A list of reasons why the user is not entitled to use the template
+ |
Responses Request samples Content typeapplication/json Response samples Content typeapplication/json {"id": "991f1cf7-8ecc-403c-9f29-1ab8a3beacbf", "author": "Adobe Inc.", "name": "@adobe/app-builder-template", "createdBy": "Lazarus", "updatedBy": "Lazarus", "description": "AppBuilder template", "adobeRecommended": true, "latestVersion": "1.0.10", "publishDate": "2022-04-20T19:54:41.495Z", "apis": [{"code": "AdobeAnalyticsSDK", "credentialType": "string", "flowType": "string"
}
], "runtime": false, "event": { }, "status": "Approved", "requestAccessAppId": "FireflySDKEnterprise1", "isRequestPending": "true", "orgEntitled": true, "userEntitled": true, "canRequestAccess": true, "disEntitledReasons": [],
}Return a list of templates matching a specified criteria. query Parameters| names | string Filter by template names. A comma-delimited list of template names (npm package names).
+ | | categories | string Filter by template categories. A comma-delimited list of template categories.
+ | | apis | string Filter by template APIs. A comma-delimited list of template APIs.
+ | | extensions | string Filter by template extension points. A comma-delimited list of template extension points.
+ | | events | string Filter by template events. It supports "empty" (?events=) and "any" (?events=) filters for now.
+" class="sc-euGpHm sc-exayXG fwfkcU jYGAQp">Filter by template events. It supports "empty" (?events=) and "any" (?events=) filters for now.
The "empty" filter (?events=) returns templates that do not have the "event" property set.
The "any" (?events=) filter returns templates that do have the "event" property set.
- | | runtime | string Enum: "true" "false" "*" Is Runtime required or not.
- | | statuses | string Filter by template statuses.
- | | adobeRecommended | boolean Indicates templates featured by Adobe.
- | | size | integer Default: 10 Enum: 10 25 50 A number of items to return.
- | | cursor | string | runtime | string Enum: "true" "false" "*" Is Runtime required or not.
+ | | | statuses | string Filter by template statuses.
+ | | adobeRecommended | boolean Indicates templates featured by Adobe.
+ | | size | integer Default: 10 Enum: 10 25 50 A number of items to return.
+ | | cursor | string We'll use a forward-only cursor-based pagination (also known as an infinite scrolling).
+" class="sc-euGpHm sc-exayXG fwfkcU jYGAQp"> We'll use a forward-only cursor-based pagination (also known as an infinite scrolling).
A value is a BASE64 encoded encrypted string.
- | | orderBy | string | orderBy | string A query parameter used for sorting.
+" class="sc-euGpHm sc-exayXG fwfkcU jYGAQp"> A query parameter used for sorting.
The value of the orderBy parameter contains a comma-separated list of expressions used to sort the items.
The expression MAY include the suffix "asc" for ascending or "desc" for descending, separated from the property name by a space.
If "asc" or "desc" is not specified, the service MUST order by the specified property in ascending order.
Sub-sorts can be specified by a comma-separated list of property names with an OPTIONAL direction qualifier.
- | |
Responses Response samples Content typeapplication/json {"items": [{"id": "f62f3381-592a-41a3-b936-ef953abd0155", "author": "Adobe Inc.", "name": "@adobe/app-builder-template", "description": "AppBuilder template", "adobeRecommended": true, "latestVersion": "1.0.10", "publishDate": "2022-04-22T04:17:28.643Z", "status": "Approved",
}, {"id": "3e3aee0b-539e-43b1-b47c-0a69eaf39d6c", "name": "@company1/app-builder-template", "status": "InVerification",
}
],
}Modify a template to Template Registry. createAndUpdateTemplateAuth path Parameters| templateId required | string The id of the template in the database
- |
Request Body schema: application/jsonrequired Template object to update
- | updatedBy required | string The name of the user who created the template
- | | description | string A description of the template
- | | latestVersion | string The version of the template in the semver format
- | | categories | Array of strings non-empty A list of categories the template belongs to
- | | adobeRecommended | boolean Whether the template is recommended by Adobe
- | | keywords | Array of strings A list of keywords specified in the packages.json file
- | | status | string Enum: "InVerification" "Approved" "Rejected" "Error" Responses Response samples Content typeapplication/json {"items": [{"id": "f62f3381-592a-41a3-b936-ef953abd0155", "author": "Adobe Inc.", "name": "@adobe/app-builder-template", "description": "AppBuilder template", "adobeRecommended": true, "latestVersion": "1.0.10", "publishDate": "2022-04-22T04:17:28.643Z", "status": "Approved",
}, {"id": "3e3aee0b-539e-43b1-b47c-0a69eaf39d6c", "name": "@company1/app-builder-template", "status": "InVerification",
}
],
}Modify a template to Template Registry. createAndUpdateTemplateAuth path Parameters| templateId required | string The id of the template in the database
+ |
Request Body schema: application/jsonrequired Template object to update
+ | updatedBy required | string The name of the user who created the template
+ | | description | string A description of the template
+ | | latestVersion | string The version of the template in the semver format
+ | | categories | Array of strings non-empty A list of categories the template belongs to
+ | | adobeRecommended | boolean Whether the template is recommended by Adobe
+ | | keywords | Array of strings A list of keywords specified in the packages.json file
+ | | status | string Enum: "InVerification" "Approved" "Rejected" "Error" A status of a package in Template Registry.
+" class="sc-euGpHm sc-exayXG fwfkcU jYGAQp"> A status of a package in Template Registry.
"Error" indicates that an application error occurred.
- | | Array of objects non-empty Extension points that a template implements
- | | runtime | boolean Default: false Whether to add Runtime to App Builder application or not.
- | | Array of objects non-empty A list of credentials required by the template
- | | Array of objects (CodeSamples) A list of code samples for the template
- | | requestAccessAppId | string Access Platform app id which can be used to request access to services in this template.
- | | Array of objects non-empty A list of Adobe APIs required by the template
- | | object A link to the Github repository containing the package's source code
- |
Responses/v1/templates/{templateId} Request samples Content typeapplication/json {"updatedBy": "Lazarus", "description": "AppBuilder template", "latestVersion": "1.0.10", "adobeRecommended": true, "status": "Approved", "runtime": false, "requestAccessAppId": "FireflySDKEnterprise1",
} Response samples Content typeapplication/json {"id": "991f1cf7-8ecc-403c-9f29-1ab8a3beacbf", "author": "Adobe Inc.", "name": "@adobe/app-builder-template", "createdBy": "Lazarus", "updatedBy": "Lazarus", "description": "AppBuilder template", "adobeRecommended": true, "latestVersion": "1.0.10", "publishDate": "2022-04-20T19:54:41.495Z", "apis": [{"code": "AdobeAnalyticsSDK", "credentialType": "string", "flowType": "string"
}
], "runtime": false, "event": { }, "status": "Approved", "requestAccessAppId": "FireflySDKEnterprise1", "isRequestPending": "true", "orgEntitled": true, "userEntitled": true, "canRequestAccess": true, "disEntitledReasons": [],
}Get information about a template. path Parameters| templateId required | string The id of the template in the database
- |
Responses/v1/templates/{templateId} Response samples Content typeapplication/json {"id": "991f1cf7-8ecc-403c-9f29-1ab8a3beacbf", "author": "Adobe Inc.", "name": "@adobe/app-builder-template", "createdBy": "Lazarus", "updatedBy": "Lazarus", "description": "AppBuilder template", "adobeRecommended": true, "latestVersion": "1.0.10", "publishDate": "2022-04-20T19:54:41.495Z", "apis": [{"code": "AdobeAnalyticsSDK", "credentialType": "string", "flowType": "string"
}
], "runtime": false, "event": { }, "status": "Approved", "requestAccessAppId": "FireflySDKEnterprise1", "isRequestPending": "true", "orgEntitled": true, "userEntitled": true, "canRequestAccess": true, "disEntitledReasons": [],
}Delete a template from Template Registry. path Parameters| templateId required | string The id of the template in the database
- |
Responses/v1/templates/{templateId} Install a template path Parameters| templateId required | string The id of the template in the database
- |
Request Body schema: application/jsonrequired | orgId required | | | projectName required | | | description | | required | object Key value pairs of credential metadata like allowed domains, redirect uris etc
- | | Array of objects Optional field to include license configs to be assigned to a technical account for an individual API
- |
Responses Request samples Content typeapplication/json {"orgId": "string", "projectName": "string", "description": "string", "metadata": {"property1": null, "property2": null
},
} Response samples Content typeapplication/json Get information about a template by organization. path Parameters| templateName required | string The name of the template on npmjs.com
- | | orgName required | string Organisation name on npmjs.com
- |
Responses/v1/templates/{orgName}/{templateName} Response samples Content typeapplication/json {"id": "991f1cf7-8ecc-403c-9f29-1ab8a3beacbf", "author": "Adobe Inc.", "name": "@adobe/app-builder-template", "createdBy": "Lazarus", "updatedBy": "Lazarus", "description": "AppBuilder template", "adobeRecommended": true, "latestVersion": "1.0.10", "publishDate": "2022-04-20T19:54:41.495Z", "apis": [{"code": "AdobeAnalyticsSDK", "credentialType": "string", "flowType": "string"
}
], "runtime": false, "event": { }, "status": "Approved", "requestAccessAppId": "FireflySDKEnterprise1", "isRequestPending": "true", "orgEntitled": true, "userEntitled": true, "canRequestAccess": true, "disEntitledReasons": [],
}Delete a template from Template Registry by organization. path Parameters| templateName required | string The name of the template on npmjs.com
- | | orgName required | string Organisation name on npmjs.com
- |
Responses/v1/templates/{orgName}/{templateName} | | Array of objects non-empty Extension points that a template implements
+ | | runtime | boolean Default: false Whether to add Runtime to App Builder application or not.
+ | | Array of objects non-empty A list of credentials required by the template
+ | | Array of objects (CodeSamples) A list of code samples for the template
+ | | requestAccessAppId | string Access Platform app id which can be used to request access to services in this template.
+ | | Array of objects non-empty A list of Adobe APIs required by the template
+ | | object A link to the Github repository containing the package's source code
+ |
Responses/v1/templates/{templateId} Request samples Content typeapplication/json {"updatedBy": "Lazarus", "description": "AppBuilder template", "latestVersion": "1.0.10", "adobeRecommended": true, "status": "Approved", "runtime": false, "requestAccessAppId": "FireflySDKEnterprise1",
} Response samples Content typeapplication/json {"id": "991f1cf7-8ecc-403c-9f29-1ab8a3beacbf", "author": "Adobe Inc.", "name": "@adobe/app-builder-template", "createdBy": "Lazarus", "updatedBy": "Lazarus", "description": "AppBuilder template", "adobeRecommended": true, "latestVersion": "1.0.10", "publishDate": "2022-04-20T19:54:41.495Z", "apis": [{"code": "AdobeAnalyticsSDK", "credentialType": "string", "flowType": "string"
}
], "runtime": false, "event": { }, "status": "Approved", "requestAccessAppId": "FireflySDKEnterprise1", "isRequestPending": "true", "orgEntitled": true, "userEntitled": true, "canRequestAccess": true, "disEntitledReasons": [],
}Get information about a template. path Parameters| templateId required | string The id of the template in the database
+ |
Responses/v1/templates/{templateId} Response samples Content typeapplication/json {"id": "991f1cf7-8ecc-403c-9f29-1ab8a3beacbf", "author": "Adobe Inc.", "name": "@adobe/app-builder-template", "createdBy": "Lazarus", "updatedBy": "Lazarus", "description": "AppBuilder template", "adobeRecommended": true, "latestVersion": "1.0.10", "publishDate": "2022-04-20T19:54:41.495Z", "apis": [{"code": "AdobeAnalyticsSDK", "credentialType": "string", "flowType": "string"
}
], "runtime": false, "event": { }, "status": "Approved", "requestAccessAppId": "FireflySDKEnterprise1", "isRequestPending": "true", "orgEntitled": true, "userEntitled": true, "canRequestAccess": true, "disEntitledReasons": [],
}Delete a template from Template Registry. path Parameters| templateId required | string The id of the template in the database
+ |
Responses/v1/templates/{templateId} Install a template path Parameters| templateId required | string The id of the template in the database
+ |
Request Body schema: application/jsonrequired | orgId required | | | projectName required | | | description | | required | object Key value pairs of credential metadata like allowed domains, redirect uris etc
+ | | Array of objects Optional field to include license configs to be assigned to a technical account for an individual API
+ |
Responses Request samples Content typeapplication/json {"orgId": "string", "projectName": "string", "description": "string", "metadata": {"property1": null, "property2": null
},
} Response samples Content typeapplication/json Get information about a template by organization. path Parameters| templateName required | string The name of the template on npmjs.com
+ | | orgName required | string Organisation name on npmjs.com
+ |
Responses/v1/templates/{orgName}/{templateName} Response samples Content typeapplication/json {"id": "991f1cf7-8ecc-403c-9f29-1ab8a3beacbf", "author": "Adobe Inc.", "name": "@adobe/app-builder-template", "createdBy": "Lazarus", "updatedBy": "Lazarus", "description": "AppBuilder template", "adobeRecommended": true, "latestVersion": "1.0.10", "publishDate": "2022-04-20T19:54:41.495Z", "apis": [{"code": "AdobeAnalyticsSDK", "credentialType": "string", "flowType": "string"
}
], "runtime": false, "event": { }, "status": "Approved", "requestAccessAppId": "FireflySDKEnterprise1", "isRequestPending": "true", "orgEntitled": true, "userEntitled": true, "canRequestAccess": true, "disEntitledReasons": [],
}Delete a template from Template Registry by organization. path Parameters| templateName required | string The name of the template on npmjs.com
+ | | orgName required | string Organisation name on npmjs.com
+ |
Responses/v1/templates/{orgName}/{templateName} |