REST interface for BPD-related resources - ServerAccessToken Resource - GET Method [deprecated]

Use this method to get exchange for the auth token with IAM token for the workflow server.

Sample method invocation

GET /rest/bpm/wle/v1/playback/server/{server_id}[?iam_token={string}]

Parameters

Optional parameters

Name	Value Type	Description
iam_token	string	IAM token used to obtain server access.

Request content

None

Response content

Access token for the workflow server

The default content type is application/json.

MIME type: application/json

Schema

{  "description": "WLE Server Details", 
   "type": "object",
   "properties":
   {
      "access_token": {
           "type": "string",
	       "description": "The server access token."
      }, 
      "message": {
           "type": "string",
           "description": "The server respond message."
      }
   }
}

Example content

{
  "status": "200",
  "data": {
    "accessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Im50LWVrX1FIY1JOand6SWZTUlNxcG1VeGJSQk1jZ3BpX0N2RmlZZk5haEkifQ.eyJ1c2VybmFtZSI6ImNwNGFkbWluIiwicm9sZSI6IlVzZXIiLCJwZXJtaXNzaW9ucyI6WyJjYW5fYWRtaW5pc3RyYXRlX2J1c2luZXNzX3RlYW1zIl0sImdyb3VwcyI6WzEwMDAwXSwic3ViIjoiY3A0YWRtaW4iLCJpc3MiOiJLTk9YU1NPIiwiYXVkIjoiRFNYIiwidWlkIjoiMTAwMDMzMTAwMiIsImF1dGhlbnRpY2F0b3IiOiJleHRlcm5hbCIsImlhbSI6eyJhY2Nlc3NUb2tlbiI6IkpIUHBTTkxwUUN2VHhTYW1JZ1EySUxyd2d6cXJuNWVrUDlobXlPN3dHbFRyNE5wekhqUlBxZG5tWGxNUnh6RnNtODZkT2tlRU16TUxxV05YRlBja0xhT1AycXVtbVZTVWh5ZUZ0M1lQZENPZUpsazBFNzZJdk5YbzM3dFI4cnl1SlVGWnp2dzhGWFltZlVqckN1emN4czJtNjBjRWs3aVhrNzg5T3UyZ0I5U2RuMlEzaVdvS2lSZnAyR0F4R1hzeWhBMVo0cFVzR0pqSnVnaU96WnRiTTBkR3FObmFmVEtIdlpOVFdQRGlWUk1CaVZqN0ttTnpoWHIxTWlpdHU4ZVFtdW8yWjNjQXZMQ3FXSTVQTUxvZHRGOUdVMFZ6NllNdkxGZjRSb3ZFdTA3a2Jra1VnRU1rMEVTb2tNUFVmckZFZ20wdkxKZ1JjVkxFTHB4ZmNoQzF0V205cjA0b0U4ZjFqcHNNQ2h3Sm9XMm5MMXdwcnFTNndzZ0kyWlR4QU1xbWdTUWtDaWdmSElkWWpIckt0VkY1OUlqeEVncHNpbmRwTXE5dnc5MUZJR0tLZ3RPTmk1OUJGem5taDdKTGc0RTY1dnFjZFppUGpPNENoR3llVDZNRXNHREpUT3RTS3RKaU0zRG5aT3lqZ3NmazhJQWhFTmR2In0sImRpc3BsYXlfbmFtZSI6ImNwNGFkbWluIiwiaWF0IjoxNjY5MDQ1Mjk5LCJleHAiOjE2NjkwODg0NjN9.LjM9LLYZjFSfoEBYhMuJoZ-UaRLkVP4gp7ulepVsUCxuUd6gqZi39TUHMksqSU2oikQCfOb2hssJAMloa9T3fmAnWIjgb0gxe6mVexhZebvC7wwHebNNHg1g0mLaDig9vR9r-uwISXid5SAWls-ijXFFFVplO2RQpRYBZl4JYYkjuQaQW6XTihelO01mEO56pj60gYUTKzbmki8LEHzAyUEs4eC2jDQVn1FMiWzUC--iR98_T09rMko6gTebZFOd2ZSQ28yOEBqcntEt11uTYFVqUB_je-zE8vWTvdkYgKaUmnibwdG1m7JEwshVGPAtRp-CAiHSS2mL6SsnWGXbuQ",
    "message": "success"
  }
}

