[Index]

API Reference for data/Patch

A Patch represents an update to one or more models in a bundle. The patch tracks the version of the models and packages updated, the source code files that were modified, and the reason.

Model ref.: data/Patch

The full URL would include the host-proxy name: https://[host-proxy].

Variables are enclosed in square brackets.

[hierarchy] is the hierarchy.
1. as UUID. For example: 6t0ggef2c0deab00hb595101
2. in dot notation. E.g. ProviderName.CustomerName.LocationName

For a list of available UUIDs and their dot notations:
GET /api/v0/data/HierarchyNode/?format=json

[pkid] is the ID of the resource instance. Refer to the List reference below.
[filename] refers to a file

GET http://[host-proxy]/api/data/Patch/schema/?hierarchy=[hierarchy]&format=json&schema=1

        {
     "$schema": "http://json-schema.org/draft-03/schema", 
     "type": "object", 
     "properties": {
          "bundleName": {
               "is_password": false, 
               "description": "The name of the bundle to which this patch applies.", 
               "title": "Bundle", 
               "required": false, 
               "displayable": false, 
               "readonly": false, 
               "maxLength": 1024, 
               "type": "string"
          }, 
          "source_code_changes": {
               "is_password": false, 
               "description": "Detailed information regarding each source code file that is updated by this patch.", 
               "title": "Source Code Changes", 
               "minItems": 0, 
               "items": {
                    "is_password": false, 
                    "type": "object", 
                    "properties": {
                         "chroot": {
                              "is_password": false, 
                              "description": "The platform bubble being patched, for example voss-deviceapi, mongo, nginx.", 
                              "title": "Bubble", 
                              "required": false, 
                              "displayable": false, 
                              "readonly": false, 
                              "maxLength": 1024, 
                              "type": "string"
                         }, 
                         "description": {
                              "is_password": false, 
                              "description": "Description of the changes that were made to the given source code file.", 
                              "title": "Description", 
                              "required": false, 
                              "displayable": false, 
                              "readonly": false, 
                              "maxLength": 1024, 
                              "type": "string"
                         }, 
                         "filepath": {
                              "is_password": false, 
                              "description": "The path of a file that was patched.", 
                              "title": "File", 
                              "required": false, 
                              "displayable": false, 
                              "readonly": false, 
                              "maxLength": 1024, 
                              "type": "string"
                         }
                    }
               }, 
               "required": false, 
               "displayable": false, 
               "readonly": false, 
               "type": "array"
          }, 
          "name": {
               "is_password": false, 
               "description": "The unique name of the patch.", 
               "title": "Name", 
               "required": true, 
               "displayable": false, 
               "readonly": false, 
               "maxLength": 1024, 
               "type": "string"
          }, 
          "releases": {
               "is_password": false, 
               "description": "The HCS release to which this patch applies.", 
               "title": "Releases", 
               "minItems": 0, 
               "items": {
                    "pattern": "^[0-9]+\\.[0-9]+\\.[0-9]+( (ES|SU)[0-9]+[A-Za-z]*){0,1}$", 
                    "is_password": false, 
                    "type": "string"
               }, 
               "required": false, 
               "displayable": false, 
               "readonly": false, 
               "type": "array"
          }, 
          "models": {
               "is_password": false, 
               "title": "Models", 
               "minItems": 0, 
               "items": {
                    "is_password": false, 
                    "type": "object", 
                    "properties": {
                         "model_type": {
                              "is_password": false, 
                              "description": "The type of model included in the patch.", 
                              "title": "Type", 
                              "required": false, 
                              "displayable": false, 
                              "readonly": false, 
                              "maxLength": 1024, 
                              "type": "string"
                         }, 
                         "model_instances": {
                              "is_password": false, 
                              "title": "Instances", 
                              "minItems": 0, 
                              "items": {
                                   "type": "object", 
                                   "properties": {
                                        "model_version": {
                                             "is_password": false, 
                                             "description": "The new version of the patched model.", 
                                             "title": "Version", 
                                             "required": false, 
                                             "displayable": false, 
                                             "readonly": false, 
                                             "maxLength": 1024, 
                                             "type": "string"
                                        }, 
                                        "model_instance": {
                                             "is_password": false, 
                                             "description": "The business key of the model included in the patch.", 
                                             "title": "Instance", 
                                             "required": false, 
                                             "displayable": false, 
                                             "readonly": false, 
                                             "maxLength": 1024, 
                                             "type": "string"
                                        }, 
                                        "description": {
                                             "is_password": false, 
                                             "description": "Description of the changes that were made to the given model instance.", 
                                             "title": "Description", 
                                             "required": false, 
                                             "displayable": false, 
                                             "readonly": false, 
                                             "maxLength": 1024, 
                                             "type": "string"
                                        }
                                   }
                              }, 
                              "required": false, 
                              "displayable": false, 
                              "readonly": false, 
                              "type": "array"
                         }
                    }
               }, 
               "required": false, 
               "displayable": false, 
               "readonly": false, 
               "type": "array"
          }, 
          "notes": {
               "is_password": false, 
               "description": "A description of any side-effects resulting from applying this patch, such as migration of existing data.", 
               "title": "Notes", 
               "required": false, 
               "displayable": false, 
               "readonly": false, 
               "maxLength": 1024, 
               "type": "string"
          }, 
          "defect_ids": {
               "is_password": false, 
               "description": "A list defects that are fixed by this patch.", 
               "title": "Defect IDs", 
               "minItems": 0, 
               "items": {
                    "is_password": false, 
                    "type": "string"
               }, 
               "required": false, 
               "displayable": false, 
               "readonly": false, 
               "type": "array"
          }, 
          "version": {
               "is_password": false, 
               "description": "The version of the patch.", 
               "title": "Version", 
               "required": false, 
               "displayable": false, 
               "readonly": false, 
               "maxLength": 1024, 
               "type": "string"
          }, 
          "description": {
               "is_password": false, 
               "description": "Description of the patch.", 
               "title": "Description", 
               "required": false, 
               "displayable": false, 
               "readonly": false, 
               "maxLength": 1024, 
               "type": "string"
          }
     }, 
     "schema_version": "3.1.2"
}

