Get TLS jobs - Crosswork Network Controller 7.1 APIs

{"type":"api","title":"Get TLS jobs","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/5886016a-c07b-3cba-89ee-956f0483ba29","info":{"title":"Crosswork Certificate Manager API","description":"Crosswork Certificate Manager provides the ability to view, upload and modify X.509 certificates that are used for communication between Crosswork components as well as between Crosswork applications and devices.","version":"1.1.0","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"https://www.cisco.com/public/sw-license-agreement.html"}},"x-parser-conf":{"overview":{"markdownPath":"reference/INFRA/TLS/tls-overview.md"}},"swagger":"2.0","basePath":"/crosswork/platform/v2","schemes":["http","https"],"securityDefinitions":{"bearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"Security definitions details."}}},"spec":{"summary":"Get TLS jobs","operationId":"TLSManager_GetTLSJobs","responses":{"200":{"description":"A successful response.","schema":{"type":"object","properties":{"jobs":{"type":"array","items":{"type":"object","properties":{"job_id":{"type":"string","title":"job_id"},"job_user":{"type":"string","title":"User who created the job"},"start_time":{"type":"string","format":"int64","title":"start time in epoch milliseconds"},"completion_time":{"type":"string","format":"int64","title":"end time in epoch milliseconds"},"progress":{"type":"number","format":"float","title":"progress"},"job_status":{"title":"Job Status","type":"string","enum":["JOB_UNKNOWN","JOB_CREATED","JOB_IN_PROGRESS","JOB_COMPLETED","JOB_FAILED"],"default":"JOB_UNKNOWN","$$ref":"#/definitions/common_platformJobStatus"},"job_context":{"title":"Job context","type":"object","properties":{"empty":{"properties":{},"description":"No applicable job context."}},"$$ref":"#/definitions/tlsJobContext"},"job_type":{"title":"Job Action","type":"string","enum":["UNKNOWN_JOB_TYPE","RENEW_CERTIFICATES"],"default":"UNKNOWN_JOB_TYPE","description":"- RENEW_CERTIFICATES: Renew TLS Certificates","$$ref":"#/definitions/tlsJobType"},"error":{"title":"Error","type":"object","properties":{"message":{"type":"string","title":"Message is a textual description of reason for rejection, and can be safely passed on to operator through logs\nor UI"}},"$$ref":"#/definitions/common_platformError"},"job_description":{"type":"string","title":"Description"}},"$$ref":"#/definitions/tlsJob"},"title":"Replication oper state"},"query_options":{"description":"Query options","type":"object","properties":{"filters":{"description":"Generic key value filter set","type":"object","properties":{"filter_fields":{"type":"array","items":{"type":"object","properties":{"key_value":{"title":"Key Value","type":"object","properties":{"key":{"type":"string"},"string_value":{"type":"string","title":"Commented out is reserved for future use.\nbytes bytes_value = 2;"},"bool_value":{"type":"boolean"},"uint64_value":{"type":"string","format":"uint64","title":"uint32 uint32_value = 5;"},"sint64_value":{"type":"string","format":"int64","title":"sint32 sint32_value = 7;"},"double_value":{"type":"number","format":"double"}},"$$ref":"#/definitions/common_platformKeyValue"},"comparison_operator":{"title":"Comparison operator","type":"string","enum":["COMPARISON_UNKNOWN","CONTAINS","ICONTAINS","EQUAL","LESS_THAN","LESS_THAN_OR_EQUAL","GREATER_THAN","GREATER_THAN_OR_EQUAL","NOT_EQUAL"],"default":"COMPARISON_UNKNOWN","description":"- CONTAINS: STRING contains.Case sensitive May not be supported for all data types\n - ICONTAINS: STRING contains.Case Insensitive. May not be supported for all data types\n - EQUAL: Equal.\n - LESS_THAN: Commented ones are for future use\n Less than.\n - LESS_THAN_OR_EQUAL: // Less than or equal.\n - GREATER_THAN: // Greater than.\n - GREATER_THAN_OR_EQUAL: // Greater than or equal.\n - NOT_EQUAL: NOT EQUAL","$$ref":"#/definitions/common_platformComparisonOperator"}},"title":"Key Value filter set","$$ref":"#/definitions/common_platformFilterKeyValue"},"description":"Key Value filters"},"logical_operator":{"description":"The following is applied to all filters\n1. how individual filters are combined\n2. how the filtered result will be sorted\nLogical Operator","type":"string","enum":["OPERATOR_LOGICAL_UNKNOWN","AND","OR"],"default":"OPERATOR_LOGICAL_UNKNOWN","title":"Logical Operator","$$ref":"#/definitions/common_platformLogicalOperator"},"sort_operator":{"description":"Implicit sort ordering","type":"string","enum":["SORT_UNSPECIFIED","ASCENDING","DESCENDING"],"default":"SORT_UNSPECIFIED","$$ref":"#/definitions/common_platformSortOperator"}},"title":"KeyValue Filter Set","$$ref":"#/definitions/common_platformFilterKeyValueSet"},"cw_query":{"description":"SQL like filter query","type":"object","properties":{"query":{"type":"string","title":"SQL like filter query\nselect * from robotnodedata where provider.provider.name='nso101'"}},"title":"SQL like CW query style","$$ref":"#/definitions/common_platformCWQuery"},"pagination":{"description":"Pagination","type":"object","properties":{"page_token":{"type":"string","title":"Page token to echo back to get next page, is empty or page token is empty,\nthen there is no more results"},"page_size":{"type":"integer","format":"int64","title":"page_size"}},"title":"Pagination option","$$ref":"#/definitions/common_platformPagination"}},"title":"Query Options","$$ref":"#/definitions/common_platformQueryOptions"},"result":{"description":"Accepted or Rejected","type":"object","properties":{"request_result":{"description":"ResultValue indicated accept/reject for a request, not the outcome of the work itself.","type":"string","enum":["UNKNOWN_RESULT","REJECTED","ACCEPTED"],"default":"UNKNOWN_RESULT","title":"Request - reply\nresponse","$$ref":"#/definitions/tlsJobRequestResult"},"error":{"description":"Message is a textual description of reason for rejection, and can be safely passed on to operator through logs\nor UI.","type":"object","properties":{"message":{"type":"string","title":"Message is a textual description of reason for rejection, and can be safely passed on to operator through logs\nor UI"}},"title":"Error associated with an Object","$$ref":"#/definitions/common_platformError"}},"$$ref":"#/definitions/tlsJobResult"}},"title":"TLS Jobs Response","$$ref":"#/definitions/tlsGetTLSManagerJobsResponse"},"examples":{"example":{"jobs":[],"query_options":{"pagination":{"page_token":"","page_size":13}},"result":{"request_result":"ACCEPTED"}}}},"default":{"description":"An unexpected error response.","schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"type_url":{"type":"string","description":"A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."},"value":{"type":"string","format":"byte","description":"Must be a valid serialized protocol buffer of the above specified type."}},"description":"`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(&foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := &pb.Foo{...}\n any, err := ptypes.MarshalAny(foo)\n ...\n foo := &pb.Foo{}\n if err := ptypes.UnmarshalAny(any, foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }","$$ref":"#/definitions/protobufAny"}}},"$$ref":"#/definitions/gatewayruntimeError"},"examples":{"example":{"error":"","code":13,"message":"failed to marshal error message","details":[]}}}},"parameters":[{"name":"body","in":"body","required":true,"description":"tls job get request","schema":{"type":"object","properties":{"job_id":{"type":"string","description":"job id"},"query_options":{"description":"Query options","type":"object","properties":{"filters":{"description":"Generic key value filter set","type":"object","properties":{"filter_fields":{"type":"array","items":{"type":"object","properties":{"key_value":{"title":"Key Value","type":"object","properties":{"key":{"type":"string"},"string_value":{"type":"string","title":"Commented out is reserved for future use.\nbytes bytes_value = 2;"},"bool_value":{"type":"boolean"},"uint64_value":{"type":"string","format":"uint64","title":"uint32 uint32_value = 5;"},"sint64_value":{"type":"string","format":"int64","title":"sint32 sint32_value = 7;"},"double_value":{"type":"number","format":"double"}},"$$ref":"#/definitions/common_platformKeyValue"},"comparison_operator":{"title":"Comparison operator","type":"string","enum":["COMPARISON_UNKNOWN","CONTAINS","ICONTAINS","EQUAL","LESS_THAN","LESS_THAN_OR_EQUAL","GREATER_THAN","GREATER_THAN_OR_EQUAL","NOT_EQUAL"],"default":"COMPARISON_UNKNOWN","description":"- CONTAINS: STRING contains.Case sensitive May not be supported for all data types\n - ICONTAINS: STRING contains.Case Insensitive. May not be supported for all data types\n - EQUAL: Equal.\n - LESS_THAN: Commented ones are for future use\n Less than.\n - LESS_THAN_OR_EQUAL: // Less than or equal.\n - GREATER_THAN: // Greater than.\n - GREATER_THAN_OR_EQUAL: // Greater than or equal.\n - NOT_EQUAL: NOT EQUAL","$$ref":"#/definitions/common_platformComparisonOperator"}},"title":"Key Value filter set","$$ref":"#/definitions/common_platformFilterKeyValue"},"description":"Key Value filters"},"logical_operator":{"description":"The following is applied to all filters\n1. how individual filters are combined\n2. how the filtered result will be sorted\nLogical Operator","type":"string","enum":["OPERATOR_LOGICAL_UNKNOWN","AND","OR"],"default":"OPERATOR_LOGICAL_UNKNOWN","title":"Logical Operator","$$ref":"#/definitions/common_platformLogicalOperator"},"sort_operator":{"description":"Implicit sort ordering","type":"string","enum":["SORT_UNSPECIFIED","ASCENDING","DESCENDING"],"default":"SORT_UNSPECIFIED","$$ref":"#/definitions/common_platformSortOperator"}},"title":"KeyValue Filter Set","$$ref":"#/definitions/common_platformFilterKeyValueSet"},"cw_query":{"description":"SQL like filter query","type":"object","properties":{"query":{"type":"string","title":"SQL like filter query\nselect * from robotnodedata where provider.provider.name='nso101'"}},"title":"SQL like CW query style","$$ref":"#/definitions/common_platformCWQuery"},"pagination":{"description":"Pagination","type":"object","properties":{"page_token":{"type":"string","title":"Page token to echo back to get next page, is empty or page token is empty,\nthen there is no more results"},"page_size":{"type":"integer","format":"int64","title":"page_size"}},"title":"Pagination option","$$ref":"#/definitions/common_platformPagination"}},"title":"Query Options","$$ref":"#/definitions/common_platformQueryOptions"}},"example":{"query_options":{"pagination":{"page_token":"","page_size":13}}},"title":"Get TLS Jobs","$$ref":"#/definitions/tlsGetTLSManagerJobsRequest"}}],"tags":["TLSManager"],"__originalOperationId":"TLSManager_GetTLSJobs","consumes":["application/json"],"produces":["application/json"],"method":"post","path":"/cert/jobs/query"}}