MIME type: application/xml

Schema

<?xml version="1.0" encoding="UTF-8"?>
<schema 
	targetNamespace="http://rest.bpm.ibm.com/v1/data/playback"
	elementFormDefault="unqualified" 
	xmlns="http://www.w3.org/2001/XMLSchema"
	xmlns:tns="http://rest.bpm.ibm.com/v1/data/playback"
	xmlns:pref="http://rest.bpm.ibm.com/v1/data/root"> 

	<import schemaLocation="BPMRestData.xsd" namespace="http://rest.bpm.ibm.com/v1/data/root"/>
	
	<complexType name="ServerToken">
		<complexContent>
			<extension base="pref:Data">
				<sequence>
					<element name="accessToken" type="string" />
					<element name="message" type="string" />
				</sequence>
			</extension>
		</complexContent>
	</complexType>

</schema>

Example content

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<bpm:ResponseData xmlns:bpm="http://rest.bpm.ibm.com/v1/data" xmlns:ex="http://rest.bpm.ibm.com/v1/data/exception">
   <status>200</status>
   <data xsi:type="playback:ServerToken" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:playback="http://rest.bpm.ibm.com/v1/data/playback">
      <serverToken>
         <accessToken>eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Im50LWVrX1FIY1JOand6SWZTUlNxcG1VeGJSQk1jZ3BpX0N2RmlZZk5haEkifQ.eyJ1c2VybmFtZSI6ImNwNGFkbWluIiwicm9sZSI6IlVzZXIiLCJwZXJtaXNzaW9ucyI6WyJjYW5fYWRtaW5pc3RyYXRlX2J1c2luZXNzX3RlYW1zIl0sImdyb3VwcyI6WzEwMDAwXSwic3ViIjoiY3A0YWRtaW4iLCJpc3MiOiJLTk9YU1NPIiwiYXVkIjoiRFNYIiwidWlkIjoiMTAwMDMzMTAwMiIsImF1dGhlbnRpY2F0b3IiOiJleHRlcm5hbCIsImlhbSI6eyJhY2Nlc3NUb2tlbiI6IkpIUHBTTkxwUUN2VHhTYW1JZ1EySUxyd2d6cXJuNWVrUDlobXlPN3dHbFRyNE5wekhqUlBxZG5tWGxNUnh6RnNtODZkT2tlRU16TUxxV05YRlBja0xhT1AycXVtbVZTVWh5ZUZ0M1lQZENPZUpsazBFNzZJdk5YbzM3dFI4cnl1SlVGWnp2dzhGWFltZlVqckN1emN4czJtNjBjRWs3aVhrNzg5T3UyZ0I5U2RuMlEzaVdvS2lSZnAyR0F4R1hzeWhBMVo0cFVzR0pqSnVnaU96WnRiTTBkR3FObmFmVEtIdlpOVFdQRGlWUk1CaVZqN0ttTnpoWHIxTWlpdHU4ZVFtdW8yWjNjQXZMQ3FXSTVQTUxvZHRGOUdVMFZ6NllNdkxGZjRSb3ZFdTA3a2Jra1VnRU1rMEVTb2tNUFVmckZFZ20wdkxKZ1JjVkxFTHB4ZmNoQzF0V205cjA0b0U4ZjFqcHNNQ2h3Sm9XMm5MMXdwcnFTNndzZ0kyWlR4QU1xbWdTUWtDaWdmSElkWWpIckt0VkY1OUlqeEVncHNpbmRwTXE5dnc5MUZJR0tLZ3RPTmk1OUJGem5taDdKTGc0RTY1dnFjZFppUGpPNENoR3llVDZNRXNHREpUT3RTS3RKaU0zRG5aT3lqZ3NmazhJQWhFTmR2In0sImRpc3BsYXlfbmFtZSI6ImNwNGFkbWluIiwiaWF0IjoxNjY5MDQ1Mjk5LCJleHAiOjE2NjkwODg0NjN9.LjM9LLYZjFSfoEBYhMuJoZ-UaRLkVP4gp7ulepVsUCxuUd6gqZi39TUHMksqSU2oikQCfOb2hssJAMloa9T3fmAnWIjgb0gxe6mVexhZebvC7wwHebNNHg1g0mLaDig9vR9r-uwISXid5SAWls-ijXFFFVplO2RQpRYBZl4JYYkjuQaQW6XTihelO01mEO56pj60gYUTKzbmki8LEHzAyUEs4eC2jDQVn1FMiWzUC--iR98_T09rMko6gTebZFOd2ZSQ28yOEBqcntEt11uTYFVqUB_je-zE8vWTvdkYgKaUmnibwdG1m7JEwshVGPAtRp-CAiHSS2mL6SsnWGXbuQ"</accessToken>
         <message>success</message>
      </serverToken>
   </data>
