{ "id": "@itentialopensource/adapter-paragon_job_store", "type": "Adapter", "export": "ParagonJobStore", "title": "Paragon_job_store", "src": "adapter.js", "roles": [ "admin" ], "methods": [ { "name": "iapUpdateAdapterConfiguration", "summary": "Updates the adapter configuration", "description": "Updates the adapter configuration file with the provided changes", "input": [ { "name": "configFile", "type": "string", "info": "The name of the file to change", "required": true, "schema": { "title": "configFile", "type": "string" } }, { "name": "changes", "type": "object", "info": "JSON object containing the configuration changes", "required": true, "schema": { "title": "changes", "type": "object" } }, { "name": "entity", "type": "string", "info": "The entity in which the changes are being made", "required": false, "schema": { "title": "entity", "type": "string" } }, { "name": "type", "type": "string", "info": "The type of file to change - action, schema, or mock", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "action", "type": "string", "info": "The action to be changed", "required": false, "schema": { "title": "action", "type": "string" } }, { "name": "replace", "type": "boolean", "info": "True to replace entire mock data, false to merge/append", "required": false, "schema": { "title": "replace", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapUpdateAdapterConfiguration" }, "task": true }, { "name": "iapSuspendAdapter", "summary": "Suspends the adapter", "description": "Suspends the adapter", "input": [ { "name": "mode", "type": "enum", "enumerals": [ "pause", "error" ], "info": "How incoming requests are handled. Defaults to 'pause'", "description": "How incoming requests are handled. Defaults to 'pause'", "schema": { "title": "mode", "type": "string" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter suspended status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapSuspendAdapter" }, "task": true }, { "name": "iapUnsuspendAdapter", "summary": "Unsuspends the adapter", "description": "Unsuspends the adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter suspended status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapUnsuspendAdapter" }, "task": true }, { "name": "iapGetAdapterQueue", "summary": "Return the requests that are waiting in the queue if throttling is enabled", "description": "Return the requests that are waiting in the queue if throttling is enabled", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter queue", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapGetAdapterQueue" }, "task": true }, { "name": "iapFindAdapterPath", "summary": "Provides the ability to see if a particular API path is supported by the adapter", "description": "Provides the ability to see if a particular API path is supported by the adapter", "input": [ { "name": "apiPath", "type": "string", "info": "The API Path you want to check - make sure to not include base path and version", "description": "The API Path you want to check - make sure to not include base path and version", "schema": { "title": "apiPath", "type": "string" }, "required": true } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapFindAdapterPath" }, "task": true }, { "name": "iapTroubleshootAdapter", "summary": "Runs troubleshoot script for adapter", "description": "Runs troubleshoot script for adapter", "input": [ { "name": "props", "type": "object", "info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}", "required": true, "schema": { "title": "props", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapTroubleshootAdapter" }, "task": true }, { "name": "iapRunAdapterHealthcheck", "summary": "Runs healthcheck script for adapter", "description": "Runs healthcheck script for adapter", "input": [], "output": { "name": "result", "type": "boolean", "description": "Whether healthcheck passed or failed", "schema": { "title": "result", "type": "boolean" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterHealthcheck" }, "task": true }, { "name": "iapRunAdapterConnectivity", "summary": "Runs connectivity check script for adapter", "description": "Runs connectivity check script for adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterConnectivity" }, "task": true }, { "name": "iapRunAdapterBasicGet", "summary": "Runs basicGet script for adapter", "description": "Runs basicGet script for adapter", "input": [ { "name": "maxCalls", "required": false, "type": "number", "info": "How many GET endpoints to test (defaults to 5)", "schema": { "title": "maxCalls", "type": "number", "default": 5 } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterBasicGet" }, "task": true }, { "name": "iapMoveAdapterEntitiesToDB", "summary": "Moves entities from an adapter into the Itential Platform database", "description": "Moves entities from an adapter into the Itential Platform database", "input": [], "output": { "name": "res", "type": "object", "description": "A JSON Object containing status, code and the response from the mongo transaction", "schema": { "title": "res", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapMoveAdapterEntitiesToDB" }, "task": true }, { "name": "iapDeactivateTasks", "summary": "Deactivate the inputted tasks", "description": "Deactivate the inputted tasks", "input": [ { "name": "tasks", "type": "array", "description": "Tasks to deactivate", "schema": { "title": "tasks", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing success status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapDeactivateTasks" }, "task": true }, { "name": "iapActivateTasks", "summary": "Activate the inputted tasks", "description": "activate the inputted tasks", "input": [ { "name": "tasks", "type": "array", "description": "Tasks to activate", "schema": { "title": "tasks", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing success status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapActivateTasks" }, "task": true }, { "name": "iapPopulateEntityCache", "summary": "Populate the cache for the given entities", "description": "Populate the cache for the given entities", "input": [ { "name": "entityTypes", "type": "array", "info": "the entity type(s) to populate", "required": true, "schema": { "title": "entityTypes", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapPopulateEntityCache" }, "task": true }, { "name": "iapRetrieveEntitiesCache", "summary": "Retrieves data from cache for specified entity type", "description": "Retrieves data from cache for specified entity type", "input": [ { "name": "entityType", "type": "string", "info": "entity of which to retrieve", "required": true, "schema": { "title": "entityType", "type": "string" } }, { "name": "options", "type": "object", "info": "settings of which data to return and how to return it", "required": false, "schema": { "title": "options", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRetrieveEntitiesCache" }, "task": true }, { "name": "getDevice", "summary": "Get the Appliance", "description": "Get the Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDevice" }, "task": false }, { "name": "getDevicesFiltered", "summary": "Get Appliances that match the filter", "description": "Get Appliances that match the filter", "input": [ { "name": "options", "type": "object", "info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }", "required": true, "schema": { "title": "options", "type": "object" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDevicesFiltered" }, "task": false }, { "name": "isAlive", "summary": "Checks the status for the provided Appliance", "description": "Checks the status for the provided Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } } ], "output": { "name": "result", "type": "boolean", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "boolean" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/isAlive" }, "task": false }, { "name": "getConfig", "summary": "Gets a config for the provided Appliance", "description": "Gets a config for the provided Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } }, { "name": "format", "type": "string", "info": "The format to be returned - this is ignored as we always return json", "required": false, "schema": { "title": "format", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getConfig" }, "task": false }, { "name": "iapGetDeviceCount", "summary": "Gets a device count from the system", "description": "Gets a device count from the system", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapGetDeviceCount" }, "task": false }, { "name": "iapExpandedGenericAdapterRequest", "summary": "Makes the requested generic call with additional options", "description": "Makes the requested generic call with additional options via metadata", "input": [ { "name": "metadata", "type": "object", "info": "metadata for the call (optional)", "description": "metadata for the call - allows for many enhancements (optional)", "schema": { "title": "metadata", "type": "object" }, "required": false }, { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": false }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": false }, { "name": "pathVars", "type": "object", "info": "the parameters to be put within the url path (optional)", "description": "the parameters to be put within the url path (optional)", "schema": { "title": "pathVars", "type": "object" }, "required": false }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapExpandedGenericAdapterRequest" }, "task": true }, { "name": "genericAdapterRequest", "summary": "Makes the requested generic call", "description": "Makes the requested generic call", "input": [ { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": true }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": true }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/genericAdapterRequest" }, "task": true }, { "name": "genericAdapterRequestNoBasePath", "summary": "Makes the requested generic call", "description": "Makes the requested generic call", "input": [ { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": true }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": true }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/genericAdapterRequestNoBasePath" }, "task": true }, { "name": "iapRunAdapterLint", "summary": "Run the adapter lint script to return the results", "description": "Run the adapter lint script to return the results", "input": [], "output": { "name": "result", "type": "string", "description": "A string containing the run results", "schema": { "title": "result", "type": "string" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapRunAdapterLint" }, "task": true }, { "name": "iapRunAdapterTests", "summary": "Run the adapter test scripts (baseunit and unit) to return the results", "description": "Run the adapter test scripts (baseunit and unit) to return the results", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapRunAdapterTests" }, "task": true }, { "name": "iapGetAdapterInventory", "summary": "Provide inventory information abbout the adapter", "description": "Provide inventory information abbout the adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapGetAdapterInventory" }, "task": true }, { "name": "jobstoreServiceUpdateJob", "summary": "Update job by ID", "description": "Update job by ID", "input": [ { "name": "iD", "type": "string", "info": ": string", "required": true, "schema": { "title": "iD", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"job\": {\"parent_uuid\": \"string\", \"parent_type\": \"string\", \"callback_params\": \"string\", \"task_child_refs\": [{\"uuid\": \"string\"}], \"href\": \"string\", \"created_timestamp\": \"string\", \"updated_by\": \"string\", \"updated_timestamp\": \"string\", \"display_name\": \"string\", \"uuid\": \"string\", \"configuration_version\": \"string\", \"created_by\": \"string\", \"trigger\": \"string\", \"progress\": \"string\", \"type\": \"string\", \"annotations\": {\"key_value_pair\": [{\"value\": \"string\", \"key\": \"string\"}]}, \"resources\": \"array\", \"metadata\": [{\"value\": \"string\", \"key\": \"string\"}], \"status\": \"string\", \"description\": \"string\", \"start_time\": \"string\", \"perms2\": {\"owner\": \"string\", \"global_access\": \"string\", \"share\": [{\"access\": \"string\", \"scope\": \"string\", \"levels\": \"string\", \"scope_types\": \"array\"}]}, \"name\": \"string\", \"finish_time\": \"string\", \"status_message\": \"string\", \"schedule_time\": \"string\", \"meta\": {\"enable\": \"boolean\", \"user_visible\": \"boolean\"}, \"callback_url\": \"string\"}, \"ID\": \"string\", \"ignore_optimistic_lock\": \"boolean\", \"fieldMask\": {\"paths\": \"array\"}}", "required": true, "schema": { "type": "object", "properties": { "job": { "type": "object", "properties": { "parent_uuid": { "type": "string", "title": "UUID of the parent object" }, "parent_type": { "type": "string", "title": "Parent resource type" }, "callback_params": { "type": "string", "title": "Serailized Parameter to be passed to callback URL" }, "task_child_refs": { "items": { "type": "object", "properties": { "uuid": { "type": "string" } } }, "type": "array", "title": "Parent Job" }, "href": { "type": "string", "title": "Instance reference URL" }, "created_timestamp": { "type": "string", "title": "Created Timestamp for the object" }, "updated_by": { "type": "string", "title": "user who updated this object" }, "updated_timestamp": { "type": "string", "title": "Updated Timestamp for the object" }, "display_name": { "type": "string", "title": "Display name of this job" }, "uuid": { "type": "string", "title": "UUID of the object, system automatically allocates one if not provided" }, "configuration_version": { "type": "string", "description": "Configuration Version for the object." }, "created_by": { "type": "string", "title": "user who created this object" }, "trigger": { "type": "string", "title": "Trigger of this job e.g. request-id" }, "progress": { "type": "string", "description": "Progress in percentage." }, "type": { "type": "string", "title": "Type of the job" }, "annotations": { "type": "object", "properties": { "key_value_pair": { "items": { "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "type": "array" } } }, "resources": { "items": { "type": "string" }, "type": "array", "description": "Resources which are affected as part of this job. e.g list of devices." }, "metadata": { "items": { "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "type": "array", "title": "Metadata related to the job" }, "status": { "type": "string" }, "description": { "type": "string", "title": "Description of the object" }, "start_time": { "type": "string", "title": "Start time of this job" }, "perms2": { "type": "object", "properties": { "owner": { "type": "string", "title": "Owner project of the object" }, "global_access": { "type": "string", "title": "Share the object globally" }, "share": { "items": { "type": "object", "properties": { "access": { "type": "string", "title": "Allowed permissions in sharing" }, "scope": { "type": "string", "title": "ID of the scope to which the object is shared" }, "levels": { "type": "string", "title": "Number of level to which share should be applied" }, "scope_types": { "items": { "type": "string" }, "type": "array", "title": "Only apply share for specific types" } } }, "type": "array", "title": "Selectively shared object, List of (project, permissions)" } } }, "name": { "type": "string", "title": "Name of the object, defaults to 'default-<resource-type>'" }, "finish_time": { "type": "string", "title": "Finish time of this job" }, "status_message": { "type": "string", "title": "Detail status message" }, "schedule_time": { "type": "string", "title": "Scheduled start time of this job" }, "meta": { "type": "object", "properties": { "enable": { "type": "boolean", "title": "Administratively Enable/Disable this object" }, "user_visible": { "type": "boolean", "title": "System created internal objects will have this flag set and will not be visible" } } }, "callback_url": { "type": "string", "title": "Callback URL for scheduled job" } } }, "ID": { "type": "string" }, "ignore_optimistic_lock": { "type": "boolean" }, "fieldMask": { "description": "paths: \"f.a\"\n paths: \"f.b.d\"\n\nHere `f` represents a field in some root message, `a` and `b`\nfields in the message found in `f`, and `d` a field found in the\nmessage in `f.b`.\n\nField masks are used to specify a subset of fields that should be\nreturned by a get operation or modified by an update operation.\nField masks also have a custom JSON encoding (see below).\n\n# Field Masks in Projections\n\nWhen used in the context of a projection, a response message or\nsub-message is filtered by the API to only contain those fields as\nspecified in the mask. For example, if the mask in the previous\nexample is applied to a response message as follows:\n\n f {\n a : 22\n b {\n d : 1\n x : 2\n }\n y : 13\n }\n z: 8\n\nThe result will not contain specific values for fields x,y and z\n(their value will be set to the default, and omitted in proto text\noutput):\n\n\n f {\n a : 22\n b {\n d : 1\n }\n }\n\nA repeated field is not allowed except at the last position of a\npaths string.\n\nIf a FieldMask object is not present in a get operation, the\noperation applies to all fields (as if a FieldMask of all fields\nhad been specified).\n\nNote that a field mask does not necessarily apply to the\ntop-level response message. In case of a REST get operation, the\nfield mask applies directly to the response, but in case of a REST\nlist operation, the mask instead applies to each individual message\nin the returned resource list. In case of a REST custom method,\nother definitions may be used. Where the mask applies will be\nclearly documented together with its declaration in the API. In\nany case, the effect on the returned resource/resources is required\nbehavior for APIs.\n\n# Field Masks in Update Operations\n\nA field mask in update operations specifies which fields of the\ntargeted resource are going to be updated. The API is required\nto only change the values of the fields as specified in the mask\nand leave the others untouched. If a resource is passed in to\ndescribe the updated values, the API ignores the values of all\nfields not covered by the mask.\n\nIf a repeated field is specified for an update operation, new values will\nbe appended to the existing repeated field in the target resource. Note that\na repeated field is only allowed in the last position of a `paths` string.\n\nIf a sub-message is specified in the last position of the field mask for an\nupdate operation, then new value will be merged into the existing sub-message\nin the target resource.\n\nFor example, given the target message:\n\n f {\n b {\n d: 1\n x: 2\n }\n c: [1]\n }\n\nAnd an update message:\n\n f {\n b {\n d: 10\n }\n c: [2]\n }\n\nthen if the field mask is:\n\n paths: [\"f.b\", \"f.c\"]\n\nthen the result will be:\n\n f {\n b {\n d: 10\n x: 2\n }\n c: [1, 2]\n }\n\nAn implementation may provide options to override this default behavior for\nrepeated and message fields.\n\nIn order to reset a field's value to the default, the field must\nbe in the mask and set to the default value in the provided resource.\nHence, in order to reset all fields of a resource, provide a default\ninstance of the resource and set all fields in the mask, or do\nnot provide a mask as described below.\n\nIf a field mask is not present on update, the operation applies to\nall fields (as if a field mask of all fields has been specified).\nNote that in the presence of schema evolution, this may mean that\nfields the client does not know and has therefore not filled into\nthe request will be reset to their default. If this is unwanted\nbehavior, a specific service may require a client to always specify\na field mask, producing an error if not.\n\nAs with get operations, the location of the resource which\ndescribes the updated values in the request message depends on the\noperation kind. In any case, the effect of the field mask is\nrequired to be honored by the API.\n\n## Considerations for HTTP REST\n\nThe HTTP kind of an update operation which uses a field mask must\nbe set to PATCH instead of PUT in order to satisfy HTTP semantics\n(PUT must only be used for full updates).\n\n# JSON Encoding of Field Masks\n\nIn JSON, a field mask is encoded as a single string where paths are\nseparated by a comma. Fields name in each path are converted\nto/from lower-camel naming conventions.\n\nAs an example, consider the following message declarations:\n\n message Profile {\n User user = 1;\n Photo photo = 2;\n }\n message User {\n string display_name = 1;\n string address = 2;\n }\n\nIn proto a field mask for `Profile` may look as such:\n\n mask {\n paths: \"user.display_name\"\n paths: \"photo\"\n }\n\nIn JSON, the same mask is represented as below:\n\n {\n mask: \"user.displayName,photo\"\n }\n\n# Field Masks and Oneof Fields\n\nField masks treat fields in oneofs just as regular fields. Consider the\nfollowing message:\n\n message SampleMessage {\n oneof test_oneof {\n string name = 4;\n SubMessage sub_message = 9;\n }\n }\n\nThe field mask can be:\n\n mask {\n paths: \"name\"\n }\n\nOr:\n\n mask {\n paths: \"sub_message\"\n }\n\nNote that oneof type names (\"test_oneof\" in this case) cannot be used in\npaths.\n\n## Field Mask Verification\n\nThe implementation of any API method which has a FieldMask type field in the\nrequest should verify the included field paths, and return an\n`INVALID_ARGUMENT` error if any path is unmappable.", "type": "object", "properties": { "paths": { "items": { "type": "string" }, "type": "array", "description": "The set of field mask paths." } }, "title": "`FieldMask` represents a set of symbolic field paths, for example:" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/jobstoreServiceUpdateJob" }, "task": true }, { "name": "jobstoreServiceGetJob", "summary": "Get job by ID", "description": "Get job by ID", "input": [ { "name": "iD", "type": "string", "info": ": string", "required": true, "schema": { "title": "iD", "type": "string" } }, { "name": "detail", "type": "boolean", "info": "if detail is set then reference uuids & child uuids will be returned in the response.: boolean", "required": false, "schema": { "title": "detail", "type": "boolean" } }, { "name": "fields", "type": "array", "info": "limit displayed fields.: array", "required": false, "schema": { "title": "fields", "type": "array" } }, { "name": "refFields", "type": "array", "info": "limit displayed reference fields.: array", "required": false, "schema": { "title": "refFields", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/jobstoreServiceGetJob" }, "task": true }, { "name": "jobstoreServiceDeleteJob", "summary": "Delete job by ID", "description": "Delete job by ID", "input": [ { "name": "iD", "type": "string", "info": ": string", "required": true, "schema": { "title": "iD", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/jobstoreServiceDeleteJob" }, "task": true }, { "name": "jobstoreServiceBulkListJob", "summary": "Bulk list jobs", "description": "This API can be used to list job based on specification given in request body.", "input": [ { "name": "body", "type": "object", "info": ": {\"spec\": {\"ref_fields\": \"array\", \"parent_type\": \"string\", \"filters\": \"array\", \"operation\": \"Must be one of [AND, OR]\", \"json_filters\": [{\"values\": \"array\", \"key\": \"string\"}], \"size\": \"string\", \"from\": \"string\", \"page_marker\": \"string\", \"obj_uuids\": \"array\", \"ref_uuids_map\": \"object\", \"detail\": \"boolean\", \"parent_id\": \"array\", \"ext_ref_uuids\": \"array\", \"back_ref_id\": \"array\", \"exclude_shared\": \"boolean\", \"exclude_hrefs\": \"boolean\", \"tag_detail\": \"boolean\", \"count\": \"boolean\", \"fields\": \"array\", \"parent_fq_name_str\": \"array\", \"ref_uuids\": \"array\", \"sortby\": \"string\", \"tag_filters\": \"array\"}}", "required": true, "schema": { "type": "object", "properties": { "spec": { "type": "object", "properties": { "ref_fields": { "items": { "type": "string" }, "type": "array", "title": "limit displayed reference fields" }, "parent_type": { "type": "string", "title": "Filter by parent type" }, "filters": { "items": { "type": "string" }, "type": "array", "title": "QueryFilter in string format.\nGrpc-gateway doesn't have support for nested structs and maps so\nintroducing new fields which will take string as input" }, "operation": { "default": "AND", "enum": [ "AND", "OR" ], "type": "string" }, "json_filters": { "items": { "type": "object", "properties": { "values": { "items": { "type": "string" }, "type": "array", "title": "Filter values" }, "key": { "type": "string", "title": "Filter key" } } }, "type": "array", "title": "QueryFilter in JSON Format" }, "size": { "type": "string", "title": "Number of items expected to be returned" }, "from": { "type": "string", "title": "Start from items expected to be returned" }, "page_marker": { "type": "string", "description": "Include only objects with UUID lexically greater than this." }, "obj_uuids": { "items": { "type": "string" }, "type": "array", "title": "Filter by UUIDs" }, "ref_uuids_map": { "additionalProperties": { "type": "object", "properties": { "uuids": { "items": { "type": "string" }, "type": "array", "title": "UUIDs for refs and backrefs" } } }, "type": "object", "title": "Filter by ref UUIDss" }, "detail": { "type": "boolean", "title": "Include detail informatoin or not" }, "parent_id": { "items": { "type": "string" }, "type": "array", "title": "Filter by parent UUIDs" }, "ext_ref_uuids": { "items": { "type": "string" }, "type": "array", "title": "Filter by External Ref UUIDss" }, "back_ref_id": { "items": { "type": "string" }, "type": "array", "title": "Filter by backref UUIDss" }, "exclude_shared": { "type": "boolean", "title": "Include shared resources or not" }, "exclude_hrefs": { "type": "boolean", "title": "Exclude href parameters" }, "tag_detail": { "type": "boolean", "title": "Include Tag Details or not" }, "count": { "type": "boolean" }, "fields": { "items": { "type": "string" }, "type": "array", "title": "limit displayed fields" }, "parent_fq_name_str": { "items": { "type": "string" }, "type": "array", "title": "Filter by parent FQ Name" }, "ref_uuids": { "items": { "type": "string" }, "type": "array", "title": "Filter by ref UUIDss" }, "sortby": { "type": "string", "title": "Sort by column with ascending or descending by default ascending" }, "tag_filters": { "items": { "type": "string" }, "type": "array", "title": "Filter by Tag Fields" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/jobstoreServiceBulkListJob" }, "task": true }, { "name": "jobstoreServiceBulkExtRefUpdate", "summary": "Bulk external reference updates", "description": "This API can be used to create/delete multiple references for ExtRef table.", "input": [ { "name": "body", "type": "object", "info": ": {\"items\": [{\"ref-from-type\": \"string\", \"ref-from-uuid\": \"string\", \"operation\": \"string\", \"ref-to-uuid\": \"string\", \"ref-to-type\": \"string\"}]}", "required": true, "schema": { "type": "object", "properties": { "items": { "items": { "type": "object", "properties": { "ref-from-type": { "type": "string" }, "ref-from-uuid": { "type": "string" }, "operation": { "type": "string" }, "ref-to-uuid": { "type": "string" }, "ref-to-type": { "type": "string" } } }, "type": "array" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/jobstoreServiceBulkExtRefUpdate" }, "task": true }, { "name": "jobstoreServiceBulkRefUpdate", "summary": "Bulk reference updates", "description": "This API can be used to ADD/DELETE multiple references between two resources.", "input": [ { "name": "body", "type": "object", "info": ": {\"refs\": [{\"ref-type\": \"string\", \"ref-uuid\": \"string\", \"operation\": \"string\", \"type\": \"string\", \"uuid\": \"string\"}], \"type\": \"string\", \"uuid\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "refs": { "items": { "type": "object", "properties": { "ref-type": { "type": "string" }, "ref-uuid": { "type": "string" }, "operation": { "type": "string" }, "type": { "type": "string" }, "uuid": { "type": "string" } } }, "type": "array" }, "type": { "type": "string" }, "uuid": { "type": "string" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/jobstoreServiceBulkRefUpdate" }, "task": true }, { "name": "jobstoreServiceBulkListJobPurgePolicy", "summary": "Bulk list job-purge-policys", "description": "This API can be used to list job-purge-policy based on specification given in request body.", "input": [ { "name": "body", "type": "object", "info": ": {\"spec\": {\"ref_fields\": \"array\", \"parent_type\": \"string\", \"filters\": \"array\", \"operation\": \"Must be one of [AND, OR]\", \"json_filters\": [{\"values\": \"array\", \"key\": \"string\"}], \"size\": \"string\", \"from\": \"string\", \"page_marker\": \"string\", \"obj_uuids\": \"array\", \"ref_uuids_map\": \"object\", \"detail\": \"boolean\", \"parent_id\": \"array\", \"ext_ref_uuids\": \"array\", \"back_ref_id\": \"array\", \"exclude_shared\": \"boolean\", \"exclude_hrefs\": \"boolean\", \"tag_detail\": \"boolean\", \"count\": \"boolean\", \"fields\": \"array\", \"parent_fq_name_str\": \"array\", \"ref_uuids\": \"array\", \"sortby\": \"string\", \"tag_filters\": \"array\"}}", "required": true, "schema": { "type": "object", "properties": { "spec": { "type": "object", "properties": { "ref_fields": { "items": { "type": "string" }, "type": "array", "title": "limit displayed reference fields" }, "parent_type": { "type": "string", "title": "Filter by parent type" }, "filters": { "items": { "type": "string" }, "type": "array", "title": "QueryFilter in string format.\nGrpc-gateway doesn't have support for nested structs and maps so\nintroducing new fields which will take string as input" }, "operation": { "default": "AND", "enum": [ "AND", "OR" ], "type": "string" }, "json_filters": { "items": { "type": "object", "properties": { "values": { "items": { "type": "string" }, "type": "array", "title": "Filter values" }, "key": { "type": "string", "title": "Filter key" } } }, "type": "array", "title": "QueryFilter in JSON Format" }, "size": { "type": "string", "title": "Number of items expected to be returned" }, "from": { "type": "string", "title": "Start from items expected to be returned" }, "page_marker": { "type": "string", "description": "Include only objects with UUID lexically greater than this." }, "obj_uuids": { "items": { "type": "string" }, "type": "array", "title": "Filter by UUIDs" }, "ref_uuids_map": { "additionalProperties": { "type": "object", "properties": { "uuids": { "items": { "type": "string" }, "type": "array", "title": "UUIDs for refs and backrefs" } } }, "type": "object", "title": "Filter by ref UUIDss" }, "detail": { "type": "boolean", "title": "Include detail informatoin or not" }, "parent_id": { "items": { "type": "string" }, "type": "array", "title": "Filter by parent UUIDs" }, "ext_ref_uuids": { "items": { "type": "string" }, "type": "array", "title": "Filter by External Ref UUIDss" }, "back_ref_id": { "items": { "type": "string" }, "type": "array", "title": "Filter by backref UUIDss" }, "exclude_shared": { "type": "boolean", "title": "Include shared resources or not" }, "exclude_hrefs": { "type": "boolean", "title": "Exclude href parameters" }, "tag_detail": { "type": "boolean", "title": "Include Tag Details or not" }, "count": { "type": "boolean" }, "fields": { "items": { "type": "string" }, "type": "array", "title": "limit displayed fields" }, "parent_fq_name_str": { "items": { "type": "string" }, "type": "array", "title": "Filter by parent FQ Name" }, "ref_uuids": { "items": { "type": "string" }, "type": "array", "title": "Filter by ref UUIDss" }, "sortby": { "type": "string", "title": "Sort by column with ascending or descending by default ascending" }, "tag_filters": { "items": { "type": "string" }, "type": "array", "title": "Filter by Tag Fields" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/jobstoreServiceBulkListJobPurgePolicy" }, "task": true }, { "name": "jobstoreServiceUpdateLastPublishedNotification", "summary": "Update last-published-notification by ID", "description": "Update last-published-notification by ID", "input": [ { "name": "iD", "type": "string", "info": ": string", "required": true, "schema": { "title": "iD", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"ignore_optimistic_lock\": \"boolean\", \"last-published-notification\": {\"updated_timestamp\": \"string\", \"parent_uuid\": \"string\", \"description\": \"string\", \"configuration_version\": \"string\", \"parent_type\": \"string\", \"last_published_timestamp\": \"string\", \"name\": \"string\", \"perms2\": {\"owner\": \"string\", \"global_access\": \"string\", \"share\": [{\"access\": \"string\", \"scope\": \"string\", \"levels\": \"string\", \"scope_types\": \"array\"}]}, \"href\": \"string\", \"meta\": {\"enable\": \"boolean\", \"user_visible\": \"boolean\"}, \"created_by\": \"string\", \"updated_by\": \"string\", \"created_timestamp\": \"string\", \"annotations\": {\"key_value_pair\": [{\"value\": \"string\", \"key\": \"string\"}]}, \"resource_type\": \"string\", \"uuid\": \"string\"}, \"ID\": \"string\", \"fieldMask\": {\"paths\": \"array\"}}", "required": true, "schema": { "type": "object", "properties": { "ignore_optimistic_lock": { "type": "boolean" }, "last-published-notification": { "type": "object", "properties": { "updated_timestamp": { "type": "string", "title": "Updated Timestamp for the object" }, "parent_uuid": { "type": "string", "title": "UUID of the parent object" }, "description": { "type": "string", "title": "Description of the object" }, "configuration_version": { "type": "string", "description": "Configuration Version for the object." }, "parent_type": { "type": "string", "title": "Parent resource type" }, "last_published_timestamp": { "type": "string", "title": "The last published timestamp for the notification" }, "name": { "type": "string", "title": "Name of the object, defaults to 'default-<resource-type>'" }, "perms2": { "type": "object", "properties": { "owner": { "type": "string", "title": "Owner project of the object" }, "global_access": { "type": "string", "title": "Share the object globally" }, "share": { "items": { "type": "object", "properties": { "access": { "type": "string", "title": "Allowed permissions in sharing" }, "scope": { "type": "string", "title": "ID of the scope to which the object is shared" }, "levels": { "type": "string", "title": "Number of level to which share should be applied" }, "scope_types": { "items": { "type": "string" }, "type": "array", "title": "Only apply share for specific types" } } }, "type": "array", "title": "Selectively shared object, List of (project, permissions)" } } }, "href": { "type": "string", "title": "Instance reference URL" }, "meta": { "type": "object", "properties": { "enable": { "type": "boolean", "title": "Administratively Enable/Disable this object" }, "user_visible": { "type": "boolean", "title": "System created internal objects will have this flag set and will not be visible" } } }, "created_by": { "type": "string", "title": "user who created this object" }, "updated_by": { "type": "string", "title": "user who updated this object" }, "created_timestamp": { "type": "string", "title": "Created Timestamp for the object" }, "annotations": { "type": "object", "properties": { "key_value_pair": { "items": { "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "type": "array" } } }, "resource_type": { "type": "string", "description": "Type of the resource." }, "uuid": { "type": "string", "title": "UUID of the object, system automatically allocates one if not provided" } } }, "ID": { "type": "string" }, "fieldMask": { "description": "paths: \"f.a\"\n paths: \"f.b.d\"\n\nHere `f` represents a field in some root message, `a` and `b`\nfields in the message found in `f`, and `d` a field found in the\nmessage in `f.b`.\n\nField masks are used to specify a subset of fields that should be\nreturned by a get operation or modified by an update operation.\nField masks also have a custom JSON encoding (see below).\n\n# Field Masks in Projections\n\nWhen used in the context of a projection, a response message or\nsub-message is filtered by the API to only contain those fields as\nspecified in the mask. For example, if the mask in the previous\nexample is applied to a response message as follows:\n\n f {\n a : 22\n b {\n d : 1\n x : 2\n }\n y : 13\n }\n z: 8\n\nThe result will not contain specific values for fields x,y and z\n(their value will be set to the default, and omitted in proto text\noutput):\n\n\n f {\n a : 22\n b {\n d : 1\n }\n }\n\nA repeated field is not allowed except at the last position of a\npaths string.\n\nIf a FieldMask object is not present in a get operation, the\noperation applies to all fields (as if a FieldMask of all fields\nhad been specified).\n\nNote that a field mask does not necessarily apply to the\ntop-level response message. In case of a REST get operation, the\nfield mask applies directly to the response, but in case of a REST\nlist operation, the mask instead applies to each individual message\nin the returned resource list. In case of a REST custom method,\nother definitions may be used. Where the mask applies will be\nclearly documented together with its declaration in the API. In\nany case, the effect on the returned resource/resources is required\nbehavior for APIs.\n\n# Field Masks in Update Operations\n\nA field mask in update operations specifies which fields of the\ntargeted resource are going to be updated. The API is required\nto only change the values of the fields as specified in the mask\nand leave the others untouched. If a resource is passed in to\ndescribe the updated values, the API ignores the values of all\nfields not covered by the mask.\n\nIf a repeated field is specified for an update operation, new values will\nbe appended to the existing repeated field in the target resource. Note that\na repeated field is only allowed in the last position of a `paths` string.\n\nIf a sub-message is specified in the last position of the field mask for an\nupdate operation, then new value will be merged into the existing sub-message\nin the target resource.\n\nFor example, given the target message:\n\n f {\n b {\n d: 1\n x: 2\n }\n c: [1]\n }\n\nAnd an update message:\n\n f {\n b {\n d: 10\n }\n c: [2]\n }\n\nthen if the field mask is:\n\n paths: [\"f.b\", \"f.c\"]\n\nthen the result will be:\n\n f {\n b {\n d: 10\n x: 2\n }\n c: [1, 2]\n }\n\nAn implementation may provide options to override this default behavior for\nrepeated and message fields.\n\nIn order to reset a field's value to the default, the field must\nbe in the mask and set to the default value in the provided resource.\nHence, in order to reset all fields of a resource, provide a default\ninstance of the resource and set all fields in the mask, or do\nnot provide a mask as described below.\n\nIf a field mask is not present on update, the operation applies to\nall fields (as if a field mask of all fields has been specified).\nNote that in the presence of schema evolution, this may mean that\nfields the client does not know and has therefore not filled into\nthe request will be reset to their default. If this is unwanted\nbehavior, a specific service may require a client to always specify\na field mask, producing an error if not.\n\nAs with get operations, the location of the resource which\ndescribes the updated values in the request message depends on the\noperation kind. In any case, the effect of the field mask is\nrequired to be honored by the API.\n\n## Considerations for HTTP REST\n\nThe HTTP kind of an update operation which uses a field mask must\nbe set to PATCH instead of PUT in order to satisfy HTTP semantics\n(PUT must only be used for full updates).\n\n# JSON Encoding of Field Masks\n\nIn JSON, a field mask is encoded as a single string where paths are\nseparated by a comma. Fields name in each path are converted\nto/from lower-camel naming conventions.\n\nAs an example, consider the following message declarations:\n\n message Profile {\n User user = 1;\n Photo photo = 2;\n }\n message User {\n string display_name = 1;\n string address = 2;\n }\n\nIn proto a field mask for `Profile` may look as such:\n\n mask {\n paths: \"user.display_name\"\n paths: \"photo\"\n }\n\nIn JSON, the same mask is represented as below:\n\n {\n mask: \"user.displayName,photo\"\n }\n\n# Field Masks and Oneof Fields\n\nField masks treat fields in oneofs just as regular fields. Consider the\nfollowing message:\n\n message SampleMessage {\n oneof test_oneof {\n string name = 4;\n SubMessage sub_message = 9;\n }\n }\n\nThe field mask can be:\n\n mask {\n paths: \"name\"\n }\n\nOr:\n\n mask {\n paths: \"sub_message\"\n }\n\nNote that oneof type names (\"test_oneof\" in this case) cannot be used in\npaths.\n\n## Field Mask Verification\n\nThe implementation of any API method which has a FieldMask type field in the\nrequest should verify the included field paths, and return an\n`INVALID_ARGUMENT` error if any path is unmappable.", "type": "object", "properties": { "paths": { "items": { "type": "string" }, "type": "array", "description": "The set of field mask paths." } }, "title": "`FieldMask` represents a set of symbolic field paths, for example:" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/jobstoreServiceUpdateLastPublishedNotification" }, "task": true }, { "name": "jobstoreServiceGetLastPublishedNotification", "summary": "Get last-published-notification by ID", "description": "Get last-published-notification by ID", "input": [ { "name": "iD", "type": "string", "info": ": string", "required": true, "schema": { "title": "iD", "type": "string" } }, { "name": "detail", "type": "boolean", "info": "if detail is set then reference uuids & child uuids will be returned in the response.: boolean", "required": false, "schema": { "title": "detail", "type": "boolean" } }, { "name": "fields", "type": "array", "info": "limit displayed fields.: array", "required": false, "schema": { "title": "fields", "type": "array" } }, { "name": "refFields", "type": "array", "info": "limit displayed reference fields.: array", "required": false, "schema": { "title": "refFields", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/jobstoreServiceGetLastPublishedNotification" }, "task": true }, { "name": "jobstoreServiceDeleteLastPublishedNotification", "summary": "Delete last-published-notification by ID", "description": "Delete last-published-notification by ID", "input": [ { "name": "iD", "type": "string", "info": ": string", "required": true, "schema": { "title": "iD", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/jobstoreServiceDeleteLastPublishedNotification" }, "task": true }, { "name": "jobstoreServiceBulkListTask", "summary": "Bulk list tasks", "description": "This API can be used to list task based on specification given in request body.", "input": [ { "name": "body", "type": "object", "info": ": {\"spec\": {\"ref_fields\": \"array\", \"parent_type\": \"string\", \"filters\": \"array\", \"operation\": \"Must be one of [AND, OR]\", \"json_filters\": [{\"values\": \"array\", \"key\": \"string\"}], \"size\": \"string\", \"from\": \"string\", \"page_marker\": \"string\", \"obj_uuids\": \"array\", \"ref_uuids_map\": \"object\", \"detail\": \"boolean\", \"parent_id\": \"array\", \"ext_ref_uuids\": \"array\", \"back_ref_id\": \"array\", \"exclude_shared\": \"boolean\", \"exclude_hrefs\": \"boolean\", \"tag_detail\": \"boolean\", \"count\": \"boolean\", \"fields\": \"array\", \"parent_fq_name_str\": \"array\", \"ref_uuids\": \"array\", \"sortby\": \"string\", \"tag_filters\": \"array\"}}", "required": true, "schema": { "type": "object", "properties": { "spec": { "type": "object", "properties": { "ref_fields": { "items": { "type": "string" }, "type": "array", "title": "limit displayed reference fields" }, "parent_type": { "type": "string", "title": "Filter by parent type" }, "filters": { "items": { "type": "string" }, "type": "array", "title": "QueryFilter in string format.\nGrpc-gateway doesn't have support for nested structs and maps so\nintroducing new fields which will take string as input" }, "operation": { "default": "AND", "enum": [ "AND", "OR" ], "type": "string" }, "json_filters": { "items": { "type": "object", "properties": { "values": { "items": { "type": "string" }, "type": "array", "title": "Filter values" }, "key": { "type": "string", "title": "Filter key" } } }, "type": "array", "title": "QueryFilter in JSON Format" }, "size": { "type": "string", "title": "Number of items expected to be returned" }, "from": { "type": "string", "title": "Start from items expected to be returned" }, "page_marker": { "type": "string", "description": "Include only objects with UUID lexically greater than this." }, "obj_uuids": { "items": { "type": "string" }, "type": "array", "title": "Filter by UUIDs" }, "ref_uuids_map": { "additionalProperties": { "type": "object", "properties": { "uuids": { "items": { "type": "string" }, "type": "array", "title": "UUIDs for refs and backrefs" } } }, "type": "object", "title": "Filter by ref UUIDss" }, "detail": { "type": "boolean", "title": "Include detail informatoin or not" }, "parent_id": { "items": { "type": "string" }, "type": "array", "title": "Filter by parent UUIDs" }, "ext_ref_uuids": { "items": { "type": "string" }, "type": "array", "title": "Filter by External Ref UUIDss" }, "back_ref_id": { "items": { "type": "string" }, "type": "array", "title": "Filter by backref UUIDss" }, "exclude_shared": { "type": "boolean", "title": "Include shared resources or not" }, "exclude_hrefs": { "type": "boolean", "title": "Exclude href parameters" }, "tag_detail": { "type": "boolean", "title": "Include Tag Details or not" }, "count": { "type": "boolean" }, "fields": { "items": { "type": "string" }, "type": "array", "title": "limit displayed fields" }, "parent_fq_name_str": { "items": { "type": "string" }, "type": "array", "title": "Filter by parent FQ Name" }, "ref_uuids": { "items": { "type": "string" }, "type": "array", "title": "Filter by ref UUIDss" }, "sortby": { "type": "string", "title": "Sort by column with ascending or descending by default ascending" }, "tag_filters": { "items": { "type": "string" }, "type": "array", "title": "Filter by Tag Fields" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/jobstoreServiceBulkListTask" }, "task": true }, { "name": "jobstoreServiceCreateLastPublishedNotification", "summary": "Create last-published-notification", "description": "Create last-published-notification", "input": [ { "name": "body", "type": "object", "info": ": {\"last-published-notification\": {\"updated_timestamp\": \"string\", \"parent_uuid\": \"string\", \"description\": \"string\", \"configuration_version\": \"string\", \"parent_type\": \"string\", \"last_published_timestamp\": \"string\", \"name\": \"string\", \"perms2\": {\"owner\": \"string\", \"global_access\": \"string\", \"share\": [{\"access\": \"string\", \"scope\": \"string\", \"levels\": \"string\", \"scope_types\": \"array\"}]}, \"href\": \"string\", \"meta\": {\"enable\": \"boolean\", \"user_visible\": \"boolean\"}, \"created_by\": \"string\", \"updated_by\": \"string\", \"created_timestamp\": \"string\", \"annotations\": {\"key_value_pair\": [{\"value\": \"string\", \"key\": \"string\"}]}, \"resource_type\": \"string\", \"uuid\": \"string\"}}", "required": true, "schema": { "type": "object", "properties": { "last-published-notification": { "type": "object", "properties": { "updated_timestamp": { "type": "string", "title": "Updated Timestamp for the object" }, "parent_uuid": { "type": "string", "title": "UUID of the parent object" }, "description": { "type": "string", "title": "Description of the object" }, "configuration_version": { "type": "string", "description": "Configuration Version for the object." }, "parent_type": { "type": "string", "title": "Parent resource type" }, "last_published_timestamp": { "type": "string", "title": "The last published timestamp for the notification" }, "name": { "type": "string", "title": "Name of the object, defaults to 'default-<resource-type>'" }, "perms2": { "type": "object", "properties": { "owner": { "type": "string", "title": "Owner project of the object" }, "global_access": { "type": "string", "title": "Share the object globally" }, "share": { "items": { "type": "object", "properties": { "access": { "type": "string", "title": "Allowed permissions in sharing" }, "scope": { "type": "string", "title": "ID of the scope to which the object is shared" }, "levels": { "type": "string", "title": "Number of level to which share should be applied" }, "scope_types": { "items": { "type": "string" }, "type": "array", "title": "Only apply share for specific types" } } }, "type": "array", "title": "Selectively shared object, List of (project, permissions)" } } }, "href": { "type": "string", "title": "Instance reference URL" }, "meta": { "type": "object", "properties": { "enable": { "type": "boolean", "title": "Administratively Enable/Disable this object" }, "user_visible": { "type": "boolean", "title": "System created internal objects will have this flag set and will not be visible" } } }, "created_by": { "type": "string", "title": "user who created this object" }, "updated_by": { "type": "string", "title": "user who updated this object" }, "created_timestamp": { "type": "string", "title": "Created Timestamp for the object" }, "annotations": { "type": "object", "properties": { "key_value_pair": { "items": { "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "type": "array" } } }, "resource_type": { "type": "string", "description": "Type of the resource." }, "uuid": { "type": "string", "title": "UUID of the object, system automatically allocates one if not provided" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/jobstoreServiceCreateLastPublishedNotification" }, "task": true }, { "name": "jobstoreServiceListLastPublishedNotification", "summary": "List last-published-notifications", "description": "This API can be used to list last-published-notification based on specification given in query parameters.", "input": [ { "name": "specSize", "type": "string", "info": "Number of items expected to be returned.: string", "required": false, "schema": { "title": "specSize", "type": "string" } }, { "name": "specPageMarker", "type": "string", "info": "Include only objects with UUID lexically greater than this.: string", "required": false, "schema": { "title": "specPageMarker", "type": "string" } }, { "name": "specDetail", "type": "boolean", "info": "Include detail informatoin or not.: boolean", "required": false, "schema": { "title": "specDetail", "type": "boolean" } }, { "name": "specCount", "type": "boolean", "info": ": boolean", "required": false, "schema": { "title": "specCount", "type": "boolean" } }, { "name": "specExcludeShared", "type": "boolean", "info": "Include shared resources or not.: boolean", "required": false, "schema": { "title": "specExcludeShared", "type": "boolean" } }, { "name": "specExcludeHrefs", "type": "boolean", "info": "Exclude href parameters.: boolean", "required": false, "schema": { "title": "specExcludeHrefs", "type": "boolean" } }, { "name": "specParentFqNameStr", "type": "array", "info": "Filter by parent FQ Name.: array", "required": false, "schema": { "title": "specParentFqNameStr", "type": "array" } }, { "name": "specParentType", "type": "string", "info": "Filter by parent type.: string", "required": false, "schema": { "title": "specParentType", "type": "string" } }, { "name": "specParentId", "type": "array", "info": "Filter by parent UUIDs.: array", "required": false, "schema": { "title": "specParentId", "type": "array" } }, { "name": "specBackRefId", "type": "array", "info": "Filter by backref UUIDss.: array", "required": false, "schema": { "title": "specBackRefId", "type": "array" } }, { "name": "specObjUuids", "type": "array", "info": "Filter by UUIDs.: array", "required": false, "schema": { "title": "specObjUuids", "type": "array" } }, { "name": "specFields", "type": "array", "info": "limit displayed fields.: array", "required": false, "schema": { "title": "specFields", "type": "array" } }, { "name": "specFilters", "type": "array", "info": "QueryFilter in string format.\nGrpc-gateway doesn't have support for nested structs and maps so\nintroducing new fields which will take string as input.: array", "required": false, "schema": { "title": "specFilters", "type": "array" } }, { "name": "specRefUuids", "type": "array", "info": "Filter by ref UUIDss.: array", "required": false, "schema": { "title": "specRefUuids", "type": "array" } }, { "name": "specFrom", "type": "string", "info": "Start from items expected to be returned.: string", "required": false, "schema": { "title": "specFrom", "type": "string" } }, { "name": "specSortby", "type": "string", "info": "Sort by column with ascending or descending by default ascending.: string", "required": false, "schema": { "title": "specSortby", "type": "string" } }, { "name": "specOperation", "type": "string", "info": "Operation determines whether union or interjection.: Must be one of [AND, OR]", "required": false, "schema": { "title": "specOperation", "type": "string" } }, { "name": "specTagFilters", "type": "array", "info": "Filter by Tag Fields.: array", "required": false, "schema": { "title": "specTagFilters", "type": "array" } }, { "name": "specTagDetail", "type": "boolean", "info": "Include Tag Details or not.: boolean", "required": false, "schema": { "title": "specTagDetail", "type": "boolean" } }, { "name": "specRefFields", "type": "array", "info": "limit displayed reference fields.: array", "required": false, "schema": { "title": "specRefFields", "type": "array" } }, { "name": "specExtRefUuids", "type": "array", "info": "Filter by External Ref UUIDss.: array", "required": false, "schema": { "title": "specExtRefUuids", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/jobstoreServiceListLastPublishedNotification" }, "task": true }, { "name": "jobstoreServiceCreateJobPurgePolicy", "summary": "Create job-purge-policy", "description": "Create job-purge-policy", "input": [ { "name": "body", "type": "object", "info": ": {\"job-purge-policy\": {\"updated_timestamp\": \"string\", \"parent_uuid\": \"string\", \"description\": \"string\", \"configuration_version\": \"string\", \"tenant_id\": \"string\", \"parent_type\": \"string\", \"perms2\": {\"owner\": \"string\", \"global_access\": \"string\", \"share\": [{\"access\": \"string\", \"scope\": \"string\", \"levels\": \"string\", \"scope_types\": \"array\"}]}, \"name\": \"string\", \"retention_period\": \"string\", \"href\": \"string\", \"meta\": {\"enable\": \"boolean\", \"user_visible\": \"boolean\"}, \"created_by\": \"string\", \"updated_by\": \"string\", \"created_timestamp\": \"string\", \"annotations\": {\"key_value_pair\": [{\"value\": \"string\", \"key\": \"string\"}]}, \"uuid\": \"string\"}}", "required": true, "schema": { "type": "object", "properties": { "job-purge-policy": { "type": "object", "properties": { "updated_timestamp": { "type": "string", "title": "Updated Timestamp for the object" }, "parent_uuid": { "type": "string", "title": "UUID of the parent object" }, "description": { "type": "string", "title": "Description of the object" }, "configuration_version": { "type": "string", "description": "Configuration Version for the object." }, "tenant_id": { "type": "string", "title": "tenant identifier" }, "parent_type": { "type": "string", "title": "Parent resource type" }, "perms2": { "type": "object", "properties": { "owner": { "type": "string", "title": "Owner project of the object" }, "global_access": { "type": "string", "title": "Share the object globally" }, "share": { "items": { "type": "object", "properties": { "access": { "type": "string", "title": "Allowed permissions in sharing" }, "scope": { "type": "string", "title": "ID of the scope to which the object is shared" }, "levels": { "type": "string", "title": "Number of level to which share should be applied" }, "scope_types": { "items": { "type": "string" }, "type": "array", "title": "Only apply share for specific types" } } }, "type": "array", "title": "Selectively shared object, List of (project, permissions)" } } }, "name": { "type": "string", "title": "Name of the object, defaults to 'default-<resource-type>'" }, "retention_period": { "type": "string", "title": "retention period in days" }, "href": { "type": "string", "title": "Instance reference URL" }, "meta": { "type": "object", "properties": { "enable": { "type": "boolean", "title": "Administratively Enable/Disable this object" }, "user_visible": { "type": "boolean", "title": "System created internal objects will have this flag set and will not be visible" } } }, "created_by": { "type": "string", "title": "user who created this object" }, "updated_by": { "type": "string", "title": "user who updated this object" }, "created_timestamp": { "type": "string", "title": "Created Timestamp for the object" }, "annotations": { "type": "object", "properties": { "key_value_pair": { "items": { "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "type": "array" } } }, "uuid": { "type": "string", "title": "UUID of the object, system automatically allocates one if not provided" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/jobstoreServiceCreateJobPurgePolicy" }, "task": true }, { "name": "jobstoreServiceListJobPurgePolicy", "summary": "List job-purge-policys", "description": "This API can be used to list job-purge-policy based on specification given in query parameters.", "input": [ { "name": "specSize", "type": "string", "info": "Number of items expected to be returned.: string", "required": false, "schema": { "title": "specSize", "type": "string" } }, { "name": "specPageMarker", "type": "string", "info": "Include only objects with UUID lexically greater than this.: string", "required": false, "schema": { "title": "specPageMarker", "type": "string" } }, { "name": "specDetail", "type": "boolean", "info": "Include detail informatoin or not.: boolean", "required": false, "schema": { "title": "specDetail", "type": "boolean" } }, { "name": "specCount", "type": "boolean", "info": ": boolean", "required": false, "schema": { "title": "specCount", "type": "boolean" } }, { "name": "specExcludeShared", "type": "boolean", "info": "Include shared resources or not.: boolean", "required": false, "schema": { "title": "specExcludeShared", "type": "boolean" } }, { "name": "specExcludeHrefs", "type": "boolean", "info": "Exclude href parameters.: boolean", "required": false, "schema": { "title": "specExcludeHrefs", "type": "boolean" } }, { "name": "specParentFqNameStr", "type": "array", "info": "Filter by parent FQ Name.: array", "required": false, "schema": { "title": "specParentFqNameStr", "type": "array" } }, { "name": "specParentType", "type": "string", "info": "Filter by parent type.: string", "required": false, "schema": { "title": "specParentType", "type": "string" } }, { "name": "specParentId", "type": "array", "info": "Filter by parent UUIDs.: array", "required": false, "schema": { "title": "specParentId", "type": "array" } }, { "name": "specBackRefId", "type": "array", "info": "Filter by backref UUIDss.: array", "required": false, "schema": { "title": "specBackRefId", "type": "array" } }, { "name": "specObjUuids", "type": "array", "info": "Filter by UUIDs.: array", "required": false, "schema": { "title": "specObjUuids", "type": "array" } }, { "name": "specFields", "type": "array", "info": "limit displayed fields.: array", "required": false, "schema": { "title": "specFields", "type": "array" } }, { "name": "specFilters", "type": "array", "info": "QueryFilter in string format.\nGrpc-gateway doesn't have support for nested structs and maps so\nintroducing new fields which will take string as input.: array", "required": false, "schema": { "title": "specFilters", "type": "array" } }, { "name": "specRefUuids", "type": "array", "info": "Filter by ref UUIDss.: array", "required": false, "schema": { "title": "specRefUuids", "type": "array" } }, { "name": "specFrom", "type": "string", "info": "Start from items expected to be returned.: string", "required": false, "schema": { "title": "specFrom", "type": "string" } }, { "name": "specSortby", "type": "string", "info": "Sort by column with ascending or descending by default ascending.: string", "required": false, "schema": { "title": "specSortby", "type": "string" } }, { "name": "specOperation", "type": "string", "info": "Operation determines whether union or interjection.: Must be one of [AND, OR]", "required": false, "schema": { "title": "specOperation", "type": "string" } }, { "name": "specTagFilters", "type": "array", "info": "Filter by Tag Fields.: array", "required": false, "schema": { "title": "specTagFilters", "type": "array" } }, { "name": "specTagDetail", "type": "boolean", "info": "Include Tag Details or not.: boolean", "required": false, "schema": { "title": "specTagDetail", "type": "boolean" } }, { "name": "specRefFields", "type": "array", "info": "limit displayed reference fields.: array", "required": false, "schema": { "title": "specRefFields", "type": "array" } }, { "name": "specExtRefUuids", "type": "array", "info": "Filter by External Ref UUIDss.: array", "required": false, "schema": { "title": "specExtRefUuids", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/jobstoreServiceListJobPurgePolicy" }, "task": true }, { "name": "jobstoreServiceCreateTask", "summary": "Create task", "description": "Create task", "input": [ { "name": "body", "type": "object", "info": ": {\"task\": {\"parent_uuid\": \"string\", \"parent_type\": \"string\", \"href\": \"string\", \"parent_task\": \"string\", \"created_timestamp\": \"string\", \"updated_by\": \"string\", \"updated_timestamp\": \"string\", \"task_type\": \"string\", \"display_name\": \"string\", \"uuid\": \"string\", \"configuration_version\": \"string\", \"created_by\": \"string\", \"progress\": \"string\", \"status_message\": \"string\", \"annotations\": {\"key_value_pair\": [{\"value\": \"string\", \"key\": \"string\"}]}, \"resources\": \"array\", \"status\": \"string\", \"description\": \"string\", \"start_time\": \"string\", \"perms2\": {\"owner\": \"string\", \"global_access\": \"string\", \"share\": [{\"access\": \"string\", \"scope\": \"string\", \"levels\": \"string\", \"scope_types\": \"array\"}]}, \"name\": \"string\", \"finish_time\": \"string\", \"meta\": {\"enable\": \"boolean\", \"user_visible\": \"boolean\"}}}", "required": true, "schema": { "type": "object", "properties": { "task": { "type": "object", "properties": { "parent_uuid": { "type": "string", "title": "UUID of the parent object" }, "parent_type": { "type": "string", "title": "Parent resource type" }, "href": { "type": "string", "title": "Instance reference URL" }, "parent_task": { "type": "string", "title": "Parent Task" }, "created_timestamp": { "type": "string", "title": "Created Timestamp for the object" }, "updated_by": { "type": "string", "title": "user who updated this object" }, "updated_timestamp": { "type": "string", "title": "Updated Timestamp for the object" }, "task_type": { "type": "string" }, "display_name": { "type": "string", "title": "Display name of this task" }, "uuid": { "type": "string", "title": "UUID of the object, system automatically allocates one if not provided" }, "configuration_version": { "type": "string", "description": "Configuration Version for the object." }, "created_by": { "type": "string", "title": "user who created this object" }, "progress": { "type": "string", "description": "Progress in percentage." }, "status_message": { "type": "string", "title": "Detail status message" }, "annotations": { "type": "object", "properties": { "key_value_pair": { "items": { "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "type": "array" } } }, "resources": { "items": { "type": "string" }, "type": "array", "description": "Resources which are affected as part of this job. e.g list of devices." }, "status": { "type": "string" }, "description": { "type": "string", "title": "Description of the object" }, "start_time": { "type": "string", "title": "Start time of this job" }, "perms2": { "type": "object", "properties": { "owner": { "type": "string", "title": "Owner project of the object" }, "global_access": { "type": "string", "title": "Share the object globally" }, "share": { "items": { "type": "object", "properties": { "access": { "type": "string", "title": "Allowed permissions in sharing" }, "scope": { "type": "string", "title": "ID of the scope to which the object is shared" }, "levels": { "type": "string", "title": "Number of level to which share should be applied" }, "scope_types": { "items": { "type": "string" }, "type": "array", "title": "Only apply share for specific types" } } }, "type": "array", "title": "Selectively shared object, List of (project, permissions)" } } }, "name": { "type": "string", "title": "Name of the object, defaults to 'default-<resource-type>'" }, "finish_time": { "type": "string", "title": "Finish time of this job" }, "meta": { "type": "object", "properties": { "enable": { "type": "boolean", "title": "Administratively Enable/Disable this object" }, "user_visible": { "type": "boolean", "title": "System created internal objects will have this flag set and will not be visible" } } } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/jobstoreServiceCreateTask" }, "task": true }, { "name": "jobstoreServiceListTask", "summary": "List tasks", "description": "This API can be used to list task based on specification given in query parameters.", "input": [ { "name": "specSize", "type": "string", "info": "Number of items expected to be returned.: string", "required": false, "schema": { "title": "specSize", "type": "string" } }, { "name": "specPageMarker", "type": "string", "info": "Include only objects with UUID lexically greater than this.: string", "required": false, "schema": { "title": "specPageMarker", "type": "string" } }, { "name": "specDetail", "type": "boolean", "info": "Include detail informatoin or not.: boolean", "required": false, "schema": { "title": "specDetail", "type": "boolean" } }, { "name": "specCount", "type": "boolean", "info": ": boolean", "required": false, "schema": { "title": "specCount", "type": "boolean" } }, { "name": "specExcludeShared", "type": "boolean", "info": "Include shared resources or not.: boolean", "required": false, "schema": { "title": "specExcludeShared", "type": "boolean" } }, { "name": "specExcludeHrefs", "type": "boolean", "info": "Exclude href parameters.: boolean", "required": false, "schema": { "title": "specExcludeHrefs", "type": "boolean" } }, { "name": "specParentFqNameStr", "type": "array", "info": "Filter by parent FQ Name.: array", "required": false, "schema": { "title": "specParentFqNameStr", "type": "array" } }, { "name": "specParentType", "type": "string", "info": "Filter by parent type.: string", "required": false, "schema": { "title": "specParentType", "type": "string" } }, { "name": "specParentId", "type": "array", "info": "Filter by parent UUIDs.: array", "required": false, "schema": { "title": "specParentId", "type": "array" } }, { "name": "specBackRefId", "type": "array", "info": "Filter by backref UUIDss.: array", "required": false, "schema": { "title": "specBackRefId", "type": "array" } }, { "name": "specObjUuids", "type": "array", "info": "Filter by UUIDs.: array", "required": false, "schema": { "title": "specObjUuids", "type": "array" } }, { "name": "specFields", "type": "array", "info": "limit displayed fields.: array", "required": false, "schema": { "title": "specFields", "type": "array" } }, { "name": "specFilters", "type": "array", "info": "QueryFilter in string format.\nGrpc-gateway doesn't have support for nested structs and maps so\nintroducing new fields which will take string as input.: array", "required": false, "schema": { "title": "specFilters", "type": "array" } }, { "name": "specRefUuids", "type": "array", "info": "Filter by ref UUIDss.: array", "required": false, "schema": { "title": "specRefUuids", "type": "array" } }, { "name": "specFrom", "type": "string", "info": "Start from items expected to be returned.: string", "required": false, "schema": { "title": "specFrom", "type": "string" } }, { "name": "specSortby", "type": "string", "info": "Sort by column with ascending or descending by default ascending.: string", "required": false, "schema": { "title": "specSortby", "type": "string" } }, { "name": "specOperation", "type": "string", "info": "Operation determines whether union or interjection.: Must be one of [AND, OR]", "required": false, "schema": { "title": "specOperation", "type": "string" } }, { "name": "specTagFilters", "type": "array", "info": "Filter by Tag Fields.: array", "required": false, "schema": { "title": "specTagFilters", "type": "array" } }, { "name": "specTagDetail", "type": "boolean", "info": "Include Tag Details or not.: boolean", "required": false, "schema": { "title": "specTagDetail", "type": "boolean" } }, { "name": "specRefFields", "type": "array", "info": "limit displayed reference fields.: array", "required": false, "schema": { "title": "specRefFields", "type": "array" } }, { "name": "specExtRefUuids", "type": "array", "info": "Filter by External Ref UUIDss.: array", "required": false, "schema": { "title": "specExtRefUuids", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/jobstoreServiceListTask" }, "task": true }, { "name": "jobstoreServiceRefUpdate", "summary": "Reference update", "description": "This API can be used to ADD/DELETE reference between two resources.", "input": [ { "name": "body", "type": "object", "info": ": {\"ref-type\": \"string\", \"ref-uuid\": \"string\", \"operation\": \"string\", \"type\": \"string\", \"uuid\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "ref-type": { "type": "string" }, "ref-uuid": { "type": "string" }, "operation": { "type": "string" }, "type": { "type": "string" }, "uuid": { "type": "string" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/jobstoreServiceRefUpdate" }, "task": true }, { "name": "jobstoreServiceExtRefUpdate", "summary": "External reference update", "description": "This API can be used to create/delete reference for ExtRef table.", "input": [ { "name": "body", "type": "object", "info": ": {\"ref-from-type\": \"string\", \"ref-from-uuid\": \"string\", \"operation\": \"string\", \"ref-to-uuid\": \"string\", \"ref-to-type\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "ref-from-type": { "type": "string" }, "ref-from-uuid": { "type": "string" }, "operation": { "type": "string" }, "ref-to-uuid": { "type": "string" }, "ref-to-type": { "type": "string" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/jobstoreServiceExtRefUpdate" }, "task": true }, { "name": "jobstoreServiceCreateJob", "summary": "Create job", "description": "Create job", "input": [ { "name": "body", "type": "object", "info": ": {\"job\": {\"parent_uuid\": \"string\", \"parent_type\": \"string\", \"callback_params\": \"string\", \"task_child_refs\": [{\"uuid\": \"string\"}], \"href\": \"string\", \"created_timestamp\": \"string\", \"updated_by\": \"string\", \"updated_timestamp\": \"string\", \"display_name\": \"string\", \"uuid\": \"string\", \"configuration_version\": \"string\", \"created_by\": \"string\", \"trigger\": \"string\", \"progress\": \"string\", \"type\": \"string\", \"annotations\": {\"key_value_pair\": [{\"value\": \"string\", \"key\": \"string\"}]}, \"resources\": \"array\", \"metadata\": [{\"value\": \"string\", \"key\": \"string\"}], \"status\": \"string\", \"description\": \"string\", \"start_time\": \"string\", \"perms2\": {\"owner\": \"string\", \"global_access\": \"string\", \"share\": [{\"access\": \"string\", \"scope\": \"string\", \"levels\": \"string\", \"scope_types\": \"array\"}]}, \"name\": \"string\", \"finish_time\": \"string\", \"status_message\": \"string\", \"schedule_time\": \"string\", \"meta\": {\"enable\": \"boolean\", \"user_visible\": \"boolean\"}, \"callback_url\": \"string\"}}", "required": true, "schema": { "type": "object", "properties": { "job": { "type": "object", "properties": { "parent_uuid": { "type": "string", "title": "UUID of the parent object" }, "parent_type": { "type": "string", "title": "Parent resource type" }, "callback_params": { "type": "string", "title": "Serailized Parameter to be passed to callback URL" }, "task_child_refs": { "items": { "type": "object", "properties": { "uuid": { "type": "string" } } }, "type": "array", "title": "Parent Job" }, "href": { "type": "string", "title": "Instance reference URL" }, "created_timestamp": { "type": "string", "title": "Created Timestamp for the object" }, "updated_by": { "type": "string", "title": "user who updated this object" }, "updated_timestamp": { "type": "string", "title": "Updated Timestamp for the object" }, "display_name": { "type": "string", "title": "Display name of this job" }, "uuid": { "type": "string", "title": "UUID of the object, system automatically allocates one if not provided" }, "configuration_version": { "type": "string", "description": "Configuration Version for the object." }, "created_by": { "type": "string", "title": "user who created this object" }, "trigger": { "type": "string", "title": "Trigger of this job e.g. request-id" }, "progress": { "type": "string", "description": "Progress in percentage." }, "type": { "type": "string", "title": "Type of the job" }, "annotations": { "type": "object", "properties": { "key_value_pair": { "items": { "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "type": "array" } } }, "resources": { "items": { "type": "string" }, "type": "array", "description": "Resources which are affected as part of this job. e.g list of devices." }, "metadata": { "items": { "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "type": "array", "title": "Metadata related to the job" }, "status": { "type": "string" }, "description": { "type": "string", "title": "Description of the object" }, "start_time": { "type": "string", "title": "Start time of this job" }, "perms2": { "type": "object", "properties": { "owner": { "type": "string", "title": "Owner project of the object" }, "global_access": { "type": "string", "title": "Share the object globally" }, "share": { "items": { "type": "object", "properties": { "access": { "type": "string", "title": "Allowed permissions in sharing" }, "scope": { "type": "string", "title": "ID of the scope to which the object is shared" }, "levels": { "type": "string", "title": "Number of level to which share should be applied" }, "scope_types": { "items": { "type": "string" }, "type": "array", "title": "Only apply share for specific types" } } }, "type": "array", "title": "Selectively shared object, List of (project, permissions)" } } }, "name": { "type": "string", "title": "Name of the object, defaults to 'default-<resource-type>'" }, "finish_time": { "type": "string", "title": "Finish time of this job" }, "status_message": { "type": "string", "title": "Detail status message" }, "schedule_time": { "type": "string", "title": "Scheduled start time of this job" }, "meta": { "type": "object", "properties": { "enable": { "type": "boolean", "title": "Administratively Enable/Disable this object" }, "user_visible": { "type": "boolean", "title": "System created internal objects will have this flag set and will not be visible" } } }, "callback_url": { "type": "string", "title": "Callback URL for scheduled job" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/jobstoreServiceCreateJob" }, "task": true }, { "name": "jobstoreServiceListJob", "summary": "List jobs", "description": "This API can be used to list job based on specification given in query parameters.", "input": [ { "name": "specSize", "type": "string", "info": "Number of items expected to be returned.: string", "required": false, "schema": { "title": "specSize", "type": "string" } }, { "name": "specPageMarker", "type": "string", "info": "Include only objects with UUID lexically greater than this.: string", "required": false, "schema": { "title": "specPageMarker", "type": "string" } }, { "name": "specDetail", "type": "boolean", "info": "Include detail informatoin or not.: boolean", "required": false, "schema": { "title": "specDetail", "type": "boolean" } }, { "name": "specCount", "type": "boolean", "info": ": boolean", "required": false, "schema": { "title": "specCount", "type": "boolean" } }, { "name": "specExcludeShared", "type": "boolean", "info": "Include shared resources or not.: boolean", "required": false, "schema": { "title": "specExcludeShared", "type": "boolean" } }, { "name": "specExcludeHrefs", "type": "boolean", "info": "Exclude href parameters.: boolean", "required": false, "schema": { "title": "specExcludeHrefs", "type": "boolean" } }, { "name": "specParentFqNameStr", "type": "array", "info": "Filter by parent FQ Name.: array", "required": false, "schema": { "title": "specParentFqNameStr", "type": "array" } }, { "name": "specParentType", "type": "string", "info": "Filter by parent type.: string", "required": false, "schema": { "title": "specParentType", "type": "string" } }, { "name": "specParentId", "type": "array", "info": "Filter by parent UUIDs.: array", "required": false, "schema": { "title": "specParentId", "type": "array" } }, { "name": "specBackRefId", "type": "array", "info": "Filter by backref UUIDss.: array", "required": false, "schema": { "title": "specBackRefId", "type": "array" } }, { "name": "specObjUuids", "type": "array", "info": "Filter by UUIDs.: array", "required": false, "schema": { "title": "specObjUuids", "type": "array" } }, { "name": "specFields", "type": "array", "info": "limit displayed fields.: array", "required": false, "schema": { "title": "specFields", "type": "array" } }, { "name": "specFilters", "type": "array", "info": "QueryFilter in string format.\nGrpc-gateway doesn't have support for nested structs and maps so\nintroducing new fields which will take string as input.: array", "required": false, "schema": { "title": "specFilters", "type": "array" } }, { "name": "specRefUuids", "type": "array", "info": "Filter by ref UUIDss.: array", "required": false, "schema": { "title": "specRefUuids", "type": "array" } }, { "name": "specFrom", "type": "string", "info": "Start from items expected to be returned.: string", "required": false, "schema": { "title": "specFrom", "type": "string" } }, { "name": "specSortby", "type": "string", "info": "Sort by column with ascending or descending by default ascending.: string", "required": false, "schema": { "title": "specSortby", "type": "string" } }, { "name": "specOperation", "type": "string", "info": "Operation determines whether union or interjection.: Must be one of [AND, OR]", "required": false, "schema": { "title": "specOperation", "type": "string" } }, { "name": "specTagFilters", "type": "array", "info": "Filter by Tag Fields.: array", "required": false, "schema": { "title": "specTagFilters", "type": "array" } }, { "name": "specTagDetail", "type": "boolean", "info": "Include Tag Details or not.: boolean", "required": false, "schema": { "title": "specTagDetail", "type": "boolean" } }, { "name": "specRefFields", "type": "array", "info": "limit displayed reference fields.: array", "required": false, "schema": { "title": "specRefFields", "type": "array" } }, { "name": "specExtRefUuids", "type": "array", "info": "Filter by External Ref UUIDss.: array", "required": false, "schema": { "title": "specExtRefUuids", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/jobstoreServiceListJob" }, "task": true }, { "name": "jobstoreServiceUpdateJobPurgePolicy", "summary": "Update job-purge-policy by ID", "description": "Update job-purge-policy by ID", "input": [ { "name": "iD", "type": "string", "info": ": string", "required": true, "schema": { "title": "iD", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"ignore_optimistic_lock\": \"boolean\", \"ID\": \"string\", \"job-purge-policy\": {\"updated_timestamp\": \"string\", \"parent_uuid\": \"string\", \"description\": \"string\", \"configuration_version\": \"string\", \"tenant_id\": \"string\", \"parent_type\": \"string\", \"perms2\": {\"owner\": \"string\", \"global_access\": \"string\", \"share\": [{\"access\": \"string\", \"scope\": \"string\", \"levels\": \"string\", \"scope_types\": \"array\"}]}, \"name\": \"string\", \"retention_period\": \"string\", \"href\": \"string\", \"meta\": {\"enable\": \"boolean\", \"user_visible\": \"boolean\"}, \"created_by\": \"string\", \"updated_by\": \"string\", \"created_timestamp\": \"string\", \"annotations\": {\"key_value_pair\": [{\"value\": \"string\", \"key\": \"string\"}]}, \"uuid\": \"string\"}, \"fieldMask\": {\"paths\": \"array\"}}", "required": true, "schema": { "type": "object", "properties": { "ignore_optimistic_lock": { "type": "boolean" }, "ID": { "type": "string" }, "job-purge-policy": { "type": "object", "properties": { "updated_timestamp": { "type": "string", "title": "Updated Timestamp for the object" }, "parent_uuid": { "type": "string", "title": "UUID of the parent object" }, "description": { "type": "string", "title": "Description of the object" }, "configuration_version": { "type": "string", "description": "Configuration Version for the object." }, "tenant_id": { "type": "string", "title": "tenant identifier" }, "parent_type": { "type": "string", "title": "Parent resource type" }, "perms2": { "type": "object", "properties": { "owner": { "type": "string", "title": "Owner project of the object" }, "global_access": { "type": "string", "title": "Share the object globally" }, "share": { "items": { "type": "object", "properties": { "access": { "type": "string", "title": "Allowed permissions in sharing" }, "scope": { "type": "string", "title": "ID of the scope to which the object is shared" }, "levels": { "type": "string", "title": "Number of level to which share should be applied" }, "scope_types": { "items": { "type": "string" }, "type": "array", "title": "Only apply share for specific types" } } }, "type": "array", "title": "Selectively shared object, List of (project, permissions)" } } }, "name": { "type": "string", "title": "Name of the object, defaults to 'default-<resource-type>'" }, "retention_period": { "type": "string", "title": "retention period in days" }, "href": { "type": "string", "title": "Instance reference URL" }, "meta": { "type": "object", "properties": { "enable": { "type": "boolean", "title": "Administratively Enable/Disable this object" }, "user_visible": { "type": "boolean", "title": "System created internal objects will have this flag set and will not be visible" } } }, "created_by": { "type": "string", "title": "user who created this object" }, "updated_by": { "type": "string", "title": "user who updated this object" }, "created_timestamp": { "type": "string", "title": "Created Timestamp for the object" }, "annotations": { "type": "object", "properties": { "key_value_pair": { "items": { "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "type": "array" } } }, "uuid": { "type": "string", "title": "UUID of the object, system automatically allocates one if not provided" } } }, "fieldMask": { "description": "paths: \"f.a\"\n paths: \"f.b.d\"\n\nHere `f` represents a field in some root message, `a` and `b`\nfields in the message found in `f`, and `d` a field found in the\nmessage in `f.b`.\n\nField masks are used to specify a subset of fields that should be\nreturned by a get operation or modified by an update operation.\nField masks also have a custom JSON encoding (see below).\n\n# Field Masks in Projections\n\nWhen used in the context of a projection, a response message or\nsub-message is filtered by the API to only contain those fields as\nspecified in the mask. For example, if the mask in the previous\nexample is applied to a response message as follows:\n\n f {\n a : 22\n b {\n d : 1\n x : 2\n }\n y : 13\n }\n z: 8\n\nThe result will not contain specific values for fields x,y and z\n(their value will be set to the default, and omitted in proto text\noutput):\n\n\n f {\n a : 22\n b {\n d : 1\n }\n }\n\nA repeated field is not allowed except at the last position of a\npaths string.\n\nIf a FieldMask object is not present in a get operation, the\noperation applies to all fields (as if a FieldMask of all fields\nhad been specified).\n\nNote that a field mask does not necessarily apply to the\ntop-level response message. In case of a REST get operation, the\nfield mask applies directly to the response, but in case of a REST\nlist operation, the mask instead applies to each individual message\nin the returned resource list. In case of a REST custom method,\nother definitions may be used. Where the mask applies will be\nclearly documented together with its declaration in the API. In\nany case, the effect on the returned resource/resources is required\nbehavior for APIs.\n\n# Field Masks in Update Operations\n\nA field mask in update operations specifies which fields of the\ntargeted resource are going to be updated. The API is required\nto only change the values of the fields as specified in the mask\nand leave the others untouched. If a resource is passed in to\ndescribe the updated values, the API ignores the values of all\nfields not covered by the mask.\n\nIf a repeated field is specified for an update operation, new values will\nbe appended to the existing repeated field in the target resource. Note that\na repeated field is only allowed in the last position of a `paths` string.\n\nIf a sub-message is specified in the last position of the field mask for an\nupdate operation, then new value will be merged into the existing sub-message\nin the target resource.\n\nFor example, given the target message:\n\n f {\n b {\n d: 1\n x: 2\n }\n c: [1]\n }\n\nAnd an update message:\n\n f {\n b {\n d: 10\n }\n c: [2]\n }\n\nthen if the field mask is:\n\n paths: [\"f.b\", \"f.c\"]\n\nthen the result will be:\n\n f {\n b {\n d: 10\n x: 2\n }\n c: [1, 2]\n }\n\nAn implementation may provide options to override this default behavior for\nrepeated and message fields.\n\nIn order to reset a field's value to the default, the field must\nbe in the mask and set to the default value in the provided resource.\nHence, in order to reset all fields of a resource, provide a default\ninstance of the resource and set all fields in the mask, or do\nnot provide a mask as described below.\n\nIf a field mask is not present on update, the operation applies to\nall fields (as if a field mask of all fields has been specified).\nNote that in the presence of schema evolution, this may mean that\nfields the client does not know and has therefore not filled into\nthe request will be reset to their default. If this is unwanted\nbehavior, a specific service may require a client to always specify\na field mask, producing an error if not.\n\nAs with get operations, the location of the resource which\ndescribes the updated values in the request message depends on the\noperation kind. In any case, the effect of the field mask is\nrequired to be honored by the API.\n\n## Considerations for HTTP REST\n\nThe HTTP kind of an update operation which uses a field mask must\nbe set to PATCH instead of PUT in order to satisfy HTTP semantics\n(PUT must only be used for full updates).\n\n# JSON Encoding of Field Masks\n\nIn JSON, a field mask is encoded as a single string where paths are\nseparated by a comma. Fields name in each path are converted\nto/from lower-camel naming conventions.\n\nAs an example, consider the following message declarations:\n\n message Profile {\n User user = 1;\n Photo photo = 2;\n }\n message User {\n string display_name = 1;\n string address = 2;\n }\n\nIn proto a field mask for `Profile` may look as such:\n\n mask {\n paths: \"user.display_name\"\n paths: \"photo\"\n }\n\nIn JSON, the same mask is represented as below:\n\n {\n mask: \"user.displayName,photo\"\n }\n\n# Field Masks and Oneof Fields\n\nField masks treat fields in oneofs just as regular fields. Consider the\nfollowing message:\n\n message SampleMessage {\n oneof test_oneof {\n string name = 4;\n SubMessage sub_message = 9;\n }\n }\n\nThe field mask can be:\n\n mask {\n paths: \"name\"\n }\n\nOr:\n\n mask {\n paths: \"sub_message\"\n }\n\nNote that oneof type names (\"test_oneof\" in this case) cannot be used in\npaths.\n\n## Field Mask Verification\n\nThe implementation of any API method which has a FieldMask type field in the\nrequest should verify the included field paths, and return an\n`INVALID_ARGUMENT` error if any path is unmappable.", "type": "object", "properties": { "paths": { "items": { "type": "string" }, "type": "array", "description": "The set of field mask paths." } }, "title": "`FieldMask` represents a set of symbolic field paths, for example:" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/jobstoreServiceUpdateJobPurgePolicy" }, "task": true }, { "name": "jobstoreServiceGetJobPurgePolicy", "summary": "Get job-purge-policy by ID", "description": "Get job-purge-policy by ID", "input": [ { "name": "iD", "type": "string", "info": ": string", "required": true, "schema": { "title": "iD", "type": "string" } }, { "name": "detail", "type": "boolean", "info": "if detail is set then reference uuids & child uuids will be returned in the response.: boolean", "required": false, "schema": { "title": "detail", "type": "boolean" } }, { "name": "fields", "type": "array", "info": "limit displayed fields.: array", "required": false, "schema": { "title": "fields", "type": "array" } }, { "name": "refFields", "type": "array", "info": "limit displayed reference fields.: array", "required": false, "schema": { "title": "refFields", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/jobstoreServiceGetJobPurgePolicy" }, "task": true }, { "name": "jobstoreServiceDeleteJobPurgePolicy", "summary": "Delete job-purge-policy by ID", "description": "Delete job-purge-policy by ID", "input": [ { "name": "iD", "type": "string", "info": ": string", "required": true, "schema": { "title": "iD", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/jobstoreServiceDeleteJobPurgePolicy" }, "task": true }, { "name": "jobstoreServiceCreateDeletedResource", "summary": "Create deleted-resource", "description": "Create deleted-resource", "input": [ { "name": "body", "type": "object", "info": ": {\"deleted-resource\": {\"updated_timestamp\": \"string\", \"parent_uuid\": \"string\", \"description\": \"string\", \"configuration_version\": \"string\", \"parent_type\": \"string\", \"perms2\": {\"owner\": \"string\", \"global_access\": \"string\", \"share\": [{\"access\": \"string\", \"scope\": \"string\", \"levels\": \"string\", \"scope_types\": \"array\"}]}, \"name\": \"string\", \"href\": \"string\", \"meta\": {\"enable\": \"boolean\", \"user_visible\": \"boolean\"}, \"created_by\": \"string\", \"updated_by\": \"string\", \"created_timestamp\": \"string\", \"data\": \"string\", \"annotations\": {\"key_value_pair\": [{\"value\": \"string\", \"key\": \"string\"}]}, \"resource_type\": \"string\", \"uuid\": \"string\"}}", "required": true, "schema": { "type": "object", "properties": { "deleted-resource": { "type": "object", "properties": { "updated_timestamp": { "type": "string", "title": "Updated Timestamp for the object" }, "parent_uuid": { "type": "string", "title": "UUID of the parent object" }, "description": { "type": "string", "title": "Description of the object" }, "configuration_version": { "type": "string", "description": "Configuration Version for the object." }, "parent_type": { "type": "string", "title": "Parent resource type" }, "perms2": { "type": "object", "properties": { "owner": { "type": "string", "title": "Owner project of the object" }, "global_access": { "type": "string", "title": "Share the object globally" }, "share": { "items": { "type": "object", "properties": { "access": { "type": "string", "title": "Allowed permissions in sharing" }, "scope": { "type": "string", "title": "ID of the scope to which the object is shared" }, "levels": { "type": "string", "title": "Number of level to which share should be applied" }, "scope_types": { "items": { "type": "string" }, "type": "array", "title": "Only apply share for specific types" } } }, "type": "array", "title": "Selectively shared object, List of (project, permissions)" } } }, "name": { "type": "string", "title": "Name of the object, defaults to 'default-<resource-type>'" }, "href": { "type": "string", "title": "Instance reference URL" }, "meta": { "type": "object", "properties": { "enable": { "type": "boolean", "title": "Administratively Enable/Disable this object" }, "user_visible": { "type": "boolean", "title": "System created internal objects will have this flag set and will not be visible" } } }, "created_by": { "type": "string", "title": "user who created this object" }, "updated_by": { "type": "string", "title": "user who updated this object" }, "created_timestamp": { "type": "string", "title": "Created Timestamp for the object" }, "data": { "type": "string", "description": "data of the resource." }, "annotations": { "type": "object", "properties": { "key_value_pair": { "items": { "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "type": "array" } } }, "resource_type": { "type": "string", "description": "Type of the resource." }, "uuid": { "type": "string", "title": "UUID of the object, system automatically allocates one if not provided" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/jobstoreServiceCreateDeletedResource" }, "task": true }, { "name": "jobstoreServiceListDeletedResource", "summary": "List deleted-resources", "description": "This API can be used to list deleted-resource based on specification given in query parameters.", "input": [ { "name": "specSize", "type": "string", "info": "Number of items expected to be returned.: string", "required": false, "schema": { "title": "specSize", "type": "string" } }, { "name": "specPageMarker", "type": "string", "info": "Include only objects with UUID lexically greater than this.: string", "required": false, "schema": { "title": "specPageMarker", "type": "string" } }, { "name": "specDetail", "type": "boolean", "info": "Include detail informatoin or not.: boolean", "required": false, "schema": { "title": "specDetail", "type": "boolean" } }, { "name": "specCount", "type": "boolean", "info": ": boolean", "required": false, "schema": { "title": "specCount", "type": "boolean" } }, { "name": "specExcludeShared", "type": "boolean", "info": "Include shared resources or not.: boolean", "required": false, "schema": { "title": "specExcludeShared", "type": "boolean" } }, { "name": "specExcludeHrefs", "type": "boolean", "info": "Exclude href parameters.: boolean", "required": false, "schema": { "title": "specExcludeHrefs", "type": "boolean" } }, { "name": "specParentFqNameStr", "type": "array", "info": "Filter by parent FQ Name.: array", "required": false, "schema": { "title": "specParentFqNameStr", "type": "array" } }, { "name": "specParentType", "type": "string", "info": "Filter by parent type.: string", "required": false, "schema": { "title": "specParentType", "type": "string" } }, { "name": "specParentId", "type": "array", "info": "Filter by parent UUIDs.: array", "required": false, "schema": { "title": "specParentId", "type": "array" } }, { "name": "specBackRefId", "type": "array", "info": "Filter by backref UUIDss.: array", "required": false, "schema": { "title": "specBackRefId", "type": "array" } }, { "name": "specObjUuids", "type": "array", "info": "Filter by UUIDs.: array", "required": false, "schema": { "title": "specObjUuids", "type": "array" } }, { "name": "specFields", "type": "array", "info": "limit displayed fields.: array", "required": false, "schema": { "title": "specFields", "type": "array" } }, { "name": "specFilters", "type": "array", "info": "QueryFilter in string format.\nGrpc-gateway doesn't have support for nested structs and maps so\nintroducing new fields which will take string as input.: array", "required": false, "schema": { "title": "specFilters", "type": "array" } }, { "name": "specRefUuids", "type": "array", "info": "Filter by ref UUIDss.: array", "required": false, "schema": { "title": "specRefUuids", "type": "array" } }, { "name": "specFrom", "type": "string", "info": "Start from items expected to be returned.: string", "required": false, "schema": { "title": "specFrom", "type": "string" } }, { "name": "specSortby", "type": "string", "info": "Sort by column with ascending or descending by default ascending.: string", "required": false, "schema": { "title": "specSortby", "type": "string" } }, { "name": "specOperation", "type": "string", "info": "Operation determines whether union or interjection.: Must be one of [AND, OR]", "required": false, "schema": { "title": "specOperation", "type": "string" } }, { "name": "specTagFilters", "type": "array", "info": "Filter by Tag Fields.: array", "required": false, "schema": { "title": "specTagFilters", "type": "array" } }, { "name": "specTagDetail", "type": "boolean", "info": "Include Tag Details or not.: boolean", "required": false, "schema": { "title": "specTagDetail", "type": "boolean" } }, { "name": "specRefFields", "type": "array", "info": "limit displayed reference fields.: array", "required": false, "schema": { "title": "specRefFields", "type": "array" } }, { "name": "specExtRefUuids", "type": "array", "info": "Filter by External Ref UUIDss.: array", "required": false, "schema": { "title": "specExtRefUuids", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/jobstoreServiceListDeletedResource" }, "task": true }, { "name": "jobstoreServiceBulkListDeletedResource", "summary": "Bulk list deleted-resources", "description": "This API can be used to list deleted-resource based on specification given in request body.", "input": [ { "name": "body", "type": "object", "info": ": {\"spec\": {\"ref_fields\": \"array\", \"parent_type\": \"string\", \"filters\": \"array\", \"operation\": \"Must be one of [AND, OR]\", \"json_filters\": [{\"values\": \"array\", \"key\": \"string\"}], \"size\": \"string\", \"from\": \"string\", \"page_marker\": \"string\", \"obj_uuids\": \"array\", \"ref_uuids_map\": \"object\", \"detail\": \"boolean\", \"parent_id\": \"array\", \"ext_ref_uuids\": \"array\", \"back_ref_id\": \"array\", \"exclude_shared\": \"boolean\", \"exclude_hrefs\": \"boolean\", \"tag_detail\": \"boolean\", \"count\": \"boolean\", \"fields\": \"array\", \"parent_fq_name_str\": \"array\", \"ref_uuids\": \"array\", \"sortby\": \"string\", \"tag_filters\": \"array\"}}", "required": true, "schema": { "type": "object", "properties": { "spec": { "type": "object", "properties": { "ref_fields": { "items": { "type": "string" }, "type": "array", "title": "limit displayed reference fields" }, "parent_type": { "type": "string", "title": "Filter by parent type" }, "filters": { "items": { "type": "string" }, "type": "array", "title": "QueryFilter in string format.\nGrpc-gateway doesn't have support for nested structs and maps so\nintroducing new fields which will take string as input" }, "operation": { "default": "AND", "enum": [ "AND", "OR" ], "type": "string" }, "json_filters": { "items": { "type": "object", "properties": { "values": { "items": { "type": "string" }, "type": "array", "title": "Filter values" }, "key": { "type": "string", "title": "Filter key" } } }, "type": "array", "title": "QueryFilter in JSON Format" }, "size": { "type": "string", "title": "Number of items expected to be returned" }, "from": { "type": "string", "title": "Start from items expected to be returned" }, "page_marker": { "type": "string", "description": "Include only objects with UUID lexically greater than this." }, "obj_uuids": { "items": { "type": "string" }, "type": "array", "title": "Filter by UUIDs" }, "ref_uuids_map": { "additionalProperties": { "type": "object", "properties": { "uuids": { "items": { "type": "string" }, "type": "array", "title": "UUIDs for refs and backrefs" } } }, "type": "object", "title": "Filter by ref UUIDss" }, "detail": { "type": "boolean", "title": "Include detail informatoin or not" }, "parent_id": { "items": { "type": "string" }, "type": "array", "title": "Filter by parent UUIDs" }, "ext_ref_uuids": { "items": { "type": "string" }, "type": "array", "title": "Filter by External Ref UUIDss" }, "back_ref_id": { "items": { "type": "string" }, "type": "array", "title": "Filter by backref UUIDss" }, "exclude_shared": { "type": "boolean", "title": "Include shared resources or not" }, "exclude_hrefs": { "type": "boolean", "title": "Exclude href parameters" }, "tag_detail": { "type": "boolean", "title": "Include Tag Details or not" }, "count": { "type": "boolean" }, "fields": { "items": { "type": "string" }, "type": "array", "title": "limit displayed fields" }, "parent_fq_name_str": { "items": { "type": "string" }, "type": "array", "title": "Filter by parent FQ Name" }, "ref_uuids": { "items": { "type": "string" }, "type": "array", "title": "Filter by ref UUIDss" }, "sortby": { "type": "string", "title": "Sort by column with ascending or descending by default ascending" }, "tag_filters": { "items": { "type": "string" }, "type": "array", "title": "Filter by Tag Fields" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/jobstoreServiceBulkListDeletedResource" }, "task": true }, { "name": "jobstoreServiceUpdateDeletedResource", "summary": "Update deleted-resource by ID", "description": "Update deleted-resource by ID", "input": [ { "name": "iD", "type": "string", "info": ": string", "required": true, "schema": { "title": "iD", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"ignore_optimistic_lock\": \"boolean\", \"deleted-resource\": {\"updated_timestamp\": \"string\", \"parent_uuid\": \"string\", \"description\": \"string\", \"configuration_version\": \"string\", \"parent_type\": \"string\", \"perms2\": {\"owner\": \"string\", \"global_access\": \"string\", \"share\": [{\"access\": \"string\", \"scope\": \"string\", \"levels\": \"string\", \"scope_types\": \"array\"}]}, \"name\": \"string\", \"href\": \"string\", \"meta\": {\"enable\": \"boolean\", \"user_visible\": \"boolean\"}, \"created_by\": \"string\", \"updated_by\": \"string\", \"created_timestamp\": \"string\", \"data\": \"string\", \"annotations\": {\"key_value_pair\": [{\"value\": \"string\", \"key\": \"string\"}]}, \"resource_type\": \"string\", \"uuid\": \"string\"}, \"ID\": \"string\", \"fieldMask\": {\"paths\": \"array\"}}", "required": true, "schema": { "type": "object", "properties": { "ignore_optimistic_lock": { "type": "boolean" }, "deleted-resource": { "type": "object", "properties": { "updated_timestamp": { "type": "string", "title": "Updated Timestamp for the object" }, "parent_uuid": { "type": "string", "title": "UUID of the parent object" }, "description": { "type": "string", "title": "Description of the object" }, "configuration_version": { "type": "string", "description": "Configuration Version for the object." }, "parent_type": { "type": "string", "title": "Parent resource type" }, "perms2": { "type": "object", "properties": { "owner": { "type": "string", "title": "Owner project of the object" }, "global_access": { "type": "string", "title": "Share the object globally" }, "share": { "items": { "type": "object", "properties": { "access": { "type": "string", "title": "Allowed permissions in sharing" }, "scope": { "type": "string", "title": "ID of the scope to which the object is shared" }, "levels": { "type": "string", "title": "Number of level to which share should be applied" }, "scope_types": { "items": { "type": "string" }, "type": "array", "title": "Only apply share for specific types" } } }, "type": "array", "title": "Selectively shared object, List of (project, permissions)" } } }, "name": { "type": "string", "title": "Name of the object, defaults to 'default-<resource-type>'" }, "href": { "type": "string", "title": "Instance reference URL" }, "meta": { "type": "object", "properties": { "enable": { "type": "boolean", "title": "Administratively Enable/Disable this object" }, "user_visible": { "type": "boolean", "title": "System created internal objects will have this flag set and will not be visible" } } }, "created_by": { "type": "string", "title": "user who created this object" }, "updated_by": { "type": "string", "title": "user who updated this object" }, "created_timestamp": { "type": "string", "title": "Created Timestamp for the object" }, "data": { "type": "string", "description": "data of the resource." }, "annotations": { "type": "object", "properties": { "key_value_pair": { "items": { "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "type": "array" } } }, "resource_type": { "type": "string", "description": "Type of the resource." }, "uuid": { "type": "string", "title": "UUID of the object, system automatically allocates one if not provided" } } }, "ID": { "type": "string" }, "fieldMask": { "description": "paths: \"f.a\"\n paths: \"f.b.d\"\n\nHere `f` represents a field in some root message, `a` and `b`\nfields in the message found in `f`, and `d` a field found in the\nmessage in `f.b`.\n\nField masks are used to specify a subset of fields that should be\nreturned by a get operation or modified by an update operation.\nField masks also have a custom JSON encoding (see below).\n\n# Field Masks in Projections\n\nWhen used in the context of a projection, a response message or\nsub-message is filtered by the API to only contain those fields as\nspecified in the mask. For example, if the mask in the previous\nexample is applied to a response message as follows:\n\n f {\n a : 22\n b {\n d : 1\n x : 2\n }\n y : 13\n }\n z: 8\n\nThe result will not contain specific values for fields x,y and z\n(their value will be set to the default, and omitted in proto text\noutput):\n\n\n f {\n a : 22\n b {\n d : 1\n }\n }\n\nA repeated field is not allowed except at the last position of a\npaths string.\n\nIf a FieldMask object is not present in a get operation, the\noperation applies to all fields (as if a FieldMask of all fields\nhad been specified).\n\nNote that a field mask does not necessarily apply to the\ntop-level response message. In case of a REST get operation, the\nfield mask applies directly to the response, but in case of a REST\nlist operation, the mask instead applies to each individual message\nin the returned resource list. In case of a REST custom method,\nother definitions may be used. Where the mask applies will be\nclearly documented together with its declaration in the API. In\nany case, the effect on the returned resource/resources is required\nbehavior for APIs.\n\n# Field Masks in Update Operations\n\nA field mask in update operations specifies which fields of the\ntargeted resource are going to be updated. The API is required\nto only change the values of the fields as specified in the mask\nand leave the others untouched. If a resource is passed in to\ndescribe the updated values, the API ignores the values of all\nfields not covered by the mask.\n\nIf a repeated field is specified for an update operation, new values will\nbe appended to the existing repeated field in the target resource. Note that\na repeated field is only allowed in the last position of a `paths` string.\n\nIf a sub-message is specified in the last position of the field mask for an\nupdate operation, then new value will be merged into the existing sub-message\nin the target resource.\n\nFor example, given the target message:\n\n f {\n b {\n d: 1\n x: 2\n }\n c: [1]\n }\n\nAnd an update message:\n\n f {\n b {\n d: 10\n }\n c: [2]\n }\n\nthen if the field mask is:\n\n paths: [\"f.b\", \"f.c\"]\n\nthen the result will be:\n\n f {\n b {\n d: 10\n x: 2\n }\n c: [1, 2]\n }\n\nAn implementation may provide options to override this default behavior for\nrepeated and message fields.\n\nIn order to reset a field's value to the default, the field must\nbe in the mask and set to the default value in the provided resource.\nHence, in order to reset all fields of a resource, provide a default\ninstance of the resource and set all fields in the mask, or do\nnot provide a mask as described below.\n\nIf a field mask is not present on update, the operation applies to\nall fields (as if a field mask of all fields has been specified).\nNote that in the presence of schema evolution, this may mean that\nfields the client does not know and has therefore not filled into\nthe request will be reset to their default. If this is unwanted\nbehavior, a specific service may require a client to always specify\na field mask, producing an error if not.\n\nAs with get operations, the location of the resource which\ndescribes the updated values in the request message depends on the\noperation kind. In any case, the effect of the field mask is\nrequired to be honored by the API.\n\n## Considerations for HTTP REST\n\nThe HTTP kind of an update operation which uses a field mask must\nbe set to PATCH instead of PUT in order to satisfy HTTP semantics\n(PUT must only be used for full updates).\n\n# JSON Encoding of Field Masks\n\nIn JSON, a field mask is encoded as a single string where paths are\nseparated by a comma. Fields name in each path are converted\nto/from lower-camel naming conventions.\n\nAs an example, consider the following message declarations:\n\n message Profile {\n User user = 1;\n Photo photo = 2;\n }\n message User {\n string display_name = 1;\n string address = 2;\n }\n\nIn proto a field mask for `Profile` may look as such:\n\n mask {\n paths: \"user.display_name\"\n paths: \"photo\"\n }\n\nIn JSON, the same mask is represented as below:\n\n {\n mask: \"user.displayName,photo\"\n }\n\n# Field Masks and Oneof Fields\n\nField masks treat fields in oneofs just as regular fields. Consider the\nfollowing message:\n\n message SampleMessage {\n oneof test_oneof {\n string name = 4;\n SubMessage sub_message = 9;\n }\n }\n\nThe field mask can be:\n\n mask {\n paths: \"name\"\n }\n\nOr:\n\n mask {\n paths: \"sub_message\"\n }\n\nNote that oneof type names (\"test_oneof\" in this case) cannot be used in\npaths.\n\n## Field Mask Verification\n\nThe implementation of any API method which has a FieldMask type field in the\nrequest should verify the included field paths, and return an\n`INVALID_ARGUMENT` error if any path is unmappable.", "type": "object", "properties": { "paths": { "items": { "type": "string" }, "type": "array", "description": "The set of field mask paths." } }, "title": "`FieldMask` represents a set of symbolic field paths, for example:" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/jobstoreServiceUpdateDeletedResource" }, "task": true }, { "name": "jobstoreServiceGetDeletedResource", "summary": "Get deleted-resource by ID", "description": "Get deleted-resource by ID", "input": [ { "name": "iD", "type": "string", "info": ": string", "required": true, "schema": { "title": "iD", "type": "string" } }, { "name": "detail", "type": "boolean", "info": "if detail is set then reference uuids & child uuids will be returned in the response.: boolean", "required": false, "schema": { "title": "detail", "type": "boolean" } }, { "name": "fields", "type": "array", "info": "limit displayed fields.: array", "required": false, "schema": { "title": "fields", "type": "array" } }, { "name": "refFields", "type": "array", "info": "limit displayed reference fields.: array", "required": false, "schema": { "title": "refFields", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/jobstoreServiceGetDeletedResource" }, "task": true }, { "name": "jobstoreServiceDeleteDeletedResource", "summary": "Delete deleted-resource by ID", "description": "Delete deleted-resource by ID", "input": [ { "name": "iD", "type": "string", "info": ": string", "required": true, "schema": { "title": "iD", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/jobstoreServiceDeleteDeletedResource" }, "task": true }, { "name": "jobstoreServiceBulkListLastPublishedNotification", "summary": "Bulk list last-published-notifications", "description": "This API can be used to list last-published-notification based on specification given in request body.", "input": [ { "name": "body", "type": "object", "info": ": {\"spec\": {\"ref_fields\": \"array\", \"parent_type\": \"string\", \"filters\": \"array\", \"operation\": \"Must be one of [AND, OR]\", \"json_filters\": [{\"values\": \"array\", \"key\": \"string\"}], \"size\": \"string\", \"from\": \"string\", \"page_marker\": \"string\", \"obj_uuids\": \"array\", \"ref_uuids_map\": \"object\", \"detail\": \"boolean\", \"parent_id\": \"array\", \"ext_ref_uuids\": \"array\", \"back_ref_id\": \"array\", \"exclude_shared\": \"boolean\", \"exclude_hrefs\": \"boolean\", \"tag_detail\": \"boolean\", \"count\": \"boolean\", \"fields\": \"array\", \"parent_fq_name_str\": \"array\", \"ref_uuids\": \"array\", \"sortby\": \"string\", \"tag_filters\": \"array\"}}", "required": true, "schema": { "type": "object", "properties": { "spec": { "type": "object", "properties": { "ref_fields": { "items": { "type": "string" }, "type": "array", "title": "limit displayed reference fields" }, "parent_type": { "type": "string", "title": "Filter by parent type" }, "filters": { "items": { "type": "string" }, "type": "array", "title": "QueryFilter in string format.\nGrpc-gateway doesn't have support for nested structs and maps so\nintroducing new fields which will take string as input" }, "operation": { "default": "AND", "enum": [ "AND", "OR" ], "type": "string" }, "json_filters": { "items": { "type": "object", "properties": { "values": { "items": { "type": "string" }, "type": "array", "title": "Filter values" }, "key": { "type": "string", "title": "Filter key" } } }, "type": "array", "title": "QueryFilter in JSON Format" }, "size": { "type": "string", "title": "Number of items expected to be returned" }, "from": { "type": "string", "title": "Start from items expected to be returned" }, "page_marker": { "type": "string", "description": "Include only objects with UUID lexically greater than this." }, "obj_uuids": { "items": { "type": "string" }, "type": "array", "title": "Filter by UUIDs" }, "ref_uuids_map": { "additionalProperties": { "type": "object", "properties": { "uuids": { "items": { "type": "string" }, "type": "array", "title": "UUIDs for refs and backrefs" } } }, "type": "object", "title": "Filter by ref UUIDss" }, "detail": { "type": "boolean", "title": "Include detail informatoin or not" }, "parent_id": { "items": { "type": "string" }, "type": "array", "title": "Filter by parent UUIDs" }, "ext_ref_uuids": { "items": { "type": "string" }, "type": "array", "title": "Filter by External Ref UUIDss" }, "back_ref_id": { "items": { "type": "string" }, "type": "array", "title": "Filter by backref UUIDss" }, "exclude_shared": { "type": "boolean", "title": "Include shared resources or not" }, "exclude_hrefs": { "type": "boolean", "title": "Exclude href parameters" }, "tag_detail": { "type": "boolean", "title": "Include Tag Details or not" }, "count": { "type": "boolean" }, "fields": { "items": { "type": "string" }, "type": "array", "title": "limit displayed fields" }, "parent_fq_name_str": { "items": { "type": "string" }, "type": "array", "title": "Filter by parent FQ Name" }, "ref_uuids": { "items": { "type": "string" }, "type": "array", "title": "Filter by ref UUIDss" }, "sortby": { "type": "string", "title": "Sort by column with ascending or descending by default ascending" }, "tag_filters": { "items": { "type": "string" }, "type": "array", "title": "Filter by Tag Fields" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/jobstoreServiceBulkListLastPublishedNotification" }, "task": true }, { "name": "jobstoreServiceUpdateTask", "summary": "Update task by ID", "description": "Update task by ID", "input": [ { "name": "iD", "type": "string", "info": ": string", "required": true, "schema": { "title": "iD", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"ignore_optimistic_lock\": \"boolean\", \"task\": {\"parent_uuid\": \"string\", \"parent_type\": \"string\", \"href\": \"string\", \"parent_task\": \"string\", \"created_timestamp\": \"string\", \"updated_by\": \"string\", \"updated_timestamp\": \"string\", \"task_type\": \"string\", \"display_name\": \"string\", \"uuid\": \"string\", \"configuration_version\": \"string\", \"created_by\": \"string\", \"progress\": \"string\", \"status_message\": \"string\", \"annotations\": {\"key_value_pair\": [{\"value\": \"string\", \"key\": \"string\"}]}, \"resources\": \"array\", \"status\": \"string\", \"description\": \"string\", \"start_time\": \"string\", \"perms2\": {\"owner\": \"string\", \"global_access\": \"string\", \"share\": [{\"access\": \"string\", \"scope\": \"string\", \"levels\": \"string\", \"scope_types\": \"array\"}]}, \"name\": \"string\", \"finish_time\": \"string\", \"meta\": {\"enable\": \"boolean\", \"user_visible\": \"boolean\"}}, \"ID\": \"string\", \"fieldMask\": {\"paths\": \"array\"}}", "required": true, "schema": { "type": "object", "properties": { "ignore_optimistic_lock": { "type": "boolean" }, "task": { "type": "object", "properties": { "parent_uuid": { "type": "string", "title": "UUID of the parent object" }, "parent_type": { "type": "string", "title": "Parent resource type" }, "href": { "type": "string", "title": "Instance reference URL" }, "parent_task": { "type": "string", "title": "Parent Task" }, "created_timestamp": { "type": "string", "title": "Created Timestamp for the object" }, "updated_by": { "type": "string", "title": "user who updated this object" }, "updated_timestamp": { "type": "string", "title": "Updated Timestamp for the object" }, "task_type": { "type": "string" }, "display_name": { "type": "string", "title": "Display name of this task" }, "uuid": { "type": "string", "title": "UUID of the object, system automatically allocates one if not provided" }, "configuration_version": { "type": "string", "description": "Configuration Version for the object." }, "created_by": { "type": "string", "title": "user who created this object" }, "progress": { "type": "string", "description": "Progress in percentage." }, "status_message": { "type": "string", "title": "Detail status message" }, "annotations": { "type": "object", "properties": { "key_value_pair": { "items": { "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "type": "array" } } }, "resources": { "items": { "type": "string" }, "type": "array", "description": "Resources which are affected as part of this job. e.g list of devices." }, "status": { "type": "string" }, "description": { "type": "string", "title": "Description of the object" }, "start_time": { "type": "string", "title": "Start time of this job" }, "perms2": { "type": "object", "properties": { "owner": { "type": "string", "title": "Owner project of the object" }, "global_access": { "type": "string", "title": "Share the object globally" }, "share": { "items": { "type": "object", "properties": { "access": { "type": "string", "title": "Allowed permissions in sharing" }, "scope": { "type": "string", "title": "ID of the scope to which the object is shared" }, "levels": { "type": "string", "title": "Number of level to which share should be applied" }, "scope_types": { "items": { "type": "string" }, "type": "array", "title": "Only apply share for specific types" } } }, "type": "array", "title": "Selectively shared object, List of (project, permissions)" } } }, "name": { "type": "string", "title": "Name of the object, defaults to 'default-<resource-type>'" }, "finish_time": { "type": "string", "title": "Finish time of this job" }, "meta": { "type": "object", "properties": { "enable": { "type": "boolean", "title": "Administratively Enable/Disable this object" }, "user_visible": { "type": "boolean", "title": "System created internal objects will have this flag set and will not be visible" } } } } }, "ID": { "type": "string" }, "fieldMask": { "description": "paths: \"f.a\"\n paths: \"f.b.d\"\n\nHere `f` represents a field in some root message, `a` and `b`\nfields in the message found in `f`, and `d` a field found in the\nmessage in `f.b`.\n\nField masks are used to specify a subset of fields that should be\nreturned by a get operation or modified by an update operation.\nField masks also have a custom JSON encoding (see below).\n\n# Field Masks in Projections\n\nWhen used in the context of a projection, a response message or\nsub-message is filtered by the API to only contain those fields as\nspecified in the mask. For example, if the mask in the previous\nexample is applied to a response message as follows:\n\n f {\n a : 22\n b {\n d : 1\n x : 2\n }\n y : 13\n }\n z: 8\n\nThe result will not contain specific values for fields x,y and z\n(their value will be set to the default, and omitted in proto text\noutput):\n\n\n f {\n a : 22\n b {\n d : 1\n }\n }\n\nA repeated field is not allowed except at the last position of a\npaths string.\n\nIf a FieldMask object is not present in a get operation, the\noperation applies to all fields (as if a FieldMask of all fields\nhad been specified).\n\nNote that a field mask does not necessarily apply to the\ntop-level response message. In case of a REST get operation, the\nfield mask applies directly to the response, but in case of a REST\nlist operation, the mask instead applies to each individual message\nin the returned resource list. In case of a REST custom method,\nother definitions may be used. Where the mask applies will be\nclearly documented together with its declaration in the API. In\nany case, the effect on the returned resource/resources is required\nbehavior for APIs.\n\n# Field Masks in Update Operations\n\nA field mask in update operations specifies which fields of the\ntargeted resource are going to be updated. The API is required\nto only change the values of the fields as specified in the mask\nand leave the others untouched. If a resource is passed in to\ndescribe the updated values, the API ignores the values of all\nfields not covered by the mask.\n\nIf a repeated field is specified for an update operation, new values will\nbe appended to the existing repeated field in the target resource. Note that\na repeated field is only allowed in the last position of a `paths` string.\n\nIf a sub-message is specified in the last position of the field mask for an\nupdate operation, then new value will be merged into the existing sub-message\nin the target resource.\n\nFor example, given the target message:\n\n f {\n b {\n d: 1\n x: 2\n }\n c: [1]\n }\n\nAnd an update message:\n\n f {\n b {\n d: 10\n }\n c: [2]\n }\n\nthen if the field mask is:\n\n paths: [\"f.b\", \"f.c\"]\n\nthen the result will be:\n\n f {\n b {\n d: 10\n x: 2\n }\n c: [1, 2]\n }\n\nAn implementation may provide options to override this default behavior for\nrepeated and message fields.\n\nIn order to reset a field's value to the default, the field must\nbe in the mask and set to the default value in the provided resource.\nHence, in order to reset all fields of a resource, provide a default\ninstance of the resource and set all fields in the mask, or do\nnot provide a mask as described below.\n\nIf a field mask is not present on update, the operation applies to\nall fields (as if a field mask of all fields has been specified).\nNote that in the presence of schema evolution, this may mean that\nfields the client does not know and has therefore not filled into\nthe request will be reset to their default. If this is unwanted\nbehavior, a specific service may require a client to always specify\na field mask, producing an error if not.\n\nAs with get operations, the location of the resource which\ndescribes the updated values in the request message depends on the\noperation kind. In any case, the effect of the field mask is\nrequired to be honored by the API.\n\n## Considerations for HTTP REST\n\nThe HTTP kind of an update operation which uses a field mask must\nbe set to PATCH instead of PUT in order to satisfy HTTP semantics\n(PUT must only be used for full updates).\n\n# JSON Encoding of Field Masks\n\nIn JSON, a field mask is encoded as a single string where paths are\nseparated by a comma. Fields name in each path are converted\nto/from lower-camel naming conventions.\n\nAs an example, consider the following message declarations:\n\n message Profile {\n User user = 1;\n Photo photo = 2;\n }\n message User {\n string display_name = 1;\n string address = 2;\n }\n\nIn proto a field mask for `Profile` may look as such:\n\n mask {\n paths: \"user.display_name\"\n paths: \"photo\"\n }\n\nIn JSON, the same mask is represented as below:\n\n {\n mask: \"user.displayName,photo\"\n }\n\n# Field Masks and Oneof Fields\n\nField masks treat fields in oneofs just as regular fields. Consider the\nfollowing message:\n\n message SampleMessage {\n oneof test_oneof {\n string name = 4;\n SubMessage sub_message = 9;\n }\n }\n\nThe field mask can be:\n\n mask {\n paths: \"name\"\n }\n\nOr:\n\n mask {\n paths: \"sub_message\"\n }\n\nNote that oneof type names (\"test_oneof\" in this case) cannot be used in\npaths.\n\n## Field Mask Verification\n\nThe implementation of any API method which has a FieldMask type field in the\nrequest should verify the included field paths, and return an\n`INVALID_ARGUMENT` error if any path is unmappable.", "type": "object", "properties": { "paths": { "items": { "type": "string" }, "type": "array", "description": "The set of field mask paths." } }, "title": "`FieldMask` represents a set of symbolic field paths, for example:" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/jobstoreServiceUpdateTask" }, "task": true }, { "name": "jobstoreServiceGetTask", "summary": "Get task by ID", "description": "Get task by ID", "input": [ { "name": "iD", "type": "string", "info": ": string", "required": true, "schema": { "title": "iD", "type": "string" } }, { "name": "detail", "type": "boolean", "info": "if detail is set then reference uuids & child uuids will be returned in the response.: boolean", "required": false, "schema": { "title": "detail", "type": "boolean" } }, { "name": "fields", "type": "array", "info": "limit displayed fields.: array", "required": false, "schema": { "title": "fields", "type": "array" } }, { "name": "refFields", "type": "array", "info": "limit displayed reference fields.: array", "required": false, "schema": { "title": "refFields", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/jobstoreServiceGetTask" }, "task": true }, { "name": "jobstoreServiceDeleteTask", "summary": "Delete task by ID", "description": "Delete task by ID", "input": [ { "name": "iD", "type": "string", "info": ": string", "required": true, "schema": { "title": "iD", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/jobstoreServiceDeleteTask" }, "task": true }, { "name": "jobstoreServiceSync", "summary": "Sync", "description": "This API can be used to CREATE/UPDATE/DELETE multiple resources from database", "input": [ { "name": "body", "type": "object", "info": ": {\"task\": {\"resources\": [{\"parent_uuid\": \"string\", \"parent_type\": \"string\", \"href\": \"string\", \"parent_task\": \"string\", \"created_timestamp\": \"string\", \"updated_by\": \"string\", \"updated_timestamp\": \"string\", \"task_type\": \"string\", \"display_name\": \"string\", \"uuid\": \"string\", \"configuration_version\": \"string\", \"created_by\": \"string\", \"progress\": \"string\", \"status_message\": \"string\", \"annotations\": {\"key_value_pair\": [{\"value\": \"string\", \"key\": \"string\"}]}, \"resources\": \"array\", \"status\": \"string\", \"description\": \"string\", \"start_time\": \"string\", \"perms2\": {\"owner\": \"string\", \"global_access\": \"string\", \"share\": [{\"access\": \"string\", \"scope\": \"string\", \"levels\": \"string\", \"scope_types\": \"array\"}]}, \"name\": \"string\", \"finish_time\": \"string\", \"meta\": {\"enable\": \"boolean\", \"user_visible\": \"boolean\"}}]}, \"last-published-notification\": {\"resources\": [{\"updated_timestamp\": \"string\", \"parent_uuid\": \"string\", \"description\": \"string\", \"configuration_version\": \"string\", \"parent_type\": \"string\", \"last_published_timestamp\": \"string\", \"name\": \"string\", \"perms2\": {\"owner\": \"string\", \"global_access\": \"string\", \"share\": [{\"access\": \"string\", \"scope\": \"string\", \"levels\": \"string\", \"scope_types\": \"array\"}]}, \"href\": \"string\", \"meta\": {\"enable\": \"boolean\", \"user_visible\": \"boolean\"}, \"created_by\": \"string\", \"updated_by\": \"string\", \"created_timestamp\": \"string\", \"annotations\": {\"key_value_pair\": [{\"value\": \"string\", \"key\": \"string\"}]}, \"resource_type\": \"string\", \"uuid\": \"string\"}]}, \"ignore_optimistic_lock\": \"boolean\", \"job\": {\"resources\": [{\"parent_uuid\": \"string\", \"parent_type\": \"string\", \"callback_params\": \"string\", \"task_child_refs\": [{\"uuid\": \"string\"}], \"href\": \"string\", \"created_timestamp\": \"string\", \"updated_by\": \"string\", \"updated_timestamp\": \"string\", \"display_name\": \"string\", \"uuid\": \"string\", \"configuration_version\": \"string\", \"created_by\": \"string\", \"trigger\": \"string\", \"progress\": \"string\", \"type\": \"string\", \"annotations\": {\"key_value_pair\": [{\"value\": \"string\", \"key\": \"string\"}]}, \"resources\": \"array\", \"metadata\": [{\"value\": \"string\", \"key\": \"string\"}], \"status\": \"string\", \"description\": \"string\", \"start_time\": \"string\", \"perms2\": {\"owner\": \"string\", \"global_access\": \"string\", \"share\": [{\"access\": \"string\", \"scope\": \"string\", \"levels\": \"string\", \"scope_types\": \"array\"}]}, \"name\": \"string\", \"finish_time\": \"string\", \"status_message\": \"string\", \"schedule_time\": \"string\", \"meta\": {\"enable\": \"boolean\", \"user_visible\": \"boolean\"}, \"callback_url\": \"string\"}]}, \"operation\": \"string\", \"deleted-resource\": {\"resources\": [{\"updated_timestamp\": \"string\", \"parent_uuid\": \"string\", \"description\": \"string\", \"configuration_version\": \"string\", \"parent_type\": \"string\", \"perms2\": {\"owner\": \"string\", \"global_access\": \"string\", \"share\": [{\"access\": \"string\", \"scope\": \"string\", \"levels\": \"string\", \"scope_types\": \"array\"}]}, \"name\": \"string\", \"href\": \"string\", \"meta\": {\"enable\": \"boolean\", \"user_visible\": \"boolean\"}, \"created_by\": \"string\", \"updated_by\": \"string\", \"created_timestamp\": \"string\", \"data\": \"string\", \"annotations\": {\"key_value_pair\": [{\"value\": \"string\", \"key\": \"string\"}]}, \"resource_type\": \"string\", \"uuid\": \"string\"}]}, \"field_mask\": {\"paths\": \"array\"}, \"job-purge-policy\": {\"resources\": [{\"updated_timestamp\": \"string\", \"parent_uuid\": \"string\", \"description\": \"string\", \"configuration_version\": \"string\", \"tenant_id\": \"string\", \"parent_type\": \"string\", \"perms2\": {\"owner\": \"string\", \"global_access\": \"string\", \"share\": [{\"access\": \"string\", \"scope\": \"string\", \"levels\": \"string\", \"scope_types\": \"array\"}]}, \"name\": \"string\", \"retention_period\": \"string\", \"href\": \"string\", \"meta\": {\"enable\": \"boolean\", \"user_visible\": \"boolean\"}, \"created_by\": \"string\", \"updated_by\": \"string\", \"created_timestamp\": \"string\", \"annotations\": {\"key_value_pair\": [{\"value\": \"string\", \"key\": \"string\"}]}, \"uuid\": \"string\"}]}}", "required": true, "schema": { "type": "object", "properties": { "task": { "type": "object", "properties": { "resources": { "items": { "type": "object", "properties": { "parent_uuid": { "type": "string", "title": "UUID of the parent object" }, "parent_type": { "type": "string", "title": "Parent resource type" }, "href": { "type": "string", "title": "Instance reference URL" }, "parent_task": { "type": "string", "title": "Parent Task" }, "created_timestamp": { "type": "string", "title": "Created Timestamp for the object" }, "updated_by": { "type": "string", "title": "user who updated this object" }, "updated_timestamp": { "type": "string", "title": "Updated Timestamp for the object" }, "task_type": { "type": "string" }, "display_name": { "type": "string", "title": "Display name of this task" }, "uuid": { "type": "string", "title": "UUID of the object, system automatically allocates one if not provided" }, "configuration_version": { "type": "string", "description": "Configuration Version for the object." }, "created_by": { "type": "string", "title": "user who created this object" }, "progress": { "type": "string", "description": "Progress in percentage." }, "status_message": { "type": "string", "title": "Detail status message" }, "annotations": { "type": "object", "properties": { "key_value_pair": { "items": { "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "type": "array" } } }, "resources": { "items": { "type": "string" }, "type": "array", "description": "Resources which are affected as part of this job. e.g list of devices." }, "status": { "type": "string" }, "description": { "type": "string", "title": "Description of the object" }, "start_time": { "type": "string", "title": "Start time of this job" }, "perms2": { "type": "object", "properties": { "owner": { "type": "string", "title": "Owner project of the object" }, "global_access": { "type": "string", "title": "Share the object globally" }, "share": { "items": { "type": "object", "properties": { "access": { "type": "string", "title": "Allowed permissions in sharing" }, "scope": { "type": "string", "title": "ID of the scope to which the object is shared" }, "levels": { "type": "string", "title": "Number of level to which share should be applied" }, "scope_types": { "items": { "type": "string" }, "type": "array", "title": "Only apply share for specific types" } } }, "type": "array", "title": "Selectively shared object, List of (project, permissions)" } } }, "name": { "type": "string", "title": "Name of the object, defaults to 'default-<resource-type>'" }, "finish_time": { "type": "string", "title": "Finish time of this job" }, "meta": { "type": "object", "properties": { "enable": { "type": "boolean", "title": "Administratively Enable/Disable this object" }, "user_visible": { "type": "boolean", "title": "System created internal objects will have this flag set and will not be visible" } } } } }, "type": "array" } } }, "last-published-notification": { "type": "object", "properties": { "resources": { "items": { "type": "object", "properties": { "updated_timestamp": { "type": "string", "title": "Updated Timestamp for the object" }, "parent_uuid": { "type": "string", "title": "UUID of the parent object" }, "description": { "type": "string", "title": "Description of the object" }, "configuration_version": { "type": "string", "description": "Configuration Version for the object." }, "parent_type": { "type": "string", "title": "Parent resource type" }, "last_published_timestamp": { "type": "string", "title": "The last published timestamp for the notification" }, "name": { "type": "string", "title": "Name of the object, defaults to 'default-<resource-type>'" }, "perms2": { "type": "object", "properties": { "owner": { "type": "string", "title": "Owner project of the object" }, "global_access": { "type": "string", "title": "Share the object globally" }, "share": { "items": { "type": "object", "properties": { "access": { "type": "string", "title": "Allowed permissions in sharing" }, "scope": { "type": "string", "title": "ID of the scope to which the object is shared" }, "levels": { "type": "string", "title": "Number of level to which share should be applied" }, "scope_types": { "items": { "type": "string" }, "type": "array", "title": "Only apply share for specific types" } } }, "type": "array", "title": "Selectively shared object, List of (project, permissions)" } } }, "href": { "type": "string", "title": "Instance reference URL" }, "meta": { "type": "object", "properties": { "enable": { "type": "boolean", "title": "Administratively Enable/Disable this object" }, "user_visible": { "type": "boolean", "title": "System created internal objects will have this flag set and will not be visible" } } }, "created_by": { "type": "string", "title": "user who created this object" }, "updated_by": { "type": "string", "title": "user who updated this object" }, "created_timestamp": { "type": "string", "title": "Created Timestamp for the object" }, "annotations": { "type": "object", "properties": { "key_value_pair": { "items": { "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "type": "array" } } }, "resource_type": { "type": "string", "description": "Type of the resource." }, "uuid": { "type": "string", "title": "UUID of the object, system automatically allocates one if not provided" } } }, "type": "array" } } }, "ignore_optimistic_lock": { "type": "boolean", "description": "if IgnoreOptimisticLock is set then optimistic lock wont be enforced in update case." }, "job": { "type": "object", "properties": { "resources": { "items": { "type": "object", "properties": { "parent_uuid": { "type": "string", "title": "UUID of the parent object" }, "parent_type": { "type": "string", "title": "Parent resource type" }, "callback_params": { "type": "string", "title": "Serailized Parameter to be passed to callback URL" }, "task_child_refs": { "items": { "type": "object", "properties": { "uuid": { "type": "string" } } }, "type": "array", "title": "Parent Job" }, "href": { "type": "string", "title": "Instance reference URL" }, "created_timestamp": { "type": "string", "title": "Created Timestamp for the object" }, "updated_by": { "type": "string", "title": "user who updated this object" }, "updated_timestamp": { "type": "string", "title": "Updated Timestamp for the object" }, "display_name": { "type": "string", "title": "Display name of this job" }, "uuid": { "type": "string", "title": "UUID of the object, system automatically allocates one if not provided" }, "configuration_version": { "type": "string", "description": "Configuration Version for the object." }, "created_by": { "type": "string", "title": "user who created this object" }, "trigger": { "type": "string", "title": "Trigger of this job e.g. request-id" }, "progress": { "type": "string", "description": "Progress in percentage." }, "type": { "type": "string", "title": "Type of the job" }, "annotations": { "type": "object", "properties": { "key_value_pair": { "items": { "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "type": "array" } } }, "resources": { "items": { "type": "string" }, "type": "array", "description": "Resources which are affected as part of this job. e.g list of devices." }, "metadata": { "items": { "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "type": "array", "title": "Metadata related to the job" }, "status": { "type": "string" }, "description": { "type": "string", "title": "Description of the object" }, "start_time": { "type": "string", "title": "Start time of this job" }, "perms2": { "type": "object", "properties": { "owner": { "type": "string", "title": "Owner project of the object" }, "global_access": { "type": "string", "title": "Share the object globally" }, "share": { "items": { "type": "object", "properties": { "access": { "type": "string", "title": "Allowed permissions in sharing" }, "scope": { "type": "string", "title": "ID of the scope to which the object is shared" }, "levels": { "type": "string", "title": "Number of level to which share should be applied" }, "scope_types": { "items": { "type": "string" }, "type": "array", "title": "Only apply share for specific types" } } }, "type": "array", "title": "Selectively shared object, List of (project, permissions)" } } }, "name": { "type": "string", "title": "Name of the object, defaults to 'default-<resource-type>'" }, "finish_time": { "type": "string", "title": "Finish time of this job" }, "status_message": { "type": "string", "title": "Detail status message" }, "schedule_time": { "type": "string", "title": "Scheduled start time of this job" }, "meta": { "type": "object", "properties": { "enable": { "type": "boolean", "title": "Administratively Enable/Disable this object" }, "user_visible": { "type": "boolean", "title": "System created internal objects will have this flag set and will not be visible" } } }, "callback_url": { "type": "string", "title": "Callback URL for scheduled job" } } }, "type": "array" } } }, "operation": { "type": "string" }, "deleted-resource": { "type": "object", "properties": { "resources": { "items": { "type": "object", "properties": { "updated_timestamp": { "type": "string", "title": "Updated Timestamp for the object" }, "parent_uuid": { "type": "string", "title": "UUID of the parent object" }, "description": { "type": "string", "title": "Description of the object" }, "configuration_version": { "type": "string", "description": "Configuration Version for the object." }, "parent_type": { "type": "string", "title": "Parent resource type" }, "perms2": { "type": "object", "properties": { "owner": { "type": "string", "title": "Owner project of the object" }, "global_access": { "type": "string", "title": "Share the object globally" }, "share": { "items": { "type": "object", "properties": { "access": { "type": "string", "title": "Allowed permissions in sharing" }, "scope": { "type": "string", "title": "ID of the scope to which the object is shared" }, "levels": { "type": "string", "title": "Number of level to which share should be applied" }, "scope_types": { "items": { "type": "string" }, "type": "array", "title": "Only apply share for specific types" } } }, "type": "array", "title": "Selectively shared object, List of (project, permissions)" } } }, "name": { "type": "string", "title": "Name of the object, defaults to 'default-<resource-type>'" }, "href": { "type": "string", "title": "Instance reference URL" }, "meta": { "type": "object", "properties": { "enable": { "type": "boolean", "title": "Administratively Enable/Disable this object" }, "user_visible": { "type": "boolean", "title": "System created internal objects will have this flag set and will not be visible" } } }, "created_by": { "type": "string", "title": "user who created this object" }, "updated_by": { "type": "string", "title": "user who updated this object" }, "created_timestamp": { "type": "string", "title": "Created Timestamp for the object" }, "data": { "type": "string", "description": "data of the resource." }, "annotations": { "type": "object", "properties": { "key_value_pair": { "items": { "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "type": "array" } } }, "resource_type": { "type": "string", "description": "Type of the resource." }, "uuid": { "type": "string", "title": "UUID of the object, system automatically allocates one if not provided" } } }, "type": "array" } } }, "field_mask": { "description": "paths: \"f.a\"\n paths: \"f.b.d\"\n\nHere `f` represents a field in some root message, `a` and `b`\nfields in the message found in `f`, and `d` a field found in the\nmessage in `f.b`.\n\nField masks are used to specify a subset of fields that should be\nreturned by a get operation or modified by an update operation.\nField masks also have a custom JSON encoding (see below).\n\n# Field Masks in Projections\n\nWhen used in the context of a projection, a response message or\nsub-message is filtered by the API to only contain those fields as\nspecified in the mask. For example, if the mask in the previous\nexample is applied to a response message as follows:\n\n f {\n a : 22\n b {\n d : 1\n x : 2\n }\n y : 13\n }\n z: 8\n\nThe result will not contain specific values for fields x,y and z\n(their value will be set to the default, and omitted in proto text\noutput):\n\n\n f {\n a : 22\n b {\n d : 1\n }\n }\n\nA repeated field is not allowed except at the last position of a\npaths string.\n\nIf a FieldMask object is not present in a get operation, the\noperation applies to all fields (as if a FieldMask of all fields\nhad been specified).\n\nNote that a field mask does not necessarily apply to the\ntop-level response message. In case of a REST get operation, the\nfield mask applies directly to the response, but in case of a REST\nlist operation, the mask instead applies to each individual message\nin the returned resource list. In case of a REST custom method,\nother definitions may be used. Where the mask applies will be\nclearly documented together with its declaration in the API. In\nany case, the effect on the returned resource/resources is required\nbehavior for APIs.\n\n# Field Masks in Update Operations\n\nA field mask in update operations specifies which fields of the\ntargeted resource are going to be updated. The API is required\nto only change the values of the fields as specified in the mask\nand leave the others untouched. If a resource is passed in to\ndescribe the updated values, the API ignores the values of all\nfields not covered by the mask.\n\nIf a repeated field is specified for an update operation, new values will\nbe appended to the existing repeated field in the target resource. Note that\na repeated field is only allowed in the last position of a `paths` string.\n\nIf a sub-message is specified in the last position of the field mask for an\nupdate operation, then new value will be merged into the existing sub-message\nin the target resource.\n\nFor example, given the target message:\n\n f {\n b {\n d: 1\n x: 2\n }\n c: [1]\n }\n\nAnd an update message:\n\n f {\n b {\n d: 10\n }\n c: [2]\n }\n\nthen if the field mask is:\n\n paths: [\"f.b\", \"f.c\"]\n\nthen the result will be:\n\n f {\n b {\n d: 10\n x: 2\n }\n c: [1, 2]\n }\n\nAn implementation may provide options to override this default behavior for\nrepeated and message fields.\n\nIn order to reset a field's value to the default, the field must\nbe in the mask and set to the default value in the provided resource.\nHence, in order to reset all fields of a resource, provide a default\ninstance of the resource and set all fields in the mask, or do\nnot provide a mask as described below.\n\nIf a field mask is not present on update, the operation applies to\nall fields (as if a field mask of all fields has been specified).\nNote that in the presence of schema evolution, this may mean that\nfields the client does not know and has therefore not filled into\nthe request will be reset to their default. If this is unwanted\nbehavior, a specific service may require a client to always specify\na field mask, producing an error if not.\n\nAs with get operations, the location of the resource which\ndescribes the updated values in the request message depends on the\noperation kind. In any case, the effect of the field mask is\nrequired to be honored by the API.\n\n## Considerations for HTTP REST\n\nThe HTTP kind of an update operation which uses a field mask must\nbe set to PATCH instead of PUT in order to satisfy HTTP semantics\n(PUT must only be used for full updates).\n\n# JSON Encoding of Field Masks\n\nIn JSON, a field mask is encoded as a single string where paths are\nseparated by a comma. Fields name in each path are converted\nto/from lower-camel naming conventions.\n\nAs an example, consider the following message declarations:\n\n message Profile {\n User user = 1;\n Photo photo = 2;\n }\n message User {\n string display_name = 1;\n string address = 2;\n }\n\nIn proto a field mask for `Profile` may look as such:\n\n mask {\n paths: \"user.display_name\"\n paths: \"photo\"\n }\n\nIn JSON, the same mask is represented as below:\n\n {\n mask: \"user.displayName,photo\"\n }\n\n# Field Masks and Oneof Fields\n\nField masks treat fields in oneofs just as regular fields. Consider the\nfollowing message:\n\n message SampleMessage {\n oneof test_oneof {\n string name = 4;\n SubMessage sub_message = 9;\n }\n }\n\nThe field mask can be:\n\n mask {\n paths: \"name\"\n }\n\nOr:\n\n mask {\n paths: \"sub_message\"\n }\n\nNote that oneof type names (\"test_oneof\" in this case) cannot be used in\npaths.\n\n## Field Mask Verification\n\nThe implementation of any API method which has a FieldMask type field in the\nrequest should verify the included field paths, and return an\n`INVALID_ARGUMENT` error if any path is unmappable.", "type": "object", "properties": { "paths": { "items": { "type": "string" }, "type": "array", "description": "The set of field mask paths." } }, "title": "`FieldMask` represents a set of symbolic field paths, for example:" }, "job-purge-policy": { "type": "object", "properties": { "resources": { "items": { "type": "object", "properties": { "updated_timestamp": { "type": "string", "title": "Updated Timestamp for the object" }, "parent_uuid": { "type": "string", "title": "UUID of the parent object" }, "description": { "type": "string", "title": "Description of the object" }, "configuration_version": { "type": "string", "description": "Configuration Version for the object." }, "tenant_id": { "type": "string", "title": "tenant identifier" }, "parent_type": { "type": "string", "title": "Parent resource type" }, "perms2": { "type": "object", "properties": { "owner": { "type": "string", "title": "Owner project of the object" }, "global_access": { "type": "string", "title": "Share the object globally" }, "share": { "items": { "type": "object", "properties": { "access": { "type": "string", "title": "Allowed permissions in sharing" }, "scope": { "type": "string", "title": "ID of the scope to which the object is shared" }, "levels": { "type": "string", "title": "Number of level to which share should be applied" }, "scope_types": { "items": { "type": "string" }, "type": "array", "title": "Only apply share for specific types" } } }, "type": "array", "title": "Selectively shared object, List of (project, permissions)" } } }, "name": { "type": "string", "title": "Name of the object, defaults to 'default-<resource-type>'" }, "retention_period": { "type": "string", "title": "retention period in days" }, "href": { "type": "string", "title": "Instance reference URL" }, "meta": { "type": "object", "properties": { "enable": { "type": "boolean", "title": "Administratively Enable/Disable this object" }, "user_visible": { "type": "boolean", "title": "System created internal objects will have this flag set and will not be visible" } } }, "created_by": { "type": "string", "title": "user who created this object" }, "updated_by": { "type": "string", "title": "user who updated this object" }, "created_timestamp": { "type": "string", "title": "Created Timestamp for the object" }, "annotations": { "type": "object", "properties": { "key_value_pair": { "items": { "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "type": "array" } } }, "uuid": { "type": "string", "title": "UUID of the object, system automatically allocates one if not provided" } } }, "type": "array" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/jobstoreServiceSync" }, "task": true }, { "name": "jobstoreManagerPurge", "summary": "Purge", "description": "RPC to Purge Jobs and Tasks based on purge policy", "input": [ { "name": "body", "type": "object", "info": ": {\"tenant_id\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "tenant_id": { "type": "string", "title": "This is the scope id of the tenant used in the purge policy" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/jobstoreManagerPurge" }, "task": true } ], "views": [] }