Approve_Job operation
The Approve_Job operation approves or rejects a job.
The following table describes the elements for the <items>
XML element and adapter request for the Approve_Job operation:
Elements for the <items>
XML element and adapter request for the Approve_Job operation
Element |
Definition |
Required |
---|---|---|
|
Specifies the complete URL with the job ID of the job to be approved or rejected |
Yes |
|
Specifies the name of operation: |
Yes |
|
Specifies the status of the job |
Yes |
|
Specifies the details or description of job approval or rejection |
Yes |
|
Specifies whether to use an SSL certificate to establish a secure connection |
No |
|
Specifies whether to install security certificates automatically Note You do not need this element if the Set the value of this element to true if you prefer to have security certificates installed automatically (a common practice). |
No |
|
Specifies whether to allow unsigned certificates from trusted zones |
No |
|
Specifies the password to the keystore file (cacerts) local to the TrueSight Orchestration peer Warning
|
No |
|
Contains the elements that specify information about the public key (X.509 certificate) and the private key that are used for the digital signature
|
No |
|
Specifies the path to the JKS that contains the client certificate |
Conditional; required when |
|
Specifies the password of the key contained in the JKS Note If you do not specify |
No |
|
Specifies the password to the JKS |
Conditional; required when |
|
Specifies the name of the alias in the JKS that identifies the Public Key Certificate (PKC), which the web server uses to authenticate the client |
Conditional; required when |
|
Specifies the file containing the private key, which is used to sign the HTTP request
|
Conditional; required when |
|
Specifies the file containing the public key (X509 Certificate)
|
Conditional; required when |
|
Contains an XML specifying the private key in an Base64-encoded PEM format |
Conditional; required when |
|
Contains an XML specifying the public key (X509 Certificate) in an Base64-encoded PEM format |
Conditional; required when |
The following figure shows a sample <items>
XML element for the Approve_Job operation:
<items>
XML element for the Approve_Job operation
<items>
<item>
<target></target>
<job-status></job-status>
<detail><detail>
</item>
</items>
The following figure shows a sample adapter request for the Approve_Job operation:
Sample adapter request for the Approve_Job operation
<bda-request>
<target>http://10.128.28.59/api/jobs/66</target>
<operation-name>Approve_Job</operation-name>
<job-status>denied</job-status>
<detail>Approved By User</detail>
</bda-request>
The following figure shows a sample adapter request for the Approve_Job operation with SSL tags and client certificates in key-data mode:
Sample adapter request for the Approve_Job operation with SSL tags and client certificates in key-data mode
<bda-request>
<target>https://10.128.28.59/api/jobs/66</target>
<operation-name>Approve_Job</operation-name>
<job-status>denied</job-status>
<detail>Approved By User</detail>
<use-ssl-certificate>true</use-ssl-certificate>
<install-certificate>true</install-certificate>
<allow-unsigned-certificate>true</allow-unsigned-certificate>
<signature-properties mode="key-data">
<private-key-data>-----BEGIN RSA PRIVATE KEY-----
MIICXAIBAAKBgQDbDkji1X+Bxv7WLI5yaFTFsWgBtLPlm7x0O9iACBycLKelOZJl
....
m57VRInEsLbXpJHoPISk8Gj+JL/CGK7rIcDtPebLIEs=
-----END RSA PRIVATE KEY-----</private-key-data>
<certificate-data>-----BEGIN CERTIFICATE-----
MIICvzCCAigCAQEwDQYJKoZIhvcNAQEEBQAwga0xCzAJBgNVBAYTAlVTMREwDwYD
....
nSYYODyuU/pfV9V+qS+p/kwk/UKgEiwnngPEFn7v3zAzXmE=
-----END CERTIFICATE-----</certificate-data>
</signature-properties>
</bda-request>
The following figure shows a sample adapter request for the Approve_Job operation with SSL tags and client certificates in key-files mode:
Sample adapter request for the Approve_Job operation with SSL tags and client certificates in key-files mode
<bda-request>
<target>https://10.128.28.59/api/jobs/66</target>
<operation-name>Approve_Job</operation-name>
<job-status>denied</job-status>
<detail>Approved By User</detail>
<use-ssl-certificate>true</use-ssl-certificate>
<install-certificate>true</install-certificate>
<allow-unsigned-certificate>true</allow-unsigned-certificate>
<signature-properties mode="key-files">
<private-key-file>D:\User\ssl\BBDA_client_certs\server.key</private-key-file>
<certificate-file>D:\User\ssl\BBDA_client_certs\server.pem</certificate-file>
</signature-properties>
</bda-request>
The following figure illustrates the adapter response for the sample Approve_Job operation.
Sample adapter response for the Approve_Job operation
<bda-response>
<metadata>
<status>success</status>
</metadata>
<status-line>
<code>200</code>
<reason>OK</reason>
</status-line>
<header-lines>
<Transfer-encoding>chunked</Transfer-encoding>
<Content-type>text/html</Content-type>
</header-lines>
<message-body>
<html lang="en-US">
<head>
<title>BBDA API</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
</head>
<body>
<job-approval>
<detail>Approved By User</detail>
<result>denied</result>
</job-approval>
<h1>Accepted request</h1>
</body>
</html>
</message-body>
</bda-response>
Comments
Log in or register to comment.