</bpm:ResponseData>

MIME type: application/x-javascript

Error Response content

Detailed error information.

The default content type is application/json.

MIME type: application/json

Schema

{  "description": "WLE Error Response", 
   "type": "object",
   "properties":
   {  "status": {"type": "string",
         "description": "The status of the previous API call."
      },
      "exceptionType": {"type": "string",
         "description": "The classname associated with the exception."
      },
      "errorNumber": {"type": "string",
         "description": "Message ID of the exception."
      },
      "errorMessage": {"type": "string",
         "description": "Message text of the exception."
      },
      "errorMessageParameters": {"type": ["string"], "optional": true,
         "description":"Message text parameters of the exception."
      },
      "programmersDetails": {"type": "object", "optional": true,
         "description":"Additional exception details, for example, a stack trace."
      }
   }
}

MIME type: application/xml

Schema

<?xml version="1.0" encoding="UTF-8"?>
<schema targetNamespace="http://rest.bpm.ibm.com/v1/data/exception"
	elementFormDefault="unqualified" xmlns="http://www.w3.org/2001/XMLSchema"
	xmlns:tns="http://rest.bpm.ibm.com/v1/data/exception"
	xmlns:dat="http://rest.bpm.ibm.com/v1/data/root">

    <import schemaLocation="BPMRestData.xsd" namespace="http://rest.bpm.ibm.com/v1/data/root" />
    
    <!--
	This type represents an error response.
    -->    
    <element name="RestRuntimeException">
	<complexType>
	    <sequence>
		<element name="status" type="string"/>
		<element name="Data" type="tns:ExceptionData">
    		</element>
	    </sequence>
	</complexType>
    </element>

    <!-- 
	 This type contains detailed error information associated with an exception.
    -->
    <complexType name="ExceptionData">
	<sequence>
	    <element name="status" type="string"/>

	    <!-- This specifies the java class name of the exception -->
	    <element name="exceptionType" type="string"/>

	    <!-- The message ID of the error message -->
	    <element name="errorNumber" type="string" minOccurs="0"/>

	    <!-- The complete error message -->
	    <element name="errorMessage" type="string"/>

	    <!-- The list of strings inserted into the error message -->
	    <element name="errorMessageParameters" type="string" minOccurs="0" maxOccurs="unbounded"/>

	    <!-- 
		 The stacktrace associated with the exception.
		 Note that this will be omitted unless the "server-stacktrace-enabled" property
		 is enabled in the server's 100Custom.xml file.
	    -->     
	    <element name="programmersDetails" type="string"></element>
	    
	    <!-- Prior responses.  Set if a bulk command was used -->
	    <element name="responses" type="dat:BulkCommandResponses" minOccurs="0"></element>

            <element name="errorData" type="tns:ErrorData" minOccurs="0" />
	</sequence>
    </complexType>

    <complexType name="ErrorData">
        <sequence>
            <element name="code" type="string" />
            <element name="data" type="string" minOccurs="0" />
        </sequence>
    </complexType>
    
</schema>

MIME type: application/x-javascript

Status codes

The method returns one of the following status codes:

Code	Description
200 OK	Success completion.
400 Bad Request	The parameters are not valid or they are missing.
401 Unauthorized	The caller is not authorized for this request.
406 Not Acceptable	The requested content type or content encoding is not supported.
500 Internal Server Error	A severe problem has occurred, programmer's details are provided.

Available since

8.6.0

Parent Topic: ServerAccessToken Resource