Get TLS jobs - Crosswork Network Controller 7.2 APIs

{"type":"api","title":"Get TLS jobs","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-2/76fd4bb9d069fd2530d7a02f0b3a4ca00eccfd35/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.","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"},"version":"7.2.0"},"x-parser-conf":{"overview":{"markdownPath":"reference/INFRA/TLS/tls-overview.md"}},"openapi":"3.0.1","servers":[{"url":"https://{cw_ip}:30603/crosswork/platform/v2"}],"securitySchemes":{"bearerAuth":{"type":"apiKey","description":"Security definitions details.","name":"Authorization","in":"header"}}},"spec":{"tags":["TLSManager"],"summary":"Get TLS jobs","operationId":"TLSManager_GetTLSJobs","requestBody":{"description":"tls job get request","content":{"application/json":{"schema":{"description":"Get TLS Jobs","type":"object","properties":{"job_id":{"type":"string","description":"job id"},"query_options":{"description":"Query Options","type":"object","properties":{"filters":{"description":"Key value filter set","type":"object","properties":{"filter_fields":{"type":"array","description":"Key value filters","items":{"description":"Key value filter set","type":"object","properties":{"key_value":{"description":"Generic Key value message","type":"object","properties":{"key":{"description":"Key string","type":"string"},"string_value":{"description":"Commented out is reserved for future use.","type":"string"},"bool_value":{"description":"bool","type":"boolean"},"uint64_value":{"description":"uint64","type":"string","format":"uint64"},"sint64_value":{"description":"sint64","type":"string","format":"int64"},"double_value":{"description":"double","type":"number","format":"double"}},"$$ref":"#/components/schemas/common_platformKeyValue"},"comparison_operator":{"type":"string","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_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\n","default":"COMPARISON_UNKNOWN","enum":["COMPARISON_UNKNOWN","CONTAINS","ICONTAINS","EQUAL","LESS_THAN","LESS_THAN_OR_EQUAL","GREATER_THAN","GREATER_THAN_OR_EQUAL","NOT_EQUAL"],"$$ref":"#/components/schemas/common_platformComparisonOperator"}},"$$ref":"#/components/schemas/common_platformFilterKeyValue"}},"logical_operator":{"type":"string","description":"- AND: Logical AND\n - OR: Logical OR","default":"OPERATOR_LOGICAL_UNKNOWN","enum":["OPERATOR_LOGICAL_UNKNOWN","AND","OR"],"$$ref":"#/components/schemas/common_platformLogicalOperator"},"sort_operator":{"type":"string","description":"The sort direction.\n\n - SORT_UNSPECIFIED: Unspecified. This value must not be used.\n - ASCENDING: Ascending.\n - DESCENDING: Descending.","default":"SORT_UNSPECIFIED","enum":["SORT_UNSPECIFIED","ASCENDING","DESCENDING"],"$$ref":"#/components/schemas/common_platformSortOperator"}},"$$ref":"#/components/schemas/common_platformFilterKeyValueSet"},"cw_query":{"description":"SQL filter query","type":"object","properties":{"query":{"description":"SQL filter query string","type":"string"}},"$$ref":"#/components/schemas/common_platformCWQuery"},"pagination":{"description":"Pagination option","type":"object","properties":{"page_token":{"description":"Page token to echo back to get next page, is empty or page token is empty,\nthen there is no more results","type":"string"},"page_size":{"description":"page size","type":"integer","format":"int64"}},"$$ref":"#/components/schemas/common_platformPagination"}},"$$ref":"#/components/schemas/common_platformQueryOptions"}},"example":{"query_options":{"pagination":{"page_token":"","page_size":13}}},"$$ref":"#/components/schemas/tlsGetTLSManagerJobsRequest"}}},"required":true},"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"description":"TLS Jobs Response","type":"object","properties":{"jobs":{"description":"Replication oper state","type":"array","items":{"type":"object","description":"TLS Job","properties":{"job_id":{"description":"job id","type":"string"},"job_user":{"description":"User who created the job","type":"string"},"start_time":{"description":"start time in epoch milliseconds","type":"string","format":"int64"},"completion_time":{"description":"end time in epoch milliseconds","type":"string","format":"int64"},"progress":{"description":"progress","type":"number","format":"float"},"job_status":{"description":"Job Enum","type":"string","default":"JOB_UNKNOWN","enum":["JOB_UNKNOWN","JOB_CREATED","JOB_IN_PROGRESS","JOB_COMPLETED","JOB_FAILED"],"$$ref":"#/components/schemas/common_platformJobStatus"},"job_context":{"description":"Job Context","type":"object","properties":{"empty":{"type":"object","properties":{},"description":"No applicable job context."}},"$$ref":"#/components/schemas/tlsJobContext"},"job_type":{"type":"string","description":"- RENEW_CERTIFICATES: Renew TLS Certificates","default":"UNKNOWN_JOB_TYPE","enum":["UNKNOWN_JOB_TYPE","RENEW_CERTIFICATES"],"$$ref":"#/components/schemas/tlsJobType"},"error":{"description":"Error associated with an Object","type":"object","properties":{"message":{"description":"Message is a textual description of reason for rejection, and can be safely passed on to operator through logs or UI","type":"string"}},"$$ref":"#/components/schemas/common_platformError"},"job_description":{"description":"Description","type":"string"}},"$$ref":"#/components/schemas/tlsJob"}},"query_options":{"description":"Query Options","type":"object","properties":{"filters":{"description":"Key value filter set","type":"object","properties":{"filter_fields":{"type":"array","description":"Key value filters","items":{"description":"Key value filter set","type":"object","properties":{"key_value":{"description":"Generic Key value message","type":"object","properties":{"key":{"description":"Key string","type":"string"},"string_value":{"description":"Commented out is reserved for future use.","type":"string"},"bool_value":{"description":"bool","type":"boolean"},"uint64_value":{"description":"uint64","type":"string","format":"uint64"},"sint64_value":{"description":"sint64","type":"string","format":"int64"},"double_value":{"description":"double","type":"number","format":"double"}},"$$ref":"#/components/schemas/common_platformKeyValue"},"comparison_operator":{"type":"string","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_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\n","default":"COMPARISON_UNKNOWN","enum":["COMPARISON_UNKNOWN","CONTAINS","ICONTAINS","EQUAL","LESS_THAN","LESS_THAN_OR_EQUAL","GREATER_THAN","GREATER_THAN_OR_EQUAL","NOT_EQUAL"],"$$ref":"#/components/schemas/common_platformComparisonOperator"}},"$$ref":"#/components/schemas/common_platformFilterKeyValue"}},"logical_operator":{"type":"string","description":"- AND: Logical AND\n - OR: Logical OR","default":"OPERATOR_LOGICAL_UNKNOWN","enum":["OPERATOR_LOGICAL_UNKNOWN","AND","OR"],"$$ref":"#/components/schemas/common_platformLogicalOperator"},"sort_operator":{"type":"string","description":"The sort direction.\n\n - SORT_UNSPECIFIED: Unspecified. This value must not be used.\n - ASCENDING: Ascending.\n - DESCENDING: Descending.","default":"SORT_UNSPECIFIED","enum":["SORT_UNSPECIFIED","ASCENDING","DESCENDING"],"$$ref":"#/components/schemas/common_platformSortOperator"}},"$$ref":"#/components/schemas/common_platformFilterKeyValueSet"},"cw_query":{"description":"SQL filter query","type":"object","properties":{"query":{"description":"SQL filter query string","type":"string"}},"$$ref":"#/components/schemas/common_platformCWQuery"},"pagination":{"description":"Pagination option","type":"object","properties":{"page_token":{"description":"Page token to echo back to get next page, is empty or page token is empty,\nthen there is no more results","type":"string"},"page_size":{"description":"page size","type":"integer","format":"int64"}},"$$ref":"#/components/schemas/common_platformPagination"}},"$$ref":"#/components/schemas/common_platformQueryOptions"},"result":{"type":"object","properties":{"request_result":{"type":"string","description":"- REJECTED: Request has been rejected\n - ACCEPTED: Request has been accepted for processing","default":"UNKNOWN_RESULT","enum":["UNKNOWN_RESULT","REJECTED","ACCEPTED"],"$$ref":"#/components/schemas/tlsJobRequestResult"},"error":{"description":"Error associated with an Object","type":"object","properties":{"message":{"description":"Message is a textual description of reason for rejection, and can be safely passed on to operator through logs or UI","type":"string"}},"$$ref":"#/components/schemas/common_platformError"}},"description":"Result is used to convey whether an operation (individual or in a batch)\nhas been accepted or rejected. For sync API's an error or rejection indicates failure of operation.\nA string error message accompanies rejection to support troubleshooting. For notification objects,\nrejection represents failure to do intended operation.","$$ref":"#/components/schemas/tlsJobResult"}},"$$ref":"#/components/schemas/tlsGetTLSManagerJobsResponse"},"example":{"jobs":[],"query_options":{"pagination":{"page_token":"","page_size":13}},"result":{"request_result":"ACCEPTED"}}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"type":"object","description":"Standard error model for Gateway Runtime APIs","properties":{"error":{"type":"string","description":"A string representation of the error type."},"code":{"type":"integer","description":"Error code number.","format":"int32"},"message":{"type":"string","description":"A human-readable message providing more details about the error."},"details":{"type":"array","description":"Additional error details.","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":{"pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$","type":"string","description":"Must be a valid serialized protocol buffer of the above specified type.","format":"byte"}},"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":"#/components/schemas/protobufAny"}}},"$$ref":"#/components/schemas/gatewayruntimeError"},"example":{"error":"","code":13,"message":"failed to marshal error message","details":[]}}}}},"x-codegen-request-body-name":"body","__originalOperationId":"TLSManager_GetTLSJobs","method":"post","path":"/cert/jobs/query"}}