Task	Call	URL	Parameters	Response
Get the GUI Add form.	GET	/api/data/Patch/add/	hierarchy=[hierarchy] format=json	The GUI Add form of data/Patch as JSON

The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.

Task	Call	URL	Parameters	Payload
Create	POST	/api/data/Patch/	hierarchy=[hierarchy]	(For payload specification)

Response is a transaction pkid for the create action.

Use the GET call to

tool/Transaction/[trans pkid]

to inspect the created resource and its instance pkid.

Task	Call	URL	Parameters	Payload
Bulk delete [pkid1],[pkid2]...	DELETE	/api/data/Patch/	hierarchy=[hierarchy]	{"hrefs":["/api/data/Patch/[pkid1]", "/api/data/Patch/[pkid2]", ...]}

For the instance pkids [pkid1],[pkid2], ... that can be added to the DELETE call (the instance pkids to delete), refer to the List GET call for: data/Patch
```
GET http://[host-proxy]/api/data/Patch/?hierarchy=[hierarchy]&format=json
```

Task	Call	URL	Parameters	Payload
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/Patch; optionally with tag_version at [version] and Configuration Template as [configtemplate].	POST	/api/data/Patch/export/	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	{ "hrefs":["/api/data/Patch/[pkid1]", "/api/data/Patch/[pkid2]",...]}}

For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:

        Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
        Content-Language:en
        Content-Type:application/x-zip

For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:

        Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
        Content-Language:en
        Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:

        Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
        Content-Language:en
        Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

The XLSX format can be used to bulk load instances of data/Patch and the JSON format can be used to import instances of data/Patch.

To get the list of all instance pkids [pkid1],[pkid2], ..., use the List GET call for data/Patch:

 GET http://[host-proxy]/api/data/Patch/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Get a compressed format of the Bulk Load spreadsheet template for data/Patch	POST	/api/data/Patch/export_bulkload_template/	hierarchy=[hierarchy] modeltype=data/Patch	The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz

Task	Call	URL	Parameters	Response
List	GET	/api/data/Patch/	hierarchy=[hierarchy] format=json schema=true	The data/Patch schema and all instances as JSON.

(The list will return 0 to 3 data/Patch instances)

GET http://[host]/api/data/Patch/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

{
     "operations": [
          "field_display_policy", 
          "configuration_template", 
          "help", 
          "get", 
          "export_bulkload_template", 
          "list", 
          "update", 
          "remove", 
          "move", 
          "transform", 
          "add", 
          "export", 
          "migration", 
          "bulk_update_form"
     ], 
     "pagination": {
          "direction": "asc", 
          "order_by": "name", 
          "maximum_limit": 2000, 
          "skip": 0, 
          "current": "/api/data/Patch/?skip=0&limit=3&order_by=name&direction=asc&traversal=default", 
          "limit": 3, 
          "total_limit": null, 
          "total": 0
     }, 
     "meta": {
          "tags": [], 
          "cached": true, 
          "title": "title format", 
          "business_key": {
               "hierarchy": false, 
               "unique": [
                    "name"
               ]
          }, 
          "schema_version": "3.1.2", 
          "references": {
               "device": [
                    {
                         "pkid": "", 
                         "href": ""
                    }
               ], 
               "children": [], 
               "parent": [
                    {
                         "pkid": "6t0ggef2c0deab00hb595101", 
                         "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
                    }
               ], 
               "foreign_key": []
          }, 
          "actions": [
               {
                    "add": {
                         "support_async": false, 
                         "class": "add", 
                         "href": "/api/data/Patch/add/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Add"
                    }
               }, 
               {
                    "remove": {
                         "support_async": true, 
                         "class": "delete", 
                         "href": "/api/data/Patch/?hierarchy=[hierarchy]", 
                         "method": "DELETE", 
                         "title": "Delete"
                    }
               }, 
               {
                    "export": {
                         "title": "Export", 
                         "support_async": false, 
                         "submit": "payload", 
                         "class": "export", 
                         "href": "/api/data/Patch/export/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "view": "/api/view/ExportData/add/?auth_token=[authtoken]
                    }
               }, 
               {
                    "export_bulkload_template": {
                         "support_async": false, 
                         "class": "bulkload_template", 
                         "href": "/api/data/Patch/export_bulkload_template/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Export Bulk Load Template"
                    }
               }, 
               {
                    "list": {
                         "support_async": false, 
                         "class": "list", 
                         "href": "/api/data/Patch/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "List"
                    }
               }, 
               {
                    "help": {
                         "support_async": false, 
                         "class": "help", 
                         "href": "/api/data/Patch/help?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Help"
                    }
               }
          ], 
          "model_type": "data/Patch", 
          "model_specific_actions": [
               "list", 
               "get", 
               "add", 
               "update", 
               "remove", 
               "import", 
               "execute", 
               "export", 
               "export_bulkload_template", 
               "help"
          ], 
          "summary_attrs": [
               {
                    "name": "name", 
                    "title": "Name"
               }, 
               {
                    "name": "bundleName", 
                    "title": "Bundle"
               }, 
               {
                    "name": "version", 
                    "title": "Version"
               }, 
               {
                    "name": "description", 
                    "title": "Description"
               }, 
               {
                    "allow_filtering": true, 
                    "name": "hierarchy_friendly_name", 
                    "title": "Located At"
               }
          ], 
          "api_version": "21.2", 
          "tagged_versions": []
     }, 
     "resources": []
}

Task	Call	URL	Parameters	Response
Get the on-line Help for data/Patch.	GET	/api/data/Patch/help	hierarchy=[hierarchy]	On-line help of Model ref.: data/Patch as HTML

Instance API Reference

[pkid] is the ID of the resource instance.
If a payload is required, inspect the schema for payload details.

Task	Call	URL	Parameters	Payload
Modify	PUT	/api/data/Patch/[pkid]/	hierarchy=[hierarchy]	(For payload specification)

For Bulk modification, refer to the Bulk Modify section.

Task	Call	URL	Parameters	Response
Delete	DELETE	/api/data/Patch/[pkid]/	hierarchy=[hierarchy]

Task	Call	URL	Parameters	Payload
Import	POST	/api/data/Patch/[pkid]/import/	hierarchy=[hierarchy]	If payload required:

Task	Call	URL	Parameters	Response
Get a selected [export_format] of the schema and a single instance with [pkid] of data/Patch; optionally with tag_version at [version] and Configuration Template as [configtemplate].	GET	/api/data/Patch/[pkid]/export/	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	The response is an attachment. Refer to the list below.

For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:

        Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
        Content-Language:en
        Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:

        Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
        Content-Language:en
        Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

For export_format=json, the response is a time stamped zip file of data in JSON and a response format:

        Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
        Content-Language:en
        Content-Type:application/x-zip

The XLSX format can be used to bulk load instances of data/Patch and the JSON format can be used to import instances of data/Patch.

For Bulk Export, refer to the Bulk Export section.

Task	Call	URL	Parameters	Payload
Execute	POST	/api/data/Patch/[pkid]/execute/	hierarchy=[hierarchy]	If payload required:

Task	Call	URL	Parameters	Response
Get	GET	/api/data/Patch/[pkid]/	hierarchy=[hierarchy]	The data/Patch instance with [pkid].

Task	Call	URL	Parameters	Response
Help	GET	/api/data/Patch/[pkid]/help	hierarchy=[hierarchy]	The on-line Help for data/Patch.

API Reference for data/Patch

GET http://[host-proxy]/api/data/Patch/schema/?hierarchy=[hierarchy]&format=json&schema=1

Get the Add form

Create

Bulk Delete

Bulk Export

Export Bulk Load Template

List

GET http://[host]/api/data/Patch/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

Help

Instance API Reference

Modify

Delete

Import

Export

Execute

Get

Help