Collaboration Capability API Reference

Collaboration

/CollaborationSet(‘{Id}’)

Deletes the collaboration for the specified collaboration ID.


/CollaborationSet(‘{Id}’)

Usage

curl -X delete "https://cpdc<account>.<host>/cpdc/odata/v1/CollaborationSet(‘{Id}’)"
DataOutputStream dataOut = null;
BufferedReader in =null;

try {

  //API endpoint
  String url = "https://cpdc<account>.<host>/cpdc/odata/v1/CollaborationSet(‘{Id}’)";
  
   URL urlObj = new URL(url);
  HttpURLConnection connection = (HttpURLConnection) urlObj.openConnection();

  connection.setRequestMethod("");
  
   //adding headers
  connection.setRequestProperty("Content-Type","application/json");
  
  connection.setRequestProperty("X-CSRF-Token","string"); //for POST , PATCH , DELETE
  
  //Basic Auth : provide username:password in Base64 encoded in Authorization header
  connection.setRequestProperty("Authorization","Basic " + "Base64 encoded value");
  
  connection.setDoInput(true);
  
  //For passing a body with request
  connection.setDoOutput(true);
  dataOut = new DataOutputStream(connection.getOutputStream());
  dataOut.writeBytes("{  \"string\": "string",  \"string\": \"string\"}");
  dataOut.flush();

  int responseCode = connection.getResponseCode();
  in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
  String inputLine;
  StringBuffer response = new StringBuffer();
  while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
  }

  //printing response
  System.out.println(response.toString());

} catch (Exception e) {
  //do something with exception
  e.printStackTrace();
} finally {
  try {
    if(dataOut != null) {
      dataOut.close();
    }
    if(in != null) {
      in.close();
    }

  } catch (IOException e) {
    //do something with exception
    e.printStackTrace();
  }
}
import io.swagger.client.api.CollaborationApi;

public class CollaborationApiExample {

    public static void main(String[] args) {
        CollaborationApi apiInstance = new CollaborationApi();
        String id = id_example; // String | ID of the collaboration to be deleted.
        try {
            apiInstance.collaborationSetIdDelete(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollaborationApi#collaborationSetIdDelete");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // ID of the collaboration to be deleted.

CollaborationApi *apiInstance = [[CollaborationApi alloc] init];

// Deletes the collaboration for the specified collaboration ID.
[apiInstance collaborationSetIdDeleteWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
//For sending body with API calls
var data = JSON.stringify({
  "context": {},
  "definitionId": "string"
});
//When no body is to be passed
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = false;

xhr.addEventListener('readystatechange', function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
	var res = this.responseText;
  }
});

//setting request method
//API endpoint for API sandbox 

xhr.open('set request method', "https://cpdc<account>.<host>/cpdc/odata/v1/CollaborationSet(‘{Id}’)");
xhr.withCredentials = true;
xhr.setRequestHeader('Content-Type', 'application/json');
xhr.setRequestHeader('Authorization', 'Basic ' + 'Base64 encoded value'));
//When X-CSRF-Token is required
xhr.setRequestHeader("X-CSRF-Token", "string");
xhr.send(data);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class collaborationSetIdDeleteExample
    {
        public void main()
        {
            
            var apiInstance = new CollaborationApi();
            var id = id_example;  // String | ID of the collaboration to be deleted.

            try
            {
                // Deletes the collaboration for the specified collaboration ID.
                apiInstance.collaborationSetIdDelete(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CollaborationApi.collaborationSetIdDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CollaborationApi();
$id = id_example; // String | ID of the collaboration to be deleted.

try {
    $api_instance->collaborationSetIdDelete($id);
} catch (Exception $e) {
    echo 'Exception when calling CollaborationApi->collaborationSetIdDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CollaborationApi;

my $api_instance = WWW::SwaggerClient::CollaborationApi->new();
my $id = id_example; # String | ID of the collaboration to be deleted.

eval { 
    $api_instance->collaborationSetIdDelete(id => $id);
};
if ($@) {
    warn "Exception when calling CollaborationApi->collaborationSetIdDelete: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CollaborationApi()
id = id_example # String | ID of the collaboration to be deleted.

try: 
    # Deletes the collaboration for the specified collaboration ID.
    api_instance.collaborationSetIdDelete(id)
except ApiException as e:
    print("Exception when calling CollaborationApi->collaborationSetIdDelete: %s\n" % e)
DATA: lo_http_client TYPE REF TO if_http_client.
DATA: response TYPE string.

CALL METHOD cl_http_client=>create_by_url
  EXPORTING
    url                = 'https://cpdc<account>.<host>/cpdc/odata/v1/CollaborationSet(‘{Id}’)'

  IMPORTING
    client             = lo_http_client
  EXCEPTIONS
    argument_not_found = 1
    plugin_not_active  = 2
    internal_error     = 3
    OTHERS             = 4.
               
IF sy-subrc <> 0.
//error handling.
ENDIF.

//setting request method.
lo_http_client->request->set_method('set request method');.

//adding headers.
lo_http_client->request->set_header_field( name = 'Content-Type' value = 'application/json' ).

//Basic Auth : provide username:password in Base64 encoded in Authorization header.
lo_http_client->request->set_header_field( name = 'Authorization' value = 'Basic Base64 encoded value' ).

//For passing body with the request.
lv_json_post_data = | \{ | &&

                    |   "string":"string", | &&

                    |   "string":"string" | &&
                    | \} |.
                    
//For request where body is to be passed.
CALL METHOD lo_http_client1->request->set_data( lv_json_post_data ).
CALL METHOD lo_http_client->send
  EXCEPTIONS
    http_communication_failure = 1
    http_invalid_state         = 2
    http_processing_failed     = 3
    http_invalid_timeout       = 4
    OTHERS                     = 5.

IF sy-subrc = 0.
  CALL METHOD lo_http_client->receive
    EXCEPTIONS
      http_communication_failure = 1
      http_invalid_state         = 2
      http_processing_failed     = 3
      OTHERS                     = 5.
ENDIF.

IF sy-subrc <> 0.
 //error handling.
ENDIF.

response = lo_http_client->response->get_cdata( ).

WRITE: 'response: ', response. 

Parameters

Path parameters
Name Description
Id*

Responses

Status: 200 - Deleted

Status: 400 - Bad Request. You provided an invalid URL.

Status: 403 - Forbidden. You do not have the required authorizations to delete the collaboration.

Status: 500 - Internal system error. Please contact technical support.


/CollaborationSet(‘{Id}’)

Updates the specified collaboration with the given values.


/CollaborationSet(‘{Id}’)

Usage

curl -X patch "https://cpdc<account>.<host>/cpdc/odata/v1/CollaborationSet(‘{Id}’)"
DataOutputStream dataOut = null;
BufferedReader in =null;

try {

  //API endpoint
  String url = "https://cpdc<account>.<host>/cpdc/odata/v1/CollaborationSet(‘{Id}’)";
  
   URL urlObj = new URL(url);
  HttpURLConnection connection = (HttpURLConnection) urlObj.openConnection();

  connection.setRequestMethod("");
  
   //adding headers
  connection.setRequestProperty("Content-Type","application/json");
  
  connection.setRequestProperty("X-CSRF-Token","string"); //for POST , PATCH , DELETE
  
  //Basic Auth : provide username:password in Base64 encoded in Authorization header
  connection.setRequestProperty("Authorization","Basic " + "Base64 encoded value");
  
  connection.setDoInput(true);
  
  //For passing a body with request
  connection.setDoOutput(true);
  dataOut = new DataOutputStream(connection.getOutputStream());
  dataOut.writeBytes("{  \"string\": "string",  \"string\": \"string\"}");
  dataOut.flush();

  int responseCode = connection.getResponseCode();
  in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
  String inputLine;
  StringBuffer response = new StringBuffer();
  while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
  }

  //printing response
  System.out.println(response.toString());

} catch (Exception e) {
  //do something with exception
  e.printStackTrace();
} finally {
  try {
    if(dataOut != null) {
      dataOut.close();
    }
    if(in != null) {
      in.close();
    }

  } catch (IOException e) {
    //do something with exception
    e.printStackTrace();
  }
}
import io.swagger.client.api.CollaborationApi;

public class CollaborationApiExample {

    public static void main(String[] args) {
        CollaborationApi apiInstance = new CollaborationApi();
        String id = id_example; // String | ID of the collaboration to be updated.
        Body_1 body = ; // Body_1 | 
        try {
            Collaboration result = apiInstance.collaborationSetIdPatch(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollaborationApi#collaborationSetIdPatch");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // ID of the collaboration to be updated.
Body_1 *body = ; // 

CollaborationApi *apiInstance = [[CollaborationApi alloc] init];

// Updates the specified collaboration with the given values.
[apiInstance collaborationSetIdPatchWith:id
    body:body
              completionHandler: ^(Collaboration output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
//For sending body with API calls
var data = JSON.stringify({
  "context": {},
  "definitionId": "string"
});
//When no body is to be passed
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = false;

xhr.addEventListener('readystatechange', function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
	var res = this.responseText;
  }
});

//setting request method
//API endpoint for API sandbox 

xhr.open('set request method', "https://cpdc<account>.<host>/cpdc/odata/v1/CollaborationSet(‘{Id}’)");
xhr.withCredentials = true;
xhr.setRequestHeader('Content-Type', 'application/json');
xhr.setRequestHeader('Authorization', 'Basic ' + 'Base64 encoded value'));
//When X-CSRF-Token is required
xhr.setRequestHeader("X-CSRF-Token", "string");
xhr.send(data);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class collaborationSetIdPatchExample
    {
        public void main()
        {
            
            var apiInstance = new CollaborationApi();
            var id = id_example;  // String | ID of the collaboration to be updated.
            var body = new Body_1(); // Body_1 | 

            try
            {
                // Updates the specified collaboration with the given values.
                Collaboration result = apiInstance.collaborationSetIdPatch(id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CollaborationApi.collaborationSetIdPatch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CollaborationApi();
$id = id_example; // String | ID of the collaboration to be updated.
$body = ; // Body_1 | 

try {
    $result = $api_instance->collaborationSetIdPatch($id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollaborationApi->collaborationSetIdPatch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CollaborationApi;

my $api_instance = WWW::SwaggerClient::CollaborationApi->new();
my $id = id_example; # String | ID of the collaboration to be updated.
my $body = WWW::SwaggerClient::Object::Body_1->new(); # Body_1 | 

eval { 
    my $result = $api_instance->collaborationSetIdPatch(id => $id, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollaborationApi->collaborationSetIdPatch: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CollaborationApi()
id = id_example # String | ID of the collaboration to be updated.
body =  # Body_1 | 

try: 
    # Updates the specified collaboration with the given values.
    api_response = api_instance.collaborationSetIdPatch(id, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CollaborationApi->collaborationSetIdPatch: %s\n" % e)
DATA: lo_http_client TYPE REF TO if_http_client.
DATA: response TYPE string.

CALL METHOD cl_http_client=>create_by_url
  EXPORTING
    url                = 'https://cpdc<account>.<host>/cpdc/odata/v1/CollaborationSet(‘{Id}’)'

  IMPORTING
    client             = lo_http_client
  EXCEPTIONS
    argument_not_found = 1
    plugin_not_active  = 2
    internal_error     = 3
    OTHERS             = 4.
               
IF sy-subrc <> 0.
//error handling.
ENDIF.

//setting request method.
lo_http_client->request->set_method('set request method');.

//adding headers.
lo_http_client->request->set_header_field( name = 'Content-Type' value = 'application/json' ).

//Basic Auth : provide username:password in Base64 encoded in Authorization header.
lo_http_client->request->set_header_field( name = 'Authorization' value = 'Basic Base64 encoded value' ).

//For passing body with the request.
lv_json_post_data = | \{ | &&

                    |   "string":"string", | &&

                    |   "string":"string" | &&
                    | \} |.
                    
//For request where body is to be passed.
CALL METHOD lo_http_client1->request->set_data( lv_json_post_data ).
CALL METHOD lo_http_client->send
  EXCEPTIONS
    http_communication_failure = 1
    http_invalid_state         = 2
    http_processing_failed     = 3
    http_invalid_timeout       = 4
    OTHERS                     = 5.

IF sy-subrc = 0.
  CALL METHOD lo_http_client->receive
    EXCEPTIONS
      http_communication_failure = 1
      http_invalid_state         = 2
      http_processing_failed     = 3
      OTHERS                     = 5.
ENDIF.

IF sy-subrc <> 0.
 //error handling.
ENDIF.

response = lo_http_client->response->get_cdata( ).

WRITE: 'response: ', response. 

Parameters

Path parameters
Name Description
Id*
Body parameters
Name Description
body *

Responses

Status: 202 - Updated

Status: 400 - Bad Request. You provided an invalid URL or a request with malformed syntax.

Status: 403 - Forbidden. You do not have the required authorizations to update the collaboration.

Status: 500 - Internal system error. Please contact technical support.


/CollaborationSet

Creates a collaboration with the specified name and description.


/CollaborationSet

Usage

curl -X post "https://cpdc<account>.<host>/cpdc/odata/v1/CollaborationSet"
DataOutputStream dataOut = null;
BufferedReader in =null;

try {

  //API endpoint
  String url = "https://cpdc<account>.<host>/cpdc/odata/v1/CollaborationSet";
  
   URL urlObj = new URL(url);
  HttpURLConnection connection = (HttpURLConnection) urlObj.openConnection();

  connection.setRequestMethod("");
  
   //adding headers
  connection.setRequestProperty("Content-Type","application/json");
  
  connection.setRequestProperty("X-CSRF-Token","string"); //for POST , PATCH , DELETE
  
  //Basic Auth : provide username:password in Base64 encoded in Authorization header
  connection.setRequestProperty("Authorization","Basic " + "Base64 encoded value");
  
  connection.setDoInput(true);
  
  //For passing a body with request
  connection.setDoOutput(true);
  dataOut = new DataOutputStream(connection.getOutputStream());
  dataOut.writeBytes("{  \"string\": "string",  \"string\": \"string\"}");
  dataOut.flush();

  int responseCode = connection.getResponseCode();
  in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
  String inputLine;
  StringBuffer response = new StringBuffer();
  while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
  }

  //printing response
  System.out.println(response.toString());

} catch (Exception e) {
  //do something with exception
  e.printStackTrace();
} finally {
  try {
    if(dataOut != null) {
      dataOut.close();
    }
    if(in != null) {
      in.close();
    }

  } catch (IOException e) {
    //do something with exception
    e.printStackTrace();
  }
}
import io.swagger.client.api.CollaborationApi;

public class CollaborationApiExample {

    public static void main(String[] args) {
        CollaborationApi apiInstance = new CollaborationApi();
        Body body = ; // Body | 
        try {
            Collaboration result = apiInstance.createCollaboration(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollaborationApi#createCollaboration");
            e.printStackTrace();
        }
    }
}
Body *body = ; // 

CollaborationApi *apiInstance = [[CollaborationApi alloc] init];

// Creates a collaboration with the specified name and description.
[apiInstance createCollaborationWith:body
              completionHandler: ^(Collaboration output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
//For sending body with API calls
var data = JSON.stringify({
  "context": {},
  "definitionId": "string"
});
//When no body is to be passed
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = false;

xhr.addEventListener('readystatechange', function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
	var res = this.responseText;
  }
});

//setting request method
//API endpoint for API sandbox 

xhr.open('set request method', "https://cpdc<account>.<host>/cpdc/odata/v1/CollaborationSet");
xhr.withCredentials = true;
xhr.setRequestHeader('Content-Type', 'application/json');
xhr.setRequestHeader('Authorization', 'Basic ' + 'Base64 encoded value'));
//When X-CSRF-Token is required
xhr.setRequestHeader("X-CSRF-Token", "string");
xhr.send(data);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createCollaborationExample
    {
        public void main()
        {
            
            var apiInstance = new CollaborationApi();
            var body = new Body(); // Body | 

            try
            {
                // Creates a collaboration with the specified name and description.
                Collaboration result = apiInstance.createCollaboration(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CollaborationApi.createCollaboration: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CollaborationApi();
$body = ; // Body | 

try {
    $result = $api_instance->createCollaboration($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollaborationApi->createCollaboration: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CollaborationApi;

my $api_instance = WWW::SwaggerClient::CollaborationApi->new();
my $body = WWW::SwaggerClient::Object::Body->new(); # Body | 

eval { 
    my $result = $api_instance->createCollaboration(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollaborationApi->createCollaboration: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CollaborationApi()
body =  # Body | 

try: 
    # Creates a collaboration with the specified name and description.
    api_response = api_instance.createCollaboration(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CollaborationApi->createCollaboration: %s\n" % e)
DATA: lo_http_client TYPE REF TO if_http_client.
DATA: response TYPE string.

CALL METHOD cl_http_client=>create_by_url
  EXPORTING
    url                = 'https://cpdc<account>.<host>/cpdc/odata/v1/CollaborationSet'

  IMPORTING
    client             = lo_http_client
  EXCEPTIONS
    argument_not_found = 1
    plugin_not_active  = 2
    internal_error     = 3
    OTHERS             = 4.
               
IF sy-subrc <> 0.
//error handling.
ENDIF.

//setting request method.
lo_http_client->request->set_method('set request method');.

//adding headers.
lo_http_client->request->set_header_field( name = 'Content-Type' value = 'application/json' ).

//Basic Auth : provide username:password in Base64 encoded in Authorization header.
lo_http_client->request->set_header_field( name = 'Authorization' value = 'Basic Base64 encoded value' ).

//For passing body with the request.
lv_json_post_data = | \{ | &&

                    |   "string":"string", | &&

                    |   "string":"string" | &&
                    | \} |.
                    
//For request where body is to be passed.
CALL METHOD lo_http_client1->request->set_data( lv_json_post_data ).
CALL METHOD lo_http_client->send
  EXCEPTIONS
    http_communication_failure = 1
    http_invalid_state         = 2
    http_processing_failed     = 3
    http_invalid_timeout       = 4
    OTHERS                     = 5.

IF sy-subrc = 0.
  CALL METHOD lo_http_client->receive
    EXCEPTIONS
      http_communication_failure = 1
      http_invalid_state         = 2
      http_processing_failed     = 3
      OTHERS                     = 5.
ENDIF.

IF sy-subrc <> 0.
 //error handling.
ENDIF.

response = lo_http_client->response->get_cdata( ).

WRITE: 'response: ', response. 

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 400 - Bad Request. You provided a request with malformed syntax.

Status: 403 - Forbidden. You do not have the required authorizations to create a collaboration.

Status: 500 - Internal system error. Please contact technical support.


/CollaborationSet

Retrieves all the collaborations for the logged in user.


/CollaborationSet

Usage

curl -X get "https://cpdc<account>.<host>/cpdc/odata/v1/CollaborationSet?$orderby=&$skip=&$top=&$inlinecount=&$filter="
DataOutputStream dataOut = null;
BufferedReader in =null;

try {

  //API endpoint
  String url = "https://cpdc<account>.<host>/cpdc/odata/v1/CollaborationSet?$orderby=&$skip=&$top=&$inlinecount=&$filter=";
  
   URL urlObj = new URL(url);
  HttpURLConnection connection = (HttpURLConnection) urlObj.openConnection();

  connection.setRequestMethod("");
  
   //adding headers
  connection.setRequestProperty("Content-Type","application/json");
  
  connection.setRequestProperty("X-CSRF-Token","string"); //for POST , PATCH , DELETE
  
  //Basic Auth : provide username:password in Base64 encoded in Authorization header
  connection.setRequestProperty("Authorization","Basic " + "Base64 encoded value");
  
  connection.setDoInput(true);
  
  //For passing a body with request
  connection.setDoOutput(true);
  dataOut = new DataOutputStream(connection.getOutputStream());
  dataOut.writeBytes("{  \"string\": "string",  \"string\": \"string\"}");
  dataOut.flush();

  int responseCode = connection.getResponseCode();
  in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
  String inputLine;
  StringBuffer response = new StringBuffer();
  while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
  }

  //printing response
  System.out.println(response.toString());

} catch (Exception e) {
  //do something with exception
  e.printStackTrace();
} finally {
  try {
    if(dataOut != null) {
      dataOut.close();
    }
    if(in != null) {
      in.close();
    }

  } catch (IOException e) {
    //do something with exception
    e.printStackTrace();
  }
}
import io.swagger.client.api.CollaborationApi;

public class CollaborationApiExample {

    public static void main(String[] args) {
        CollaborationApi apiInstance = new CollaborationApi();
        String $orderby = $orderby_example; // String | Specify the attribute you want to sort by and the order separated by a space.
        Integer $skip = 56; // Integer | Specify the number of records you want to skip from the beginning.
        Integer $top = 56; // Integer | Specify the number of records you want to show.
        String $inlinecount = $inlinecount_example; // String | Specify whether the total count of the collaborations which match the search criteria should be returned as a value of the X-Total-Count response header. Use the 'allpages' setting to enable the header or the 'none' setting to disable. The values are case-sensitive.
        String $filter = $filter_example; // String | To search the collaboration list based on the given filter parameters.
        try {
            array[Collaboration] result = apiInstance.getAllCollaboration($orderby, $skip, $top, $inlinecount, $filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollaborationApi#getAllCollaboration");
            e.printStackTrace();
        }
    }
}
String *$orderby = $orderby_example; // Specify the attribute you want to sort by and the order separated by a space. (optional)
Integer *$skip = 56; // Specify the number of records you want to skip from the beginning. (optional)
Integer *$top = 56; // Specify the number of records you want to show. (optional)
String *$inlinecount = $inlinecount_example; // Specify whether the total count of the collaborations which match the search criteria should be returned as a value of the X-Total-Count response header. Use the 'allpages' setting to enable the header or the 'none' setting to disable. The values are case-sensitive. (optional) (default to none)
String *$filter = $filter_example; // To search the collaboration list based on the given filter parameters. (optional)

CollaborationApi *apiInstance = [[CollaborationApi alloc] init];

// Retrieves all the collaborations for the logged in user.
[apiInstance getAllCollaborationWith:$orderby
    $skip:$skip
    $top:$top
    $inlinecount:$inlinecount
    $filter:$filter
              completionHandler: ^(array[Collaboration] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
//For sending body with API calls
var data = JSON.stringify({
  "context": {},
  "definitionId": "string"
});
//When no body is to be passed
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = false;

xhr.addEventListener('readystatechange', function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
	var res = this.responseText;
  }
});

//setting request method
//API endpoint for API sandbox 

xhr.open('set request method', "https://cpdc<account>.<host>/cpdc/odata/v1/CollaborationSet?$orderby=&$skip=&$top=&$inlinecount=&$filter=");
xhr.withCredentials = true;
xhr.setRequestHeader('Content-Type', 'application/json');
xhr.setRequestHeader('Authorization', 'Basic ' + 'Base64 encoded value'));
//When X-CSRF-Token is required
xhr.setRequestHeader("X-CSRF-Token", "string");
xhr.send(data);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllCollaborationExample
    {
        public void main()
        {
            
            var apiInstance = new CollaborationApi();
            var $orderby = $orderby_example;  // String | Specify the attribute you want to sort by and the order separated by a space. (optional) 
            var $skip = 56;  // Integer | Specify the number of records you want to skip from the beginning. (optional) 
            var $top = 56;  // Integer | Specify the number of records you want to show. (optional) 
            var $inlinecount = $inlinecount_example;  // String | Specify whether the total count of the collaborations which match the search criteria should be returned as a value of the X-Total-Count response header. Use the 'allpages' setting to enable the header or the 'none' setting to disable. The values are case-sensitive. (optional)  (default to none)
            var $filter = $filter_example;  // String | To search the collaboration list based on the given filter parameters. (optional) 

            try
            {
                // Retrieves all the collaborations for the logged in user.
                array[Collaboration] result = apiInstance.getAllCollaboration($orderby, $skip, $top, $inlinecount, $filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CollaborationApi.getAllCollaboration: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CollaborationApi();
$$orderby = $orderby_example; // String | Specify the attribute you want to sort by and the order separated by a space.
$$skip = 56; // Integer | Specify the number of records you want to skip from the beginning.
$$top = 56; // Integer | Specify the number of records you want to show.
$$inlinecount = $inlinecount_example; // String | Specify whether the total count of the collaborations which match the search criteria should be returned as a value of the X-Total-Count response header. Use the 'allpages' setting to enable the header or the 'none' setting to disable. The values are case-sensitive.
$$filter = $filter_example; // String | To search the collaboration list based on the given filter parameters.

try {
    $result = $api_instance->getAllCollaboration($$orderby, $$skip, $$top, $$inlinecount, $$filter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollaborationApi->getAllCollaboration: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CollaborationApi;

my $api_instance = WWW::SwaggerClient::CollaborationApi->new();
my $$orderby = $orderby_example; # String | Specify the attribute you want to sort by and the order separated by a space.
my $$skip = 56; # Integer | Specify the number of records you want to skip from the beginning.
my $$top = 56; # Integer | Specify the number of records you want to show.
my $$inlinecount = $inlinecount_example; # String | Specify whether the total count of the collaborations which match the search criteria should be returned as a value of the X-Total-Count response header. Use the 'allpages' setting to enable the header or the 'none' setting to disable. The values are case-sensitive.
my $$filter = $filter_example; # String | To search the collaboration list based on the given filter parameters.

eval { 
    my $result = $api_instance->getAllCollaboration($orderby => $$orderby, $skip => $$skip, $top => $$top, $inlinecount => $$inlinecount, $filter => $$filter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollaborationApi->getAllCollaboration: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CollaborationApi()
$orderby = $orderby_example # String | Specify the attribute you want to sort by and the order separated by a space. (optional)
$skip = 56 # Integer | Specify the number of records you want to skip from the beginning. (optional)
$top = 56 # Integer | Specify the number of records you want to show. (optional)
$inlinecount = $inlinecount_example # String | Specify whether the total count of the collaborations which match the search criteria should be returned as a value of the X-Total-Count response header. Use the 'allpages' setting to enable the header or the 'none' setting to disable. The values are case-sensitive. (optional) (default to none)
$filter = $filter_example # String | To search the collaboration list based on the given filter parameters. (optional)

try: 
    # Retrieves all the collaborations for the logged in user.
    api_response = api_instance.getAllCollaboration($orderby=$orderby, $skip=$skip, $top=$top, $inlinecount=$inlinecount, $filter=$filter)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CollaborationApi->getAllCollaboration: %s\n" % e)
DATA: lo_http_client TYPE REF TO if_http_client.
DATA: response TYPE string.

CALL METHOD cl_http_client=>create_by_url
  EXPORTING
    url                = 'https://cpdc<account>.<host>/cpdc/odata/v1/CollaborationSet?$orderby=&$skip=&$top=&$inlinecount=&$filter='

  IMPORTING
    client             = lo_http_client
  EXCEPTIONS
    argument_not_found = 1
    plugin_not_active  = 2
    internal_error     = 3
    OTHERS             = 4.
               
IF sy-subrc <> 0.
//error handling.
ENDIF.

//setting request method.
lo_http_client->request->set_method('set request method');.

//adding headers.
lo_http_client->request->set_header_field( name = 'Content-Type' value = 'application/json' ).

//Basic Auth : provide username:password in Base64 encoded in Authorization header.
lo_http_client->request->set_header_field( name = 'Authorization' value = 'Basic Base64 encoded value' ).

//For passing body with the request.
lv_json_post_data = | \{ | &&

                    |   "string":"string", | &&

                    |   "string":"string" | &&
                    | \} |.
                    
//For request where body is to be passed.
CALL METHOD lo_http_client1->request->set_data( lv_json_post_data ).
CALL METHOD lo_http_client->send
  EXCEPTIONS
    http_communication_failure = 1
    http_invalid_state         = 2
    http_processing_failed     = 3
    http_invalid_timeout       = 4
    OTHERS                     = 5.

IF sy-subrc = 0.
  CALL METHOD lo_http_client->receive
    EXCEPTIONS
      http_communication_failure = 1
      http_invalid_state         = 2
      http_processing_failed     = 3
      OTHERS                     = 5.
ENDIF.

IF sy-subrc <> 0.
 //error handling.
ENDIF.

response = lo_http_client->response->get_cdata( ).

WRITE: 'response: ', response. 

Parameters

Query parameters
Name Description
$orderby
$skip
$top
$inlinecount
$filter

Responses

Status: 200 - OK

Status: 400 - Bad Request. You provided either an invalid hostname or an invalid URL.

Status: 403 - Forbidden. You do not have the required authorizations to access the resource.

Status: 404 - Not Found. You provided an incorrect entity set.

Status: 500 - Internal system error. Please contact technical support.


/CollaborationSet(‘{Id}’)

Retrieves the collaboration for the specified collaboration ID.


/CollaborationSet(‘{Id}’)

Usage

curl -X get "https://cpdc<account>.<host>/cpdc/odata/v1/CollaborationSet(‘{Id}’)"
DataOutputStream dataOut = null;
BufferedReader in =null;

try {

  //API endpoint
  String url = "https://cpdc<account>.<host>/cpdc/odata/v1/CollaborationSet(‘{Id}’)";
  
   URL urlObj = new URL(url);
  HttpURLConnection connection = (HttpURLConnection) urlObj.openConnection();

  connection.setRequestMethod("");
  
   //adding headers
  connection.setRequestProperty("Content-Type","application/json");
  
  connection.setRequestProperty("X-CSRF-Token","string"); //for POST , PATCH , DELETE
  
  //Basic Auth : provide username:password in Base64 encoded in Authorization header
  connection.setRequestProperty("Authorization","Basic " + "Base64 encoded value");
  
  connection.setDoInput(true);
  
  //For passing a body with request
  connection.setDoOutput(true);
  dataOut = new DataOutputStream(connection.getOutputStream());
  dataOut.writeBytes("{  \"string\": "string",  \"string\": \"string\"}");
  dataOut.flush();

  int responseCode = connection.getResponseCode();
  in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
  String inputLine;
  StringBuffer response = new StringBuffer();
  while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
  }

  //printing response
  System.out.println(response.toString());

} catch (Exception e) {
  //do something with exception
  e.printStackTrace();
} finally {
  try {
    if(dataOut != null) {
      dataOut.close();
    }
    if(in != null) {
      in.close();
    }

  } catch (IOException e) {
    //do something with exception
    e.printStackTrace();
  }
}
import io.swagger.client.api.CollaborationApi;

public class CollaborationApiExample {

    public static void main(String[] args) {
        CollaborationApi apiInstance = new CollaborationApi();
        String id = id_example; // String | Collaboration ID for which the collaboration is returned.
        try {
            Collaboration result = apiInstance.getCollaboration(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollaborationApi#getCollaboration");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // Collaboration ID for which the collaboration is returned.

CollaborationApi *apiInstance = [[CollaborationApi alloc] init];

// Retrieves the collaboration for the specified collaboration ID.
[apiInstance getCollaborationWith:id
              completionHandler: ^(Collaboration output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
//For sending body with API calls
var data = JSON.stringify({
  "context": {},
  "definitionId": "string"
});
//When no body is to be passed
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = false;

xhr.addEventListener('readystatechange', function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
	var res = this.responseText;
  }
});

//setting request method
//API endpoint for API sandbox 

xhr.open('set request method', "https://cpdc<account>.<host>/cpdc/odata/v1/CollaborationSet(‘{Id}’)");
xhr.withCredentials = true;
xhr.setRequestHeader('Content-Type', 'application/json');
xhr.setRequestHeader('Authorization', 'Basic ' + 'Base64 encoded value'));
//When X-CSRF-Token is required
xhr.setRequestHeader("X-CSRF-Token", "string");
xhr.send(data);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCollaborationExample
    {
        public void main()
        {
            
            var apiInstance = new CollaborationApi();
            var id = id_example;  // String | Collaboration ID for which the collaboration is returned.

            try
            {
                // Retrieves the collaboration for the specified collaboration ID.
                Collaboration result = apiInstance.getCollaboration(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CollaborationApi.getCollaboration: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CollaborationApi();
$id = id_example; // String | Collaboration ID for which the collaboration is returned.

try {
    $result = $api_instance->getCollaboration($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollaborationApi->getCollaboration: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CollaborationApi;

my $api_instance = WWW::SwaggerClient::CollaborationApi->new();
my $id = id_example; # String | Collaboration ID for which the collaboration is returned.

eval { 
    my $result = $api_instance->getCollaboration(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollaborationApi->getCollaboration: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CollaborationApi()
id = id_example # String | Collaboration ID for which the collaboration is returned.

try: 
    # Retrieves the collaboration for the specified collaboration ID.
    api_response = api_instance.getCollaboration(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CollaborationApi->getCollaboration: %s\n" % e)
DATA: lo_http_client TYPE REF TO if_http_client.
DATA: response TYPE string.

CALL METHOD cl_http_client=>create_by_url
  EXPORTING
    url                = 'https://cpdc<account>.<host>/cpdc/odata/v1/CollaborationSet(‘{Id}’)'

  IMPORTING
    client             = lo_http_client
  EXCEPTIONS
    argument_not_found = 1
    plugin_not_active  = 2
    internal_error     = 3
    OTHERS             = 4.
               
IF sy-subrc <> 0.
//error handling.
ENDIF.

//setting request method.
lo_http_client->request->set_method('set request method');.

//adding headers.
lo_http_client->request->set_header_field( name = 'Content-Type' value = 'application/json' ).

//Basic Auth : provide username:password in Base64 encoded in Authorization header.
lo_http_client->request->set_header_field( name = 'Authorization' value = 'Basic Base64 encoded value' ).

//For passing body with the request.
lv_json_post_data = | \{ | &&

                    |   "string":"string", | &&

                    |   "string":"string" | &&
                    | \} |.
                    
//For request where body is to be passed.
CALL METHOD lo_http_client1->request->set_data( lv_json_post_data ).
CALL METHOD lo_http_client->send
  EXCEPTIONS
    http_communication_failure = 1
    http_invalid_state         = 2
    http_processing_failed     = 3
    http_invalid_timeout       = 4
    OTHERS                     = 5.

IF sy-subrc = 0.
  CALL METHOD lo_http_client->receive
    EXCEPTIONS
      http_communication_failure = 1
      http_invalid_state         = 2
      http_processing_failed     = 3
      OTHERS                     = 5.
ENDIF.

IF sy-subrc <> 0.
 //error handling.
ENDIF.

response = lo_http_client->response->get_cdata( ).

WRITE: 'response: ', response. 

Parameters

Path parameters
Name Description
Id*

Responses

Status: 200 - OK

Status: 400 - Bad Request. You provided either an invalid hostname or an invalid URL.

Status: 403 - Forbidden. You do not have the required authorizations to access the resource.

Status: 404 - Not Found. You provided either an incorrect collaboration ID or an incorrect entity set.

Status: 500 - Internal system error. Please contact technical support.


Participant

/CollaborationSet(‘{Id}’)/Contributors

Retrieves all the participants for the specified collaboration ID.


/CollaborationSet(‘{Id}’)/Contributors

Usage

curl -X get "https://cpdc<account>.<host>/cpdc/odata/v1/CollaborationSet(‘{Id}’)/Contributors"
DataOutputStream dataOut = null;
BufferedReader in =null;

try {

  //API endpoint
  String url = "https://cpdc<account>.<host>/cpdc/odata/v1/CollaborationSet(‘{Id}’)/Contributors";
  
   URL urlObj = new URL(url);
  HttpURLConnection connection = (HttpURLConnection) urlObj.openConnection();

  connection.setRequestMethod("");
  
   //adding headers
  connection.setRequestProperty("Content-Type","application/json");
  
  connection.setRequestProperty("X-CSRF-Token","string"); //for POST , PATCH , DELETE
  
  //Basic Auth : provide username:password in Base64 encoded in Authorization header
  connection.setRequestProperty("Authorization","Basic " + "Base64 encoded value");
  
  connection.setDoInput(true);
  
  //For passing a body with request
  connection.setDoOutput(true);
  dataOut = new DataOutputStream(connection.getOutputStream());
  dataOut.writeBytes("{  \"string\": "string",  \"string\": \"string\"}");
  dataOut.flush();

  int responseCode = connection.getResponseCode();
  in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
  String inputLine;
  StringBuffer response = new StringBuffer();
  while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
  }

  //printing response
  System.out.println(response.toString());

} catch (Exception e) {
  //do something with exception
  e.printStackTrace();
} finally {
  try {
    if(dataOut != null) {
      dataOut.close();
    }
    if(in != null) {
      in.close();
    }

  } catch (IOException e) {
    //do something with exception
    e.printStackTrace();
  }
}
import io.swagger.client.api.ParticipantApi;

public class ParticipantApiExample {

    public static void main(String[] args) {
        ParticipantApi apiInstance = new ParticipantApi();
        String id = id_example; // String | ID of the collaboration for which the list of participants is returned.
        try {
            array[Participant] result = apiInstance.collaborationSetIdContributorsGet(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParticipantApi#collaborationSetIdContributorsGet");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // ID of the collaboration for which the list of participants is returned.

ParticipantApi *apiInstance = [[ParticipantApi alloc] init];

// Retrieves all the participants for the specified collaboration ID.
[apiInstance collaborationSetIdContributorsGetWith:id
              completionHandler: ^(array[Participant] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
//For sending body with API calls
var data = JSON.stringify({
  "context": {},
  "definitionId": "string"
});
//When no body is to be passed
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = false;

xhr.addEventListener('readystatechange', function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
	var res = this.responseText;
  }
});

//setting request method
//API endpoint for API sandbox 

xhr.open('set request method', "https://cpdc<account>.<host>/cpdc/odata/v1/CollaborationSet(‘{Id}’)/Contributors");
xhr.withCredentials = true;
xhr.setRequestHeader('Content-Type', 'application/json');
xhr.setRequestHeader('Authorization', 'Basic ' + 'Base64 encoded value'));
//When X-CSRF-Token is required
xhr.setRequestHeader("X-CSRF-Token", "string");
xhr.send(data);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class collaborationSetIdContributorsGetExample
    {
        public void main()
        {
            
            var apiInstance = new ParticipantApi();
            var id = id_example;  // String | ID of the collaboration for which the list of participants is returned.

            try
            {
                // Retrieves all the participants for the specified collaboration ID.
                array[Participant] result = apiInstance.collaborationSetIdContributorsGet(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ParticipantApi.collaborationSetIdContributorsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ParticipantApi();
$id = id_example; // String | ID of the collaboration for which the list of participants is returned.

try {
    $result = $api_instance->collaborationSetIdContributorsGet($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ParticipantApi->collaborationSetIdContributorsGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ParticipantApi;

my $api_instance = WWW::SwaggerClient::ParticipantApi->new();
my $id = id_example; # String | ID of the collaboration for which the list of participants is returned.

eval { 
    my $result = $api_instance->collaborationSetIdContributorsGet(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ParticipantApi->collaborationSetIdContributorsGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ParticipantApi()
id = id_example # String | ID of the collaboration for which the list of participants is returned.

try: 
    # Retrieves all the participants for the specified collaboration ID.
    api_response = api_instance.collaborationSetIdContributorsGet(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ParticipantApi->collaborationSetIdContributorsGet: %s\n" % e)
DATA: lo_http_client TYPE REF TO if_http_client.
DATA: response TYPE string.

CALL METHOD cl_http_client=>create_by_url
  EXPORTING
    url                = 'https://cpdc<account>.<host>/cpdc/odata/v1/CollaborationSet(‘{Id}’)/Contributors'

  IMPORTING
    client             = lo_http_client
  EXCEPTIONS
    argument_not_found = 1
    plugin_not_active  = 2
    internal_error     = 3
    OTHERS             = 4.
               
IF sy-subrc <> 0.
//error handling.
ENDIF.

//setting request method.
lo_http_client->request->set_method('set request method');.

//adding headers.
lo_http_client->request->set_header_field( name = 'Content-Type' value = 'application/json' ).

//Basic Auth : provide username:password in Base64 encoded in Authorization header.
lo_http_client->request->set_header_field( name = 'Authorization' value = 'Basic Base64 encoded value' ).

//For passing body with the request.
lv_json_post_data = | \{ | &&

                    |   "string":"string", | &&

                    |   "string":"string" | &&
                    | \} |.
                    
//For request where body is to be passed.
CALL METHOD lo_http_client1->request->set_data( lv_json_post_data ).
CALL METHOD lo_http_client->send
  EXCEPTIONS
    http_communication_failure = 1
    http_invalid_state         = 2
    http_processing_failed     = 3
    http_invalid_timeout       = 4
    OTHERS                     = 5.

IF sy-subrc = 0.
  CALL METHOD lo_http_client->receive
    EXCEPTIONS
      http_communication_failure = 1
      http_invalid_state         = 2
      http_processing_failed     = 3
      OTHERS                     = 5.
ENDIF.

IF sy-subrc <> 0.
 //error handling.
ENDIF.

response = lo_http_client->response->get_cdata( ).

WRITE: 'response: ', response. 

Parameters

Path parameters
Name Description
Id*

Responses

Status: 200 - OK

Status: 400 - Bad Request. You provided an invalid URL.

Status: 403 - Forbidden. You do not have the required authorizations to access the resource.

Status: 404 - Not Found. You provided either an incorrect collaboration ID or an incorrect entity set.

Status: 500 - Internal system error. Please contact technical support.


/CollaborationSet(‘{Id}’)/Contributors

Adds the list of specified participants to the specified collaboration.

You can add a maximum of 20 participants at a time.<br> A CSRF token must be supplied for this operation. Refer to the XCSRFTokenHandling API


/CollaborationSet(‘{Id}’)/Contributors

Usage

curl -X post "https://cpdc<account>.<host>/cpdc/odata/v1/CollaborationSet(‘{Id}’)/Contributors"
DataOutputStream dataOut = null;
BufferedReader in =null;

try {

  //API endpoint
  String url = "https://cpdc<account>.<host>/cpdc/odata/v1/CollaborationSet(‘{Id}’)/Contributors";
  
   URL urlObj = new URL(url);
  HttpURLConnection connection = (HttpURLConnection) urlObj.openConnection();

  connection.setRequestMethod("");
  
   //adding headers
  connection.setRequestProperty("Content-Type","application/json");
  
  connection.setRequestProperty("X-CSRF-Token","string"); //for POST , PATCH , DELETE
  
  //Basic Auth : provide username:password in Base64 encoded in Authorization header
  connection.setRequestProperty("Authorization","Basic " + "Base64 encoded value");
  
  connection.setDoInput(true);
  
  //For passing a body with request
  connection.setDoOutput(true);
  dataOut = new DataOutputStream(connection.getOutputStream());
  dataOut.writeBytes("{  \"string\": "string",  \"string\": \"string\"}");
  dataOut.flush();

  int responseCode = connection.getResponseCode();
  in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
  String inputLine;
  StringBuffer response = new StringBuffer();
  while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
  }

  //printing response
  System.out.println(response.toString());

} catch (Exception e) {
  //do something with exception
  e.printStackTrace();
} finally {
  try {
    if(dataOut != null) {
      dataOut.close();
    }
    if(in != null) {
      in.close();
    }

  } catch (IOException e) {
    //do something with exception
    e.printStackTrace();
  }
}
import io.swagger.client.api.ParticipantApi;

public class ParticipantApiExample {

    public static void main(String[] args) {
        ParticipantApi apiInstance = new ParticipantApi();
        String id = id_example; // String | ID of the collaboration to which the participant needs to be added.
        array[ParticipantsRequest] body = ; // array[ParticipantsRequest] | 
        Boolean sendmail = true; // Boolean | When adding participants to the collaboration, if the value of the header is 'false', mails are not sent to the participants. The default value is 'true' which means mails are sent to the participants
        try {
            array[Participant] result = apiInstance.collaborationSetIdContributorsPost(id, body, sendmail);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParticipantApi#collaborationSetIdContributorsPost");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // ID of the collaboration to which the participant needs to be added.
array[ParticipantsRequest] *body = ; // 
Boolean *sendmail = true; // When adding participants to the collaboration, if the value of the header is 'false', mails are not sent to the participants. The default value is 'true' which means mails are sent to the participants (optional)

ParticipantApi *apiInstance = [[ParticipantApi alloc] init];

// Adds the list of specified participants to the specified collaboration.
[apiInstance collaborationSetIdContributorsPostWith:id
    body:body
    sendmail:sendmail
              completionHandler: ^(array[Participant] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
//For sending body with API calls
var data = JSON.stringify({
  "context": {},
  "definitionId": "string"
});
//When no body is to be passed
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = false;

xhr.addEventListener('readystatechange', function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
	var res = this.responseText;
  }
});

//setting request method
//API endpoint for API sandbox 

xhr.open('set request method', "https://cpdc<account>.<host>/cpdc/odata/v1/CollaborationSet(‘{Id}’)/Contributors");
xhr.withCredentials = true;
xhr.setRequestHeader('Content-Type', 'application/json');
xhr.setRequestHeader('Authorization', 'Basic ' + 'Base64 encoded value'));
//When X-CSRF-Token is required
xhr.setRequestHeader("X-CSRF-Token", "string");
xhr.send(data);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class collaborationSetIdContributorsPostExample
    {
        public void main()
        {
            
            var apiInstance = new ParticipantApi();
            var id = id_example;  // String | ID of the collaboration to which the participant needs to be added.
            var body = new array[ParticipantsRequest](); // array[ParticipantsRequest] | 
            var sendmail = true;  // Boolean | When adding participants to the collaboration, if the value of the header is 'false', mails are not sent to the participants. The default value is 'true' which means mails are sent to the participants (optional) 

            try
            {
                // Adds the list of specified participants to the specified collaboration.
                array[Participant] result = apiInstance.collaborationSetIdContributorsPost(id, body, sendmail);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ParticipantApi.collaborationSetIdContributorsPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ParticipantApi();
$id = id_example; // String | ID of the collaboration to which the participant needs to be added.
$body = ; // array[ParticipantsRequest] | 
$sendmail = true; // Boolean | When adding participants to the collaboration, if the value of the header is 'false', mails are not sent to the participants. The default value is 'true' which means mails are sent to the participants

try {
    $result = $api_instance->collaborationSetIdContributorsPost($id, $body, $sendmail);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ParticipantApi->collaborationSetIdContributorsPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ParticipantApi;

my $api_instance = WWW::SwaggerClient::ParticipantApi->new();
my $id = id_example; # String | ID of the collaboration to which the participant needs to be added.
my $body = [WWW::SwaggerClient::Object::array[ParticipantsRequest]->new()]; # array[ParticipantsRequest] | 
my $sendmail = true; # Boolean | When adding participants to the collaboration, if the value of the header is 'false', mails are not sent to the participants. The default value is 'true' which means mails are sent to the participants

eval { 
    my $result = $api_instance->collaborationSetIdContributorsPost(id => $id, body => $body, sendmail => $sendmail);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ParticipantApi->collaborationSetIdContributorsPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ParticipantApi()
id = id_example # String | ID of the collaboration to which the participant needs to be added.
body =  # array[ParticipantsRequest] | 
sendmail = true # Boolean | When adding participants to the collaboration, if the value of the header is 'false', mails are not sent to the participants. The default value is 'true' which means mails are sent to the participants (optional)

try: 
    # Adds the list of specified participants to the specified collaboration.
    api_response = api_instance.collaborationSetIdContributorsPost(id, body, sendmail=sendmail)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ParticipantApi->collaborationSetIdContributorsPost: %s\n" % e)
DATA: lo_http_client TYPE REF TO if_http_client.
DATA: response TYPE string.

CALL METHOD cl_http_client=>create_by_url
  EXPORTING
    url                = 'https://cpdc<account>.<host>/cpdc/odata/v1/CollaborationSet(‘{Id}’)/Contributors'

  IMPORTING
    client             = lo_http_client
  EXCEPTIONS
    argument_not_found = 1
    plugin_not_active  = 2
    internal_error     = 3
    OTHERS             = 4.
               
IF sy-subrc <> 0.
//error handling.
ENDIF.

//setting request method.
lo_http_client->request->set_method('set request method');.

//adding headers.
lo_http_client->request->set_header_field( name = 'Content-Type' value = 'application/json' ).

//Basic Auth : provide username:password in Base64 encoded in Authorization header.
lo_http_client->request->set_header_field( name = 'Authorization' value = 'Basic Base64 encoded value' ).

//For passing body with the request.
lv_json_post_data = | \{ | &&

                    |   "string":"string", | &&

                    |   "string":"string" | &&
                    | \} |.
                    
//For request where body is to be passed.
CALL METHOD lo_http_client1->request->set_data( lv_json_post_data ).
CALL METHOD lo_http_client->send
  EXCEPTIONS
    http_communication_failure = 1
    http_invalid_state         = 2
    http_processing_failed     = 3
    http_invalid_timeout       = 4
    OTHERS                     = 5.

IF sy-subrc = 0.
  CALL METHOD lo_http_client->receive
    EXCEPTIONS
      http_communication_failure = 1
      http_invalid_state         = 2
      http_processing_failed     = 3
      OTHERS                     = 5.
ENDIF.

IF sy-subrc <> 0.
 //error handling.
ENDIF.

response = lo_http_client->response->get_cdata( ).

WRITE: 'response: ', response. 

Parameters

Path parameters
Name Description
Id*
Header parameters
Name Description
sendmail
Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 400 - Bad Request. You provided an invalid URL or a request with malformed syntax.

Status: 403 - Forbidden. You do not have the required authorizations to perform the operation.

Status: 500 - Internal system error. Please contact technical support.


/ContributorSet(Id=‘{ContributorId}’,CollaborationId=‘{CollaborationId}’)

Removes the specified participant from the collaboration.


/ContributorSet(Id=‘{ContributorId}’,CollaborationId=‘{CollaborationId}’)

Usage

curl -X delete "https://cpdc<account>.<host>/cpdc/odata/v1/ContributorSet(Id=‘{ContributorId}’,CollaborationId=‘{CollaborationId}’)"
DataOutputStream dataOut = null;
BufferedReader in =null;

try {

  //API endpoint
  String url = "https://cpdc<account>.<host>/cpdc/odata/v1/ContributorSet(Id=‘{ContributorId}’,CollaborationId=‘{CollaborationId}’)";
  
   URL urlObj = new URL(url);
  HttpURLConnection connection = (HttpURLConnection) urlObj.openConnection();

  connection.setRequestMethod("");
  
   //adding headers
  connection.setRequestProperty("Content-Type","application/json");
  
  connection.setRequestProperty("X-CSRF-Token","string"); //for POST , PATCH , DELETE
  
  //Basic Auth : provide username:password in Base64 encoded in Authorization header
  connection.setRequestProperty("Authorization","Basic " + "Base64 encoded value");
  
  connection.setDoInput(true);
  
  //For passing a body with request
  connection.setDoOutput(true);
  dataOut = new DataOutputStream(connection.getOutputStream());
  dataOut.writeBytes("{  \"string\": "string",  \"string\": \"string\"}");
  dataOut.flush();

  int responseCode = connection.getResponseCode();
  in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
  String inputLine;
  StringBuffer response = new StringBuffer();
  while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
  }

  //printing response
  System.out.println(response.toString());

} catch (Exception e) {
  //do something with exception
  e.printStackTrace();
} finally {
  try {
    if(dataOut != null) {
      dataOut.close();
    }
    if(in != null) {
      in.close();
    }

  } catch (IOException e) {
    //do something with exception
    e.printStackTrace();
  }
}
import io.swagger.client.api.ParticipantApi;

public class ParticipantApiExample {

    public static void main(String[] args) {
        ParticipantApi apiInstance = new ParticipantApi();
        String contributorId = contributorId_example; // String | ID or email ID of the participant to be removed.
        String collaborationId = collaborationId_example; // String | ID of the collaboration.
        try {
            apiInstance.contributorSetIdContributorIdCollaborationIdCollaborationIdDelete(contributorId, collaborationId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParticipantApi#contributorSetIdContributorIdCollaborationIdCollaborationIdDelete");
            e.printStackTrace();
        }
    }
}
String *contributorId = contributorId_example; // ID or email ID of the participant to be removed.
String *collaborationId = collaborationId_example; // ID of the collaboration.

ParticipantApi *apiInstance = [[ParticipantApi alloc] init];

// 
[apiInstance contributorSetIdContributorIdCollaborationIdCollaborationIdDeleteWith:contributorId
    collaborationId:collaborationId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
//For sending body with API calls
var data = JSON.stringify({
  "context": {},
  "definitionId": "string"
});
//When no body is to be passed
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = false;

xhr.addEventListener('readystatechange', function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
	var res = this.responseText;
  }
});

//setting request method
//API endpoint for API sandbox 

xhr.open('set request method', "https://cpdc<account>.<host>/cpdc/odata/v1/ContributorSet(Id=‘{ContributorId}’,CollaborationId=‘{CollaborationId}’)");
xhr.withCredentials = true;
xhr.setRequestHeader('Content-Type', 'application/json');
xhr.setRequestHeader('Authorization', 'Basic ' + 'Base64 encoded value'));
//When X-CSRF-Token is required
xhr.setRequestHeader("X-CSRF-Token", "string");
xhr.send(data);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class contributorSetIdContributorIdCollaborationIdCollaborationIdDeleteExample
    {
        public void main()
        {
            
            var apiInstance = new ParticipantApi();
            var contributorId = contributorId_example;  // String | ID or email ID of the participant to be removed.
            var collaborationId = collaborationId_example;  // String | ID of the collaboration.

            try
            {
                // 
                apiInstance.contributorSetIdContributorIdCollaborationIdCollaborationIdDelete(contributorId, collaborationId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ParticipantApi.contributorSetIdContributorIdCollaborationIdCollaborationIdDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ParticipantApi();
$contributorId = contributorId_example; // String | ID or email ID of the participant to be removed.
$collaborationId = collaborationId_example; // String | ID of the collaboration.

try {
    $api_instance->contributorSetIdContributorIdCollaborationIdCollaborationIdDelete($contributorId, $collaborationId);
} catch (Exception $e) {
    echo 'Exception when calling ParticipantApi->contributorSetIdContributorIdCollaborationIdCollaborationIdDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ParticipantApi;

my $api_instance = WWW::SwaggerClient::ParticipantApi->new();
my $contributorId = contributorId_example; # String | ID or email ID of the participant to be removed.
my $collaborationId = collaborationId_example; # String | ID of the collaboration.

eval { 
    $api_instance->contributorSetIdContributorIdCollaborationIdCollaborationIdDelete(contributorId => $contributorId, collaborationId => $collaborationId);
};
if ($@) {
    warn "Exception when calling ParticipantApi->contributorSetIdContributorIdCollaborationIdCollaborationIdDelete: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ParticipantApi()
contributorId = contributorId_example # String | ID or email ID of the participant to be removed.
collaborationId = collaborationId_example # String | ID of the collaboration.

try: 
    # 
    api_instance.contributorSetIdContributorIdCollaborationIdCollaborationIdDelete(contributorId, collaborationId)
except ApiException as e:
    print("Exception when calling ParticipantApi->contributorSetIdContributorIdCollaborationIdCollaborationIdDelete: %s\n" % e)
DATA: lo_http_client TYPE REF TO if_http_client.
DATA: response TYPE string.

CALL METHOD cl_http_client=>create_by_url
  EXPORTING
    url                = 'https://cpdc<account>.<host>/cpdc/odata/v1/ContributorSet(Id=‘{ContributorId}’,CollaborationId=‘{CollaborationId}’)'

  IMPORTING
    client             = lo_http_client
  EXCEPTIONS
    argument_not_found = 1
    plugin_not_active  = 2
    internal_error     = 3
    OTHERS             = 4.
               
IF sy-subrc <> 0.
//error handling.
ENDIF.

//setting request method.
lo_http_client->request->set_method('set request method');.

//adding headers.
lo_http_client->request->set_header_field( name = 'Content-Type' value = 'application/json' ).

//Basic Auth : provide username:password in Base64 encoded in Authorization header.
lo_http_client->request->set_header_field( name = 'Authorization' value = 'Basic Base64 encoded value' ).

//For passing body with the request.
lv_json_post_data = | \{ | &&

                    |   "string":"string", | &&

                    |   "string":"string" | &&
                    | \} |.
                    
//For request where body is to be passed.
CALL METHOD lo_http_client1->request->set_data( lv_json_post_data ).
CALL METHOD lo_http_client->send
  EXCEPTIONS
    http_communication_failure = 1
    http_invalid_state         = 2
    http_processing_failed     = 3
    http_invalid_timeout       = 4
    OTHERS                     = 5.

IF sy-subrc = 0.
  CALL METHOD lo_http_client->receive
    EXCEPTIONS
      http_communication_failure = 1
      http_invalid_state         = 2
      http_processing_failed     = 3
      OTHERS                     = 5.
ENDIF.

IF sy-subrc <> 0.
 //error handling.
ENDIF.

response = lo_http_client->response->get_cdata( ).

WRITE: 'response: ', response. 

Parameters

Path parameters
Name Description
ContributorId*
CollaborationId*

Responses

Status: 200 - Deleted

Status: 400 - Bad Request. You provided an invalid URL.

Status: 403 - Forbidden. You do not have the required authorizations to perform the operation.

Status: 500 - Internal system error. Please contact technical support.


/ContributorSet(Id=‘{ContributorId}’,CollaborationId=‘{CollaborationId}’)

Updates the permissions of the specified participant in the collaboration.


/ContributorSet(Id=‘{ContributorId}’,CollaborationId=‘{CollaborationId}’)

Usage

curl -X patch "https://cpdc<account>.<host>/cpdc/odata/v1/ContributorSet(Id=‘{ContributorId}’,CollaborationId=‘{CollaborationId}’)"
DataOutputStream dataOut = null;
BufferedReader in =null;

try {

  //API endpoint
  String url = "https://cpdc<account>.<host>/cpdc/odata/v1/ContributorSet(Id=‘{ContributorId}’,CollaborationId=‘{CollaborationId}’)";
  
   URL urlObj = new URL(url);
  HttpURLConnection connection = (HttpURLConnection) urlObj.openConnection();

  connection.setRequestMethod("");
  
   //adding headers
  connection.setRequestProperty("Content-Type","application/json");
  
  connection.setRequestProperty("X-CSRF-Token","string"); //for POST , PATCH , DELETE
  
  //Basic Auth : provide username:password in Base64 encoded in Authorization header
  connection.setRequestProperty("Authorization","Basic " + "Base64 encoded value");
  
  connection.setDoInput(true);
  
  //For passing a body with request
  connection.setDoOutput(true);
  dataOut = new DataOutputStream(connection.getOutputStream());
  dataOut.writeBytes("{  \"string\": "string",  \"string\": \"string\"}");
  dataOut.flush();

  int responseCode = connection.getResponseCode();
  in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
  String inputLine;
  StringBuffer response = new StringBuffer();
  while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
  }

  //printing response
  System.out.println(response.toString());

} catch (Exception e) {
  //do something with exception
  e.printStackTrace();
} finally {
  try {
    if(dataOut != null) {
      dataOut.close();
    }
    if(in != null) {
      in.close();
    }

  } catch (IOException e) {
    //do something with exception
    e.printStackTrace();
  }
}
import io.swagger.client.api.ParticipantApi;

public class ParticipantApiExample {

    public static void main(String[] args) {
        ParticipantApi apiInstance = new ParticipantApi();
        String contributorId = contributorId_example; // String | ID or email ID of the participant to be updated.
        String collaborationId = collaborationId_example; // String | ID of the collaboration.
        Body_2 body = ; // Body_2 | 
        try {
            Participant result = apiInstance.contributorSetIdContributorIdCollaborationIdCollaborationIdPatch(contributorId, collaborationId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParticipantApi#contributorSetIdContributorIdCollaborationIdCollaborationIdPatch");
            e.printStackTrace();
        }
    }
}
String *contributorId = contributorId_example; // ID or email ID of the participant to be updated.
String *collaborationId = collaborationId_example; // ID of the collaboration.
Body_2 *body = ; // 

ParticipantApi *apiInstance = [[ParticipantApi alloc] init];

// 
[apiInstance contributorSetIdContributorIdCollaborationIdCollaborationIdPatchWith:contributorId
    collaborationId:collaborationId
    body:body
              completionHandler: ^(Participant output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
//For sending body with API calls
var data = JSON.stringify({
  "context": {},
  "definitionId": "string"
});
//When no body is to be passed
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = false;

xhr.addEventListener('readystatechange', function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
	var res = this.responseText;
  }
});

//setting request method
//API endpoint for API sandbox 

xhr.open('set request method', "https://cpdc<account>.<host>/cpdc/odata/v1/ContributorSet(Id=‘{ContributorId}’,CollaborationId=‘{CollaborationId}’)");
xhr.withCredentials = true;
xhr.setRequestHeader('Content-Type', 'application/json');
xhr.setRequestHeader('Authorization', 'Basic ' + 'Base64 encoded value'));
//When X-CSRF-Token is required
xhr.setRequestHeader("X-CSRF-Token", "string");
xhr.send(data);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class contributorSetIdContributorIdCollaborationIdCollaborationIdPatchExample
    {
        public void main()
        {
            
            var apiInstance = new ParticipantApi();
            var contributorId = contributorId_example;  // String | ID or email ID of the participant to be updated.
            var collaborationId = collaborationId_example;  // String | ID of the collaboration.
            var body = new Body_2(); // Body_2 | 

            try
            {
                // 
                Participant result = apiInstance.contributorSetIdContributorIdCollaborationIdCollaborationIdPatch(contributorId, collaborationId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ParticipantApi.contributorSetIdContributorIdCollaborationIdCollaborationIdPatch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ParticipantApi();
$contributorId = contributorId_example; // String | ID or email ID of the participant to be updated.
$collaborationId = collaborationId_example; // String | ID of the collaboration.
$body = ; // Body_2 | 

try {
    $result = $api_instance->contributorSetIdContributorIdCollaborationIdCollaborationIdPatch($contributorId, $collaborationId, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ParticipantApi->contributorSetIdContributorIdCollaborationIdCollaborationIdPatch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ParticipantApi;

my $api_instance = WWW::SwaggerClient::ParticipantApi->new();
my $contributorId = contributorId_example; # String | ID or email ID of the participant to be updated.
my $collaborationId = collaborationId_example; # String | ID of the collaboration.
my $body = WWW::SwaggerClient::Object::Body_2->new(); # Body_2 | 

eval { 
    my $result = $api_instance->contributorSetIdContributorIdCollaborationIdCollaborationIdPatch(contributorId => $contributorId, collaborationId => $collaborationId, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ParticipantApi->contributorSetIdContributorIdCollaborationIdCollaborationIdPatch: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ParticipantApi()
contributorId = contributorId_example # String | ID or email ID of the participant to be updated.
collaborationId = collaborationId_example # String | ID of the collaboration.
body =  # Body_2 | 

try: 
    # 
    api_response = api_instance.contributorSetIdContributorIdCollaborationIdCollaborationIdPatch(contributorId, collaborationId, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ParticipantApi->contributorSetIdContributorIdCollaborationIdCollaborationIdPatch: %s\n" % e)
DATA: lo_http_client TYPE REF TO if_http_client.
DATA: response TYPE string.

CALL METHOD cl_http_client=>create_by_url
  EXPORTING
    url                = 'https://cpdc<account>.<host>/cpdc/odata/v1/ContributorSet(Id=‘{ContributorId}’,CollaborationId=‘{CollaborationId}’)'

  IMPORTING
    client             = lo_http_client
  EXCEPTIONS
    argument_not_found = 1
    plugin_not_active  = 2
    internal_error     = 3
    OTHERS             = 4.
               
IF sy-subrc <> 0.
//error handling.
ENDIF.

//setting request method.
lo_http_client->request->set_method('set request method');.

//adding headers.
lo_http_client->request->set_header_field( name = 'Content-Type' value = 'application/json' ).

//Basic Auth : provide username:password in Base64 encoded in Authorization header.
lo_http_client->request->set_header_field( name = 'Authorization' value = 'Basic Base64 encoded value' ).

//For passing body with the request.
lv_json_post_data = | \{ | &&

                    |   "string":"string", | &&

                    |   "string":"string" | &&
                    | \} |.
                    
//For request where body is to be passed.
CALL METHOD lo_http_client1->request->set_data( lv_json_post_data ).
CALL METHOD lo_http_client->send
  EXCEPTIONS
    http_communication_failure = 1
    http_invalid_state         = 2
    http_processing_failed     = 3
    http_invalid_timeout       = 4
    OTHERS                     = 5.

IF sy-subrc = 0.
  CALL METHOD lo_http_client->receive
    EXCEPTIONS
      http_communication_failure = 1
      http_invalid_state         = 2
      http_processing_failed     = 3
      OTHERS                     = 5.
ENDIF.

IF sy-subrc <> 0.
 //error handling.
ENDIF.

response = lo_http_client->response->get_cdata( ).

WRITE: 'response: ', response. 

Parameters

Path parameters
Name Description
ContributorId*
CollaborationId*
Body parameters
Name Description
body *

Responses

Status: 202 - Updated

Status: 400 - Bad Request. You provided an invalid URL or a request with malformed syntax.

Status: 403 - Forbidden. You do not have the required authorizations to perform the operation.

Status: 500 - Internal system error. Please contact technical support.


ProductData

/ObjectTypeSet(ObjectTypeId=‘{ObjectTypeId}’,CollaborationId=‘{CollaborationId}’)/CollaborationObjects

Prerequisite - Before using this API method, configure a system and an object using the Configure Product Data app.<br> You can then add the specified product data to the specified collaboration ID.


/ObjectTypeSet(ObjectTypeId=‘{ObjectTypeId}’,CollaborationId=‘{CollaborationId}’)/CollaborationObjects

Usage

curl -X post "https://cpdc<account>.<host>/cpdc/odata/v1/ObjectTypeSet(ObjectTypeId=‘{ObjectTypeId}’,CollaborationId=‘{CollaborationId}’)/CollaborationObjects"
DataOutputStream dataOut = null;
BufferedReader in =null;

try {

  //API endpoint
  String url = "https://cpdc<account>.<host>/cpdc/odata/v1/ObjectTypeSet(ObjectTypeId=‘{ObjectTypeId}’,CollaborationId=‘{CollaborationId}’)/CollaborationObjects";
  
   URL urlObj = new URL(url);
  HttpURLConnection connection = (HttpURLConnection) urlObj.openConnection();

  connection.setRequestMethod("");
  
   //adding headers
  connection.setRequestProperty("Content-Type","application/json");
  
  connection.setRequestProperty("X-CSRF-Token","string"); //for POST , PATCH , DELETE
  
  //Basic Auth : provide username:password in Base64 encoded in Authorization header
  connection.setRequestProperty("Authorization","Basic " + "Base64 encoded value");
  
  connection.setDoInput(true);
  
  //For passing a body with request
  connection.setDoOutput(true);
  dataOut = new DataOutputStream(connection.getOutputStream());
  dataOut.writeBytes("{  \"string\": "string",  \"string\": \"string\"}");
  dataOut.flush();

  int responseCode = connection.getResponseCode();
  in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
  String inputLine;
  StringBuffer response = new StringBuffer();
  while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
  }

  //printing response
  System.out.println(response.toString());

} catch (Exception e) {
  //do something with exception
  e.printStackTrace();
} finally {
  try {
    if(dataOut != null) {
      dataOut.close();
    }
    if(in != null) {
      in.close();
    }

  } catch (IOException e) {
    //do something with exception
    e.printStackTrace();
  }
}
import io.swagger.client.api.ProductDataApi;

public class ProductDataApiExample {

    public static void main(String[] args) {
        ProductDataApi apiInstance = new ProductDataApi();
        String objectTypeId = objectTypeId_example; // String | Object Type ID as configured in the Configure Product Data app.
        String collaborationId = collaborationId_example; // String | ID of the collaboration to which the product data needs to be added.
        array[CollaborationObject] body = ; // array[CollaborationObject] | 
        try {
            array[CollaborationObjectResponse] result = apiInstance.objectTypeSetObjectTypeIdObjectTypeIdCollaborationIdCollaborationIdCollaborationObjectsPost(objectTypeId, collaborationId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductDataApi#objectTypeSetObjectTypeIdObjectTypeIdCollaborationIdCollaborationIdCollaborationObjectsPost");
            e.printStackTrace();
        }
    }
}
String *objectTypeId = objectTypeId_example; // Object Type ID as configured in the Configure Product Data app.
String *collaborationId = collaborationId_example; // ID of the collaboration to which the product data needs to be added.
array[CollaborationObject] *body = ; // 

ProductDataApi *apiInstance = [[ProductDataApi alloc] init];

// 
[apiInstance objectTypeSetObjectTypeIdObjectTypeIdCollaborationIdCollaborationIdCollaborationObjectsPostWith:objectTypeId
    collaborationId:collaborationId
    body:body
              completionHandler: ^(array[CollaborationObjectResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
//For sending body with API calls
var data = JSON.stringify({
  "context": {},
  "definitionId": "string"
});
//When no body is to be passed
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = false;

xhr.addEventListener('readystatechange', function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
	var res = this.responseText;
  }
});

//setting request method
//API endpoint for API sandbox 

xhr.open('set request method', "https://cpdc<account>.<host>/cpdc/odata/v1/ObjectTypeSet(ObjectTypeId=‘{ObjectTypeId}’,CollaborationId=‘{CollaborationId}’)/CollaborationObjects");
xhr.withCredentials = true;
xhr.setRequestHeader('Content-Type', 'application/json');
xhr.setRequestHeader('Authorization', 'Basic ' + 'Base64 encoded value'));
//When X-CSRF-Token is required
xhr.setRequestHeader("X-CSRF-Token", "string");
xhr.send(data);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class objectTypeSetObjectTypeIdObjectTypeIdCollaborationIdCollaborationIdCollaborationObjectsPostExample
    {
        public void main()
        {
            
            var apiInstance = new ProductDataApi();
            var objectTypeId = objectTypeId_example;  // String | Object Type ID as configured in the Configure Product Data app.
            var collaborationId = collaborationId_example;  // String | ID of the collaboration to which the product data needs to be added.
            var body = new array[CollaborationObject](); // array[CollaborationObject] | 

            try
            {
                // 
                array[CollaborationObjectResponse] result = apiInstance.objectTypeSetObjectTypeIdObjectTypeIdCollaborationIdCollaborationIdCollaborationObjectsPost(objectTypeId, collaborationId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductDataApi.objectTypeSetObjectTypeIdObjectTypeIdCollaborationIdCollaborationIdCollaborationObjectsPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ProductDataApi();
$objectTypeId = objectTypeId_example; // String | Object Type ID as configured in the Configure Product Data app.
$collaborationId = collaborationId_example; // String | ID of the collaboration to which the product data needs to be added.
$body = ; // array[CollaborationObject] | 

try {
    $result = $api_instance->objectTypeSetObjectTypeIdObjectTypeIdCollaborationIdCollaborationIdCollaborationObjectsPost($objectTypeId, $collaborationId, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductDataApi->objectTypeSetObjectTypeIdObjectTypeIdCollaborationIdCollaborationIdCollaborationObjectsPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProductDataApi;

my $api_instance = WWW::SwaggerClient::ProductDataApi->new();
my $objectTypeId = objectTypeId_example; # String | Object Type ID as configured in the Configure Product Data app.
my $collaborationId = collaborationId_example; # String | ID of the collaboration to which the product data needs to be added.
my $body = [WWW::SwaggerClient::Object::array[CollaborationObject]->new()]; # array[CollaborationObject] | 

eval { 
    my $result = $api_instance->objectTypeSetObjectTypeIdObjectTypeIdCollaborationIdCollaborationIdCollaborationObjectsPost(objectTypeId => $objectTypeId, collaborationId => $collaborationId, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProductDataApi->objectTypeSetObjectTypeIdObjectTypeIdCollaborationIdCollaborationIdCollaborationObjectsPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ProductDataApi()
objectTypeId = objectTypeId_example # String | Object Type ID as configured in the Configure Product Data app.
collaborationId = collaborationId_example # String | ID of the collaboration to which the product data needs to be added.
body =  # array[CollaborationObject] | 

try: 
    # 
    api_response = api_instance.objectTypeSetObjectTypeIdObjectTypeIdCollaborationIdCollaborationIdCollaborationObjectsPost(objectTypeId, collaborationId, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductDataApi->objectTypeSetObjectTypeIdObjectTypeIdCollaborationIdCollaborationIdCollaborationObjectsPost: %s\n" % e)
DATA: lo_http_client TYPE REF TO if_http_client.
DATA: response TYPE string.

CALL METHOD cl_http_client=>create_by_url
  EXPORTING
    url                = 'https://cpdc<account>.<host>/cpdc/odata/v1/ObjectTypeSet(ObjectTypeId=‘{ObjectTypeId}’,CollaborationId=‘{CollaborationId}’)/CollaborationObjects'

  IMPORTING
    client             = lo_http_client
  EXCEPTIONS
    argument_not_found = 1
    plugin_not_active  = 2
    internal_error     = 3
    OTHERS             = 4.
               
IF sy-subrc <> 0.
//error handling.
ENDIF.

//setting request method.
lo_http_client->request->set_method('set request method');.

//adding headers.
lo_http_client->request->set_header_field( name = 'Content-Type' value = 'application/json' ).

//Basic Auth : provide username:password in Base64 encoded in Authorization header.
lo_http_client->request->set_header_field( name = 'Authorization' value = 'Basic Base64 encoded value' ).

//For passing body with the request.
lv_json_post_data = | \{ | &&

                    |   "string":"string", | &&

                    |   "string":"string" | &&
                    | \} |.
                    
//For request where body is to be passed.
CALL METHOD lo_http_client1->request->set_data( lv_json_post_data ).
CALL METHOD lo_http_client->send
  EXCEPTIONS
    http_communication_failure = 1
    http_invalid_state         = 2
    http_processing_failed     = 3
    http_invalid_timeout       = 4
    OTHERS                     = 5.

IF sy-subrc = 0.
  CALL METHOD lo_http_client->receive
    EXCEPTIONS
      http_communication_failure = 1
      http_invalid_state         = 2
      http_processing_failed     = 3
      OTHERS                     = 5.
ENDIF.

IF sy-subrc <> 0.
 //error handling.
ENDIF.

response = lo_http_client->response->get_cdata( ).

WRITE: 'response: ', response. 

Parameters

Path parameters
Name Description
ObjectTypeId*
CollaborationId*
Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 400 - Bad Request. You provided an invalid URL or a request with malformed syntax.

Status: 403 - Forbidden. You do not have the required authorizations to perform the operation.

Status: 500 - Internal system error. Please contact technical support.


Workflow

/AbstractObjectSet(ObjectId=‘{CollaborationId}’,ObjectType=‘Collaboration’)/Workflows

Retrieves all the workflow IDs and the workflow definition IDs for the given collaboration ID.


/AbstractObjectSet(ObjectId=‘{CollaborationId}’,ObjectType=‘Collaboration’)/Workflows

Usage

curl -X get "https://cpdc<account>.<host>/cpdc/odata/v1/AbstractObjectSet(ObjectId=‘{CollaborationId}’,ObjectType=‘Collaboration’)/Workflows"
DataOutputStream dataOut = null;
BufferedReader in =null;

try {

  //API endpoint
  String url = "https://cpdc<account>.<host>/cpdc/odata/v1/AbstractObjectSet(ObjectId=‘{CollaborationId}’,ObjectType=‘Collaboration’)/Workflows";
  
   URL urlObj = new URL(url);
  HttpURLConnection connection = (HttpURLConnection) urlObj.openConnection();

  connection.setRequestMethod("");
  
   //adding headers
  connection.setRequestProperty("Content-Type","application/json");
  
  connection.setRequestProperty("X-CSRF-Token","string"); //for POST , PATCH , DELETE
  
  //Basic Auth : provide username:password in Base64 encoded in Authorization header
  connection.setRequestProperty("Authorization","Basic " + "Base64 encoded value");
  
  connection.setDoInput(true);
  
  //For passing a body with request
  connection.setDoOutput(true);
  dataOut = new DataOutputStream(connection.getOutputStream());
  dataOut.writeBytes("{  \"string\": "string",  \"string\": \"string\"}");
  dataOut.flush();

  int responseCode = connection.getResponseCode();
  in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
  String inputLine;
  StringBuffer response = new StringBuffer();
  while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
  }

  //printing response
  System.out.println(response.toString());

} catch (Exception e) {
  //do something with exception
  e.printStackTrace();
} finally {
  try {
    if(dataOut != null) {
      dataOut.close();
    }
    if(in != null) {
      in.close();
    }

  } catch (IOException e) {
    //do something with exception
    e.printStackTrace();
  }
}
import io.swagger.client.api.WorkflowApi;

public class WorkflowApiExample {

    public static void main(String[] args) {
        WorkflowApi apiInstance = new WorkflowApi();
        String collaborationId = collaborationId_example; // String | ID of the collaboration for which the list of workflow IDs and workflow definition IDs needs to be returned.
        try {
            Workflow result = apiInstance.abstractObjectSetObjectIdCollaborationIdObjectTypeCollaborationWorkflowsGet(collaborationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkflowApi#abstractObjectSetObjectIdCollaborationIdObjectTypeCollaborationWorkflowsGet");
            e.printStackTrace();
        }
    }
}
String *collaborationId = collaborationId_example; // ID of the collaboration for which the list of workflow IDs and workflow definition IDs needs to be returned.

WorkflowApi *apiInstance = [[WorkflowApi alloc] init];

// 
[apiInstance abstractObjectSetObjectIdCollaborationIdObjectTypeCollaborationWorkflowsGetWith:collaborationId
              completionHandler: ^(Workflow output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
//For sending body with API calls
var data = JSON.stringify({
  "context": {},
  "definitionId": "string"
});
//When no body is to be passed
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = false;

xhr.addEventListener('readystatechange', function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
	var res = this.responseText;
  }
});

//setting request method
//API endpoint for API sandbox 

xhr.open('set request method', "https://cpdc<account>.<host>/cpdc/odata/v1/AbstractObjectSet(ObjectId=‘{CollaborationId}’,ObjectType=‘Collaboration’)/Workflows");
xhr.withCredentials = true;
xhr.setRequestHeader('Content-Type', 'application/json');
xhr.setRequestHeader('Authorization', 'Basic ' + 'Base64 encoded value'));
//When X-CSRF-Token is required
xhr.setRequestHeader("X-CSRF-Token", "string");
xhr.send(data);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class abstractObjectSetObjectIdCollaborationIdObjectTypeCollaborationWorkflowsGetExample
    {
        public void main()
        {
            
            var apiInstance = new WorkflowApi();
            var collaborationId = collaborationId_example;  // String | ID of the collaboration for which the list of workflow IDs and workflow definition IDs needs to be returned.

            try
            {
                // 
                Workflow result = apiInstance.abstractObjectSetObjectIdCollaborationIdObjectTypeCollaborationWorkflowsGet(collaborationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WorkflowApi.abstractObjectSetObjectIdCollaborationIdObjectTypeCollaborationWorkflowsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\WorkflowApi();
$collaborationId = collaborationId_example; // String | ID of the collaboration for which the list of workflow IDs and workflow definition IDs needs to be returned.

try {
    $result = $api_instance->abstractObjectSetObjectIdCollaborationIdObjectTypeCollaborationWorkflowsGet($collaborationId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WorkflowApi->abstractObjectSetObjectIdCollaborationIdObjectTypeCollaborationWorkflowsGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::WorkflowApi;

my $api_instance = WWW::SwaggerClient::WorkflowApi->new();
my $collaborationId = collaborationId_example; # String | ID of the collaboration for which the list of workflow IDs and workflow definition IDs needs to be returned.

eval { 
    my $result = $api_instance->abstractObjectSetObjectIdCollaborationIdObjectTypeCollaborationWorkflowsGet(collaborationId => $collaborationId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WorkflowApi->abstractObjectSetObjectIdCollaborationIdObjectTypeCollaborationWorkflowsGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.WorkflowApi()
collaborationId = collaborationId_example # String | ID of the collaboration for which the list of workflow IDs and workflow definition IDs needs to be returned.

try: 
    # 
    api_response = api_instance.abstractObjectSetObjectIdCollaborationIdObjectTypeCollaborationWorkflowsGet(collaborationId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WorkflowApi->abstractObjectSetObjectIdCollaborationIdObjectTypeCollaborationWorkflowsGet: %s\n" % e)
DATA: lo_http_client TYPE REF TO if_http_client.
DATA: response TYPE string.

CALL METHOD cl_http_client=>create_by_url
  EXPORTING
    url                = 'https://cpdc<account>.<host>/cpdc/odata/v1/AbstractObjectSet(ObjectId=‘{CollaborationId}’,ObjectType=‘Collaboration’)/Workflows'

  IMPORTING
    client             = lo_http_client
  EXCEPTIONS
    argument_not_found = 1
    plugin_not_active  = 2
    internal_error     = 3
    OTHERS             = 4.
               
IF sy-subrc <> 0.
//error handling.
ENDIF.

//setting request method.
lo_http_client->request->set_method('set request method');.

//adding headers.
lo_http_client->request->set_header_field( name = 'Content-Type' value = 'application/json' ).

//Basic Auth : provide username:password in Base64 encoded in Authorization header.
lo_http_client->request->set_header_field( name = 'Authorization' value = 'Basic Base64 encoded value' ).

//For passing body with the request.
lv_json_post_data = | \{ | &&

                    |   "string":"string", | &&

                    |   "string":"string" | &&
                    | \} |.
                    
//For request where body is to be passed.
CALL METHOD lo_http_client1->request->set_data( lv_json_post_data ).
CALL METHOD lo_http_client->send
  EXCEPTIONS
    http_communication_failure = 1
    http_invalid_state         = 2
    http_processing_failed     = 3
    http_invalid_timeout       = 4
    OTHERS                     = 5.

IF sy-subrc = 0.
  CALL METHOD lo_http_client->receive
    EXCEPTIONS
      http_communication_failure = 1
      http_invalid_state         = 2
      http_processing_failed     = 3
      OTHERS                     = 5.
ENDIF.

IF sy-subrc <> 0.
 //error handling.
ENDIF.

response = lo_http_client->response->get_cdata( ).

WRITE: 'response: ', response. 

Parameters

Path parameters
Name Description
CollaborationId*

Responses

Status: 200 - OK

Status: 400 - Bad Request. You provided an invalid URL.

Status: 403 - Forbidden. You do not have the required authorizations to access the resource.

Status: 404 - Not Found. You provided either an incorrect collaboration ID or an incorrect entity set.

Status: 500 - Internal system error. Please contact technical support.


/AbstractObjectSet(ObjectId=‘{CollaborationId}’,ObjectType=‘Collaboration’)/Workflows

Adds the specified workflow to the specified collaboration ID.


/AbstractObjectSet(ObjectId=‘{CollaborationId}’,ObjectType=‘Collaboration’)/Workflows

Usage

curl -X post "https://cpdc<account>.<host>/cpdc/odata/v1/AbstractObjectSet(ObjectId=‘{CollaborationId}’,ObjectType=‘Collaboration’)/Workflows"
DataOutputStream dataOut = null;
BufferedReader in =null;

try {

  //API endpoint
  String url = "https://cpdc<account>.<host>/cpdc/odata/v1/AbstractObjectSet(ObjectId=‘{CollaborationId}’,ObjectType=‘Collaboration’)/Workflows";
  
   URL urlObj = new URL(url);
  HttpURLConnection connection = (HttpURLConnection) urlObj.openConnection();

  connection.setRequestMethod("");
  
   //adding headers
  connection.setRequestProperty("Content-Type","application/json");
  
  connection.setRequestProperty("X-CSRF-Token","string"); //for POST , PATCH , DELETE
  
  //Basic Auth : provide username:password in Base64 encoded in Authorization header
  connection.setRequestProperty("Authorization","Basic " + "Base64 encoded value");
  
  connection.setDoInput(true);
  
  //For passing a body with request
  connection.setDoOutput(true);
  dataOut = new DataOutputStream(connection.getOutputStream());
  dataOut.writeBytes("{  \"string\": "string",  \"string\": \"string\"}");
  dataOut.flush();

  int responseCode = connection.getResponseCode();
  in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
  String inputLine;
  StringBuffer response = new StringBuffer();
  while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
  }

  //printing response
  System.out.println(response.toString());

} catch (Exception e) {
  //do something with exception
  e.printStackTrace();
} finally {
  try {
    if(dataOut != null) {
      dataOut.close();
    }
    if(in != null) {
      in.close();
    }

  } catch (IOException e) {
    //do something with exception
    e.printStackTrace();
  }
}
import io.swagger.client.api.WorkflowApi;

public class WorkflowApiExample {

    public static void main(String[] args) {
        WorkflowApi apiInstance = new WorkflowApi();
        String collaborationId = collaborationId_example; // String | ID of the collaboration to which the workflow needs to be added.
        Body_3 body = ; // Body_3 | 
        try {
            apiInstance.abstractObjectSetObjectIdCollaborationIdObjectTypeCollaborationWorkflowsPost(collaborationId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkflowApi#abstractObjectSetObjectIdCollaborationIdObjectTypeCollaborationWorkflowsPost");
            e.printStackTrace();
        }
    }
}
String *collaborationId = collaborationId_example; // ID of the collaboration to which the workflow needs to be added.
Body_3 *body = ; // 

WorkflowApi *apiInstance = [[WorkflowApi alloc] init];

// 
[apiInstance abstractObjectSetObjectIdCollaborationIdObjectTypeCollaborationWorkflowsPostWith:collaborationId
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
//For sending body with API calls
var data = JSON.stringify({
  "context": {},
  "definitionId": "string"
});
//When no body is to be passed
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = false;

xhr.addEventListener('readystatechange', function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
	var res = this.responseText;
  }
});

//setting request method
//API endpoint for API sandbox 

xhr.open('set request method', "https://cpdc<account>.<host>/cpdc/odata/v1/AbstractObjectSet(ObjectId=‘{CollaborationId}’,ObjectType=‘Collaboration’)/Workflows");
xhr.withCredentials = true;
xhr.setRequestHeader('Content-Type', 'application/json');
xhr.setRequestHeader('Authorization', 'Basic ' + 'Base64 encoded value'));
//When X-CSRF-Token is required
xhr.setRequestHeader("X-CSRF-Token", "string");
xhr.send(data);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class abstractObjectSetObjectIdCollaborationIdObjectTypeCollaborationWorkflowsPostExample
    {
        public void main()
        {
            
            var apiInstance = new WorkflowApi();
            var collaborationId = collaborationId_example;  // String | ID of the collaboration to which the workflow needs to be added.
            var body = new Body_3(); // Body_3 | 

            try
            {
                // 
                apiInstance.abstractObjectSetObjectIdCollaborationIdObjectTypeCollaborationWorkflowsPost(collaborationId, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WorkflowApi.abstractObjectSetObjectIdCollaborationIdObjectTypeCollaborationWorkflowsPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\WorkflowApi();
$collaborationId = collaborationId_example; // String | ID of the collaboration to which the workflow needs to be added.
$body = ; // Body_3 | 

try {
    $api_instance->abstractObjectSetObjectIdCollaborationIdObjectTypeCollaborationWorkflowsPost($collaborationId, $body);
} catch (Exception $e) {
    echo 'Exception when calling WorkflowApi->abstractObjectSetObjectIdCollaborationIdObjectTypeCollaborationWorkflowsPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::WorkflowApi;

my $api_instance = WWW::SwaggerClient::WorkflowApi->new();
my $collaborationId = collaborationId_example; # String | ID of the collaboration to which the workflow needs to be added.
my $body = WWW::SwaggerClient::Object::Body_3->new(); # Body_3 | 

eval { 
    $api_instance->abstractObjectSetObjectIdCollaborationIdObjectTypeCollaborationWorkflowsPost(collaborationId => $collaborationId, body => $body);
};
if ($@) {
    warn "Exception when calling WorkflowApi->abstractObjectSetObjectIdCollaborationIdObjectTypeCollaborationWorkflowsPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.WorkflowApi()
collaborationId = collaborationId_example # String | ID of the collaboration to which the workflow needs to be added.
body =  # Body_3 | 

try: 
    # 
    api_instance.abstractObjectSetObjectIdCollaborationIdObjectTypeCollaborationWorkflowsPost(collaborationId, body)
except ApiException as e:
    print("Exception when calling WorkflowApi->abstractObjectSetObjectIdCollaborationIdObjectTypeCollaborationWorkflowsPost: %s\n" % e)
DATA: lo_http_client TYPE REF TO if_http_client.
DATA: response TYPE string.

CALL METHOD cl_http_client=>create_by_url
  EXPORTING
    url                = 'https://cpdc<account>.<host>/cpdc/odata/v1/AbstractObjectSet(ObjectId=‘{CollaborationId}’,ObjectType=‘Collaboration’)/Workflows'

  IMPORTING
    client             = lo_http_client
  EXCEPTIONS
    argument_not_found = 1
    plugin_not_active  = 2
    internal_error     = 3
    OTHERS             = 4.
               
IF sy-subrc <> 0.
//error handling.
ENDIF.

//setting request method.
lo_http_client->request->set_method('set request method');.

//adding headers.
lo_http_client->request->set_header_field( name = 'Content-Type' value = 'application/json' ).

//Basic Auth : provide username:password in Base64 encoded in Authorization header.
lo_http_client->request->set_header_field( name = 'Authorization' value = 'Basic Base64 encoded value' ).

//For passing body with the request.
lv_json_post_data = | \{ | &&

                    |   "string":"string", | &&

                    |   "string":"string" | &&
                    | \} |.
                    
//For request where body is to be passed.
CALL METHOD lo_http_client1->request->set_data( lv_json_post_data ).
CALL METHOD lo_http_client->send
  EXCEPTIONS
    http_communication_failure = 1
    http_invalid_state         = 2
    http_processing_failed     = 3
    http_invalid_timeout       = 4
    OTHERS                     = 5.

IF sy-subrc = 0.
  CALL METHOD lo_http_client->receive
    EXCEPTIONS
      http_communication_failure = 1
      http_invalid_state         = 2
      http_processing_failed     = 3
      OTHERS                     = 5.
ENDIF.

IF sy-subrc <> 0.
 //error handling.
ENDIF.

response = lo_http_client->response->get_cdata( ).

WRITE: 'response: ', response. 

Parameters

Path parameters
Name Description
CollaborationId*
Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 400 - Bad Request. You provided an invalid URL or a request with malformed syntax.

Status: 403 - Forbidden. You do not have the required authorizations to perform the operation.

Status: 500 - Internal system error. Please contact technical support.


/WorkflowSet(‘{WorkflowId}’)

Deletes the specified workflow instance from the collaboration.

Deletes the specified workflow instance from the collaboration. A cancelled workflow cannot be deleted.


/WorkflowSet(‘{WorkflowId}’)

Usage

curl -X delete "https://cpdc<account>.<host>/cpdc/odata/v1/WorkflowSet(‘{WorkflowId}’)"
DataOutputStream dataOut = null;
BufferedReader in =null;

try {

  //API endpoint
  String url = "https://cpdc<account>.<host>/cpdc/odata/v1/WorkflowSet(‘{WorkflowId}’)";
  
   URL urlObj = new URL(url);
  HttpURLConnection connection = (HttpURLConnection) urlObj.openConnection();

  connection.setRequestMethod("");
  
   //adding headers
  connection.setRequestProperty("Content-Type","application/json");
  
  connection.setRequestProperty("X-CSRF-Token","string"); //for POST , PATCH , DELETE
  
  //Basic Auth : provide username:password in Base64 encoded in Authorization header
  connection.setRequestProperty("Authorization","Basic " + "Base64 encoded value");
  
  connection.setDoInput(true);
  
  //For passing a body with request
  connection.setDoOutput(true);
  dataOut = new DataOutputStream(connection.getOutputStream());
  dataOut.writeBytes("{  \"string\": "string",  \"string\": \"string\"}");
  dataOut.flush();

  int responseCode = connection.getResponseCode();
  in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
  String inputLine;
  StringBuffer response = new StringBuffer();
  while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
  }

  //printing response
  System.out.println(response.toString());

} catch (Exception e) {
  //do something with exception
  e.printStackTrace();
} finally {
  try {
    if(dataOut != null) {
      dataOut.close();
    }
    if(in != null) {
      in.close();
    }

  } catch (IOException e) {
    //do something with exception
    e.printStackTrace();
  }
}
import io.swagger.client.api.WorkflowApi;

public class WorkflowApiExample {

    public static void main(String[] args) {
        WorkflowApi apiInstance = new WorkflowApi();
        String workflowId = workflowId_example; // String | ID of the workflow instance that needs to be deleted.
        try {
            apiInstance.workflowSetWorkflowIdDelete(workflowId);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkflowApi#workflowSetWorkflowIdDelete");
            e.printStackTrace();
        }
    }
}
String *workflowId = workflowId_example; // ID of the workflow instance that needs to be deleted.

WorkflowApi *apiInstance = [[WorkflowApi alloc] init];

// Deletes the specified workflow instance from the collaboration.
[apiInstance workflowSetWorkflowIdDeleteWith:workflowId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
//For sending body with API calls
var data = JSON.stringify({
  "context": {},
  "definitionId": "string"
});
//When no body is to be passed
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = false;

xhr.addEventListener('readystatechange', function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
	var res = this.responseText;
  }
});

//setting request method
//API endpoint for API sandbox 

xhr.open('set request method', "https://cpdc<account>.<host>/cpdc/odata/v1/WorkflowSet(‘{WorkflowId}’)");
xhr.withCredentials = true;
xhr.setRequestHeader('Content-Type', 'application/json');
xhr.setRequestHeader('Authorization', 'Basic ' + 'Base64 encoded value'));
//When X-CSRF-Token is required
xhr.setRequestHeader("X-CSRF-Token", "string");
xhr.send(data);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class workflowSetWorkflowIdDeleteExample
    {
        public void main()
        {
            
            var apiInstance = new WorkflowApi();
            var workflowId = workflowId_example;  // String | ID of the workflow instance that needs to be deleted.

            try
            {
                // Deletes the specified workflow instance from the collaboration.
                apiInstance.workflowSetWorkflowIdDelete(workflowId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WorkflowApi.workflowSetWorkflowIdDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\WorkflowApi();
$workflowId = workflowId_example; // String | ID of the workflow instance that needs to be deleted.

try {
    $api_instance->workflowSetWorkflowIdDelete($workflowId);
} catch (Exception $e) {
    echo 'Exception when calling WorkflowApi->workflowSetWorkflowIdDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::WorkflowApi;

my $api_instance = WWW::SwaggerClient::WorkflowApi->new();
my $workflowId = workflowId_example; # String | ID of the workflow instance that needs to be deleted.

eval { 
    $api_instance->workflowSetWorkflowIdDelete(workflowId => $workflowId);
};
if ($@) {
    warn "Exception when calling WorkflowApi->workflowSetWorkflowIdDelete: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.WorkflowApi()
workflowId = workflowId_example # String | ID of the workflow instance that needs to be deleted.

try: 
    # Deletes the specified workflow instance from the collaboration.
    api_instance.workflowSetWorkflowIdDelete(workflowId)
except ApiException as e:
    print("Exception when calling WorkflowApi->workflowSetWorkflowIdDelete: %s\n" % e)
DATA: lo_http_client TYPE REF TO if_http_client.
DATA: response TYPE string.

CALL METHOD cl_http_client=>create_by_url
  EXPORTING
    url                = 'https://cpdc<account>.<host>/cpdc/odata/v1/WorkflowSet(‘{WorkflowId}’)'

  IMPORTING
    client             = lo_http_client
  EXCEPTIONS
    argument_not_found = 1
    plugin_not_active  = 2
    internal_error     = 3
    OTHERS             = 4.
               
IF sy-subrc <> 0.
//error handling.
ENDIF.

//setting request method.
lo_http_client->request->set_method('set request method');.

//adding headers.
lo_http_client->request->set_header_field( name = 'Content-Type' value = 'application/json' ).

//Basic Auth : provide username:password in Base64 encoded in Authorization header.
lo_http_client->request->set_header_field( name = 'Authorization' value = 'Basic Base64 encoded value' ).

//For passing body with the request.
lv_json_post_data = | \{ | &&

                    |   "string":"string", | &&

                    |   "string":"string" | &&
                    | \} |.
                    
//For request where body is to be passed.
CALL METHOD lo_http_client1->request->set_data( lv_json_post_data ).
CALL METHOD lo_http_client->send
  EXCEPTIONS
    http_communication_failure = 1
    http_invalid_state         = 2
    http_processing_failed     = 3
    http_invalid_timeout       = 4
    OTHERS                     = 5.

IF sy-subrc = 0.
  CALL METHOD lo_http_client->receive
    EXCEPTIONS
      http_communication_failure = 1
      http_invalid_state         = 2
      http_processing_failed     = 3
      OTHERS                     = 5.
ENDIF.

IF sy-subrc <> 0.
 //error handling.
ENDIF.

response = lo_http_client->response->get_cdata( ).

WRITE: 'response: ', response. 

Parameters

Path parameters
Name Description
WorkflowId*

Responses

Status: 200 - Deleted

Status: 400 - Bad Request. You provided an invalid URL.

Status: 403 - Forbidden. You do not have the required authorizations to perform the operation.

Status: 500 - Internal system error. Please contact technical support.


/WorkflowSet(‘{WorkflowId}’)

Sets a new status for the given workflow.


/WorkflowSet(‘{WorkflowId}’)

Usage

curl -X patch "https://cpdc<account>.<host>/cpdc/odata/v1/WorkflowSet(‘{WorkflowId}’)"
DataOutputStream dataOut = null;
BufferedReader in =null;

try {

  //API endpoint
  String url = "https://cpdc<account>.<host>/cpdc/odata/v1/WorkflowSet(‘{WorkflowId}’)";
  
   URL urlObj = new URL(url);
  HttpURLConnection connection = (HttpURLConnection) urlObj.openConnection();

  connection.setRequestMethod("");
  
   //adding headers
  connection.setRequestProperty("Content-Type","application/json");
  
  connection.setRequestProperty("X-CSRF-Token","string"); //for POST , PATCH , DELETE
  
  //Basic Auth : provide username:password in Base64 encoded in Authorization header
  connection.setRequestProperty("Authorization","Basic " + "Base64 encoded value");
  
  connection.setDoInput(true);
  
  //For passing a body with request
  connection.setDoOutput(true);
  dataOut = new DataOutputStream(connection.getOutputStream());
  dataOut.writeBytes("{  \"string\": "string",  \"string\": \"string\"}");
  dataOut.flush();

  int responseCode = connection.getResponseCode();
  in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
  String inputLine;
  StringBuffer response = new StringBuffer();
  while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
  }

  //printing response
  System.out.println(response.toString());

} catch (Exception e) {
  //do something with exception
  e.printStackTrace();
} finally {
  try {
    if(dataOut != null) {
      dataOut.close();
    }
    if(in != null) {
      in.close();
    }

  } catch (IOException e) {
    //do something with exception
    e.printStackTrace();
  }
}
import io.swagger.client.api.WorkflowApi;

public class WorkflowApiExample {

    public static void main(String[] args) {
        WorkflowApi apiInstance = new WorkflowApi();
        String workflowId = workflowId_example; // String | ID of the workflow for which the status needs to be updated.
        Body_4 body = ; // Body_4 | 
        try {
            apiInstance.workflowSetWorkflowIdPatch(workflowId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkflowApi#workflowSetWorkflowIdPatch");
            e.printStackTrace();
        }
    }
}
String *workflowId = workflowId_example; // ID of the workflow for which the status needs to be updated.
Body_4 *body = ; // 

WorkflowApi *apiInstance = [[WorkflowApi alloc] init];

// Sets a new status for the given workflow.
[apiInstance workflowSetWorkflowIdPatchWith:workflowId
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
//For sending body with API calls
var data = JSON.stringify({
  "context": {},
  "definitionId": "string"
});
//When no body is to be passed
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = false;

xhr.addEventListener('readystatechange', function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
	var res = this.responseText;
  }
});

//setting request method
//API endpoint for API sandbox 

xhr.open('set request method', "https://cpdc<account>.<host>/cpdc/odata/v1/WorkflowSet(‘{WorkflowId}’)");
xhr.withCredentials = true;
xhr.setRequestHeader('Content-Type', 'application/json');
xhr.setRequestHeader('Authorization', 'Basic ' + 'Base64 encoded value'));
//When X-CSRF-Token is required
xhr.setRequestHeader("X-CSRF-Token", "string");
xhr.send(data);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class workflowSetWorkflowIdPatchExample
    {
        public void main()
        {
            
            var apiInstance = new WorkflowApi();
            var workflowId = workflowId_example;  // String | ID of the workflow for which the status needs to be updated.
            var body = new Body_4(); // Body_4 | 

            try
            {
                // Sets a new status for the given workflow.
                apiInstance.workflowSetWorkflowIdPatch(workflowId, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WorkflowApi.workflowSetWorkflowIdPatch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\WorkflowApi();
$workflowId = workflowId_example; // String | ID of the workflow for which the status needs to be updated.
$body = ; // Body_4 | 

try {
    $api_instance->workflowSetWorkflowIdPatch($workflowId, $body);
} catch (Exception $e) {
    echo 'Exception when calling WorkflowApi->workflowSetWorkflowIdPatch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::WorkflowApi;

my $api_instance = WWW::SwaggerClient::WorkflowApi->new();
my $workflowId = workflowId_example; # String | ID of the workflow for which the status needs to be updated.
my $body = WWW::SwaggerClient::Object::Body_4->new(); # Body_4 | 

eval { 
    $api_instance->workflowSetWorkflowIdPatch(workflowId => $workflowId, body => $body);
};
if ($@) {
    warn "Exception when calling WorkflowApi->workflowSetWorkflowIdPatch: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.WorkflowApi()
workflowId = workflowId_example # String | ID of the workflow for which the status needs to be updated.
body =  # Body_4 | 

try: 
    # Sets a new status for the given workflow.
    api_instance.workflowSetWorkflowIdPatch(workflowId, body)
except ApiException as e:
    print("Exception when calling WorkflowApi->workflowSetWorkflowIdPatch: %s\n" % e)
DATA: lo_http_client TYPE REF TO if_http_client.
DATA: response TYPE string.

CALL METHOD cl_http_client=>create_by_url
  EXPORTING
    url                = 'https://cpdc<account>.<host>/cpdc/odata/v1/WorkflowSet(‘{WorkflowId}’)'

  IMPORTING
    client             = lo_http_client
  EXCEPTIONS
    argument_not_found = 1
    plugin_not_active  = 2
    internal_error     = 3
    OTHERS             = 4.
               
IF sy-subrc <> 0.
//error handling.
ENDIF.

//setting request method.
lo_http_client->request->set_method('set request method');.

//adding headers.
lo_http_client->request->set_header_field( name = 'Content-Type' value = 'application/json' ).

//Basic Auth : provide username:password in Base64 encoded in Authorization header.
lo_http_client->request->set_header_field( name = 'Authorization' value = 'Basic Base64 encoded value' ).

//For passing body with the request.
lv_json_post_data = | \{ | &&

                    |   "string":"string", | &&

                    |   "string":"string" | &&
                    | \} |.
                    
//For request where body is to be passed.
CALL METHOD lo_http_client1->request->set_data( lv_json_post_data ).
CALL METHOD lo_http_client->send
  EXCEPTIONS
    http_communication_failure = 1
    http_invalid_state         = 2
    http_processing_failed     = 3
    http_invalid_timeout       = 4
    OTHERS                     = 5.

IF sy-subrc = 0.
  CALL METHOD lo_http_client->receive
    EXCEPTIONS
      http_communication_failure = 1
      http_invalid_state         = 2
      http_processing_failed     = 3
      OTHERS                     = 5.
ENDIF.

IF sy-subrc <> 0.
 //error handling.
ENDIF.

response = lo_http_client->response->get_cdata( ).

WRITE: 'response: ', response. 

Parameters

Path parameters
Name Description
WorkflowId*
Body parameters
Name Description
body *

Responses

Status: 202 - Updated

Status: 400 - Bad Request. You provided an invalid URL or a request with malformed syntax.

Status: 403 - Forbidden. You do not have the required authorizations to perform the operation.

Status: 500 - Internal system error. Please contact technical support.


/WorkflowSet(‘{WorkflowId}’)/Tasks

Retrieves all the tasks of a workflow instance.


/WorkflowSet(‘{WorkflowId}’)/Tasks

Usage

curl -X get "https://cpdc<account>.<host>/cpdc/odata/v1/WorkflowSet(‘{WorkflowId}’)/Tasks"
DataOutputStream dataOut = null;
BufferedReader in =null;

try {

  //API endpoint
  String url = "https://cpdc<account>.<host>/cpdc/odata/v1/WorkflowSet(‘{WorkflowId}’)/Tasks";
  
   URL urlObj = new URL(url);
  HttpURLConnection connection = (HttpURLConnection) urlObj.openConnection();

  connection.setRequestMethod("");
  
   //adding headers
  connection.setRequestProperty("Content-Type","application/json");
  
  connection.setRequestProperty("X-CSRF-Token","string"); //for POST , PATCH , DELETE
  
  //Basic Auth : provide username:password in Base64 encoded in Authorization header
  connection.setRequestProperty("Authorization","Basic " + "Base64 encoded value");
  
  connection.setDoInput(true);
  
  //For passing a body with request
  connection.setDoOutput(true);
  dataOut = new DataOutputStream(connection.getOutputStream());
  dataOut.writeBytes("{  \"string\": "string",  \"string\": \"string\"}");
  dataOut.flush();

  int responseCode = connection.getResponseCode();
  in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
  String inputLine;
  StringBuffer response = new StringBuffer();
  while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
  }

  //printing response
  System.out.println(response.toString());

} catch (Exception e) {
  //do something with exception
  e.printStackTrace();
} finally {
  try {
    if(dataOut != null) {
      dataOut.close();
    }
    if(in != null) {
      in.close();
    }

  } catch (IOException e) {
    //do something with exception
    e.printStackTrace();
  }
}
import io.swagger.client.api.WorkflowApi;

public class WorkflowApiExample {

    public static void main(String[] args) {
        WorkflowApi apiInstance = new WorkflowApi();
        String workflowId = workflowId_example; // String | ID of the workflow for which the tasks need to be returned.
        try {
            Task result = apiInstance.workflowSetWorkflowIdTasksGet(workflowId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkflowApi#workflowSetWorkflowIdTasksGet");
            e.printStackTrace();
        }
    }
}
String *workflowId = workflowId_example; // ID of the workflow for which the tasks need to be returned.

WorkflowApi *apiInstance = [[WorkflowApi alloc] init];

// Retrieves all the tasks of a workflow instance.
[apiInstance workflowSetWorkflowIdTasksGetWith:workflowId
              completionHandler: ^(Task output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
//For sending body with API calls
var data = JSON.stringify({
  "context": {},
  "definitionId": "string"
});
//When no body is to be passed
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = false;

xhr.addEventListener('readystatechange', function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
	var res = this.responseText;
  }
});

//setting request method
//API endpoint for API sandbox 

xhr.open('set request method', "https://cpdc<account>.<host>/cpdc/odata/v1/WorkflowSet(‘{WorkflowId}’)/Tasks");
xhr.withCredentials = true;
xhr.setRequestHeader('Content-Type', 'application/json');
xhr.setRequestHeader('Authorization', 'Basic ' + 'Base64 encoded value'));
//When X-CSRF-Token is required
xhr.setRequestHeader("X-CSRF-Token", "string");
xhr.send(data);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class workflowSetWorkflowIdTasksGetExample
    {
        public void main()
        {
            
            var apiInstance = new WorkflowApi();
            var workflowId = workflowId_example;  // String | ID of the workflow for which the tasks need to be returned.

            try
            {
                // Retrieves all the tasks of a workflow instance.
                Task result = apiInstance.workflowSetWorkflowIdTasksGet(workflowId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WorkflowApi.workflowSetWorkflowIdTasksGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\WorkflowApi();
$workflowId = workflowId_example; // String | ID of the workflow for which the tasks need to be returned.

try {
    $result = $api_instance->workflowSetWorkflowIdTasksGet($workflowId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WorkflowApi->workflowSetWorkflowIdTasksGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::WorkflowApi;

my $api_instance = WWW::SwaggerClient::WorkflowApi->new();
my $workflowId = workflowId_example; # String | ID of the workflow for which the tasks need to be returned.

eval { 
    my $result = $api_instance->workflowSetWorkflowIdTasksGet(workflowId => $workflowId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WorkflowApi->workflowSetWorkflowIdTasksGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.WorkflowApi()
workflowId = workflowId_example # String | ID of the workflow for which the tasks need to be returned.

try: 
    # Retrieves all the tasks of a workflow instance.
    api_response = api_instance.workflowSetWorkflowIdTasksGet(workflowId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WorkflowApi->workflowSetWorkflowIdTasksGet: %s\n" % e)
DATA: lo_http_client TYPE REF TO if_http_client.
DATA: response TYPE string.

CALL METHOD cl_http_client=>create_by_url
  EXPORTING
    url                = 'https://cpdc<account>.<host>/cpdc/odata/v1/WorkflowSet(‘{WorkflowId}’)/Tasks'

  IMPORTING
    client             = lo_http_client
  EXCEPTIONS
    argument_not_found = 1
    plugin_not_active  = 2
    internal_error     = 3
    OTHERS             = 4.
               
IF sy-subrc <> 0.
//error handling.
ENDIF.

//setting request method.
lo_http_client->request->set_method('set request method');.

//adding headers.
lo_http_client->request->set_header_field( name = 'Content-Type' value = 'application/json' ).

//Basic Auth : provide username:password in Base64 encoded in Authorization header.
lo_http_client->request->set_header_field( name = 'Authorization' value = 'Basic Base64 encoded value' ).

//For passing body with the request.
lv_json_post_data = | \{ | &&

                    |   "string":"string", | &&

                    |   "string":"string" | &&
                    | \} |.
                    
//For request where body is to be passed.
CALL METHOD lo_http_client1->request->set_data( lv_json_post_data ).
CALL METHOD lo_http_client->send
  EXCEPTIONS
    http_communication_failure = 1
    http_invalid_state         = 2
    http_processing_failed     = 3
    http_invalid_timeout       = 4
    OTHERS                     = 5.

IF sy-subrc = 0.
  CALL METHOD lo_http_client->receive
    EXCEPTIONS
      http_communication_failure = 1
      http_invalid_state         = 2
      http_processing_failed     = 3
      OTHERS                     = 5.
ENDIF.

IF sy-subrc <> 0.
 //error handling.
ENDIF.

response = lo_http_client->response->get_cdata( ).

WRITE: 'response: ', response. 

Parameters

Path parameters
Name Description
WorkflowId*

Responses

Status: 200 - OK

Status: 400 - Bad Request. You provided an invalid URL.

Status: 403 - Forbidden. You do not have the required authorizations to access the resource.

Status: 404 - Not Found. You provided either an incorrect workflow ID or an incorrect entity set.

Status: 500 - Internal system error. Please contact technical support.


XCSRFTokenHandling

/

Generates an X-CSRF token for this session.


/

Usage

curl -X get "https://cpdc<account>.<host>/cpdc/odata/v1/"
DataOutputStream dataOut = null;
BufferedReader in =null;

try {

  //API endpoint
  String url = "https://cpdc<account>.<host>/cpdc/odata/v1/";
  
   URL urlObj = new URL(url);
  HttpURLConnection connection = (HttpURLConnection) urlObj.openConnection();

  connection.setRequestMethod("");
  
   //adding headers
  connection.setRequestProperty("Content-Type","application/json");
  
  connection.setRequestProperty("X-CSRF-Token","string"); //for POST , PATCH , DELETE
  
  //Basic Auth : provide username:password in Base64 encoded in Authorization header
  connection.setRequestProperty("Authorization","Basic " + "Base64 encoded value");
  
  connection.setDoInput(true);
  
  //For passing a body with request
  connection.setDoOutput(true);
  dataOut = new DataOutputStream(connection.getOutputStream());
  dataOut.writeBytes("{  \"string\": "string",  \"string\": \"string\"}");
  dataOut.flush();

  int responseCode = connection.getResponseCode();
  in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
  String inputLine;
  StringBuffer response = new StringBuffer();
  while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
  }

  //printing response
  System.out.println(response.toString());

} catch (Exception e) {
  //do something with exception
  e.printStackTrace();
} finally {
  try {
    if(dataOut != null) {
      dataOut.close();
    }
    if(in != null) {
      in.close();
    }

  } catch (IOException e) {
    //do something with exception
    e.printStackTrace();
  }
}
import io.swagger.client.api.XCSRFTokenHandlingApi;

public class XCSRFTokenHandlingApiExample {

    public static void main(String[] args) {
        XCSRFTokenHandlingApi apiInstance = new XCSRFTokenHandlingApi();
        String xCSRFToken = xCSRFToken_example; // String | To generate a new X-CSRF token, set the value of the header to 'Fetch'. This token can be used within the same session, for all requests excluding GET.
        try {
            apiInstance.rootGet(xCSRFToken);
        } catch (ApiException e) {
            System.err.println("Exception when calling XCSRFTokenHandlingApi#rootGet");
            e.printStackTrace();
        }
    }
}
String *xCSRFToken = xCSRFToken_example; // To generate a new X-CSRF token, set the value of the header to 'Fetch'. This token can be used within the same session, for all requests excluding GET.

XCSRFTokenHandlingApi *apiInstance = [[XCSRFTokenHandlingApi alloc] init];

// Generates an X-CSRF token for this session.
[apiInstance rootGetWith:xCSRFToken
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
//For sending body with API calls
var data = JSON.stringify({
  "context": {},
  "definitionId": "string"
});
//When no body is to be passed
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = false;

xhr.addEventListener('readystatechange', function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
	var res = this.responseText;
  }
});

//setting request method
//API endpoint for API sandbox 

xhr.open('set request method', "https://cpdc<account>.<host>/cpdc/odata/v1/");
xhr.withCredentials = true;
xhr.setRequestHeader('Content-Type', 'application/json');
xhr.setRequestHeader('Authorization', 'Basic ' + 'Base64 encoded value'));
//When X-CSRF-Token is required
xhr.setRequestHeader("X-CSRF-Token", "string");
xhr.send(data);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class rootGetExample
    {
        public void main()
        {
            
            var apiInstance = new XCSRFTokenHandlingApi();
            var xCSRFToken = xCSRFToken_example;  // String | To generate a new X-CSRF token, set the value of the header to 'Fetch'. This token can be used within the same session, for all requests excluding GET.

            try
            {
                // Generates an X-CSRF token for this session.
                apiInstance.rootGet(xCSRFToken);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling XCSRFTokenHandlingApi.rootGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\XCSRFTokenHandlingApi();
$xCSRFToken = xCSRFToken_example; // String | To generate a new X-CSRF token, set the value of the header to 'Fetch'. This token can be used within the same session, for all requests excluding GET.

try {
    $api_instance->rootGet($xCSRFToken);
} catch (Exception $e) {
    echo 'Exception when calling XCSRFTokenHandlingApi->rootGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::XCSRFTokenHandlingApi;

my $api_instance = WWW::SwaggerClient::XCSRFTokenHandlingApi->new();
my $xCSRFToken = xCSRFToken_example; # String | To generate a new X-CSRF token, set the value of the header to 'Fetch'. This token can be used within the same session, for all requests excluding GET.

eval { 
    $api_instance->rootGet(xCSRFToken => $xCSRFToken);
};
if ($@) {
    warn "Exception when calling XCSRFTokenHandlingApi->rootGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.XCSRFTokenHandlingApi()
xCSRFToken = xCSRFToken_example # String | To generate a new X-CSRF token, set the value of the header to 'Fetch'. This token can be used within the same session, for all requests excluding GET.

try: 
    # Generates an X-CSRF token for this session.
    api_instance.rootGet(xCSRFToken)
except ApiException as e:
    print("Exception when calling XCSRFTokenHandlingApi->rootGet: %s\n" % e)
DATA: lo_http_client TYPE REF TO if_http_client.
DATA: response TYPE string.

CALL METHOD cl_http_client=>create_by_url
  EXPORTING
    url                = 'https://cpdc<account>.<host>/cpdc/odata/v1/'

  IMPORTING
    client             = lo_http_client
  EXCEPTIONS
    argument_not_found = 1
    plugin_not_active  = 2
    internal_error     = 3
    OTHERS             = 4.
               
IF sy-subrc <> 0.
//error handling.
ENDIF.

//setting request method.
lo_http_client->request->set_method('set request method');.

//adding headers.
lo_http_client->request->set_header_field( name = 'Content-Type' value = 'application/json' ).

//Basic Auth : provide username:password in Base64 encoded in Authorization header.
lo_http_client->request->set_header_field( name = 'Authorization' value = 'Basic Base64 encoded value' ).

//For passing body with the request.
lv_json_post_data = | \{ | &&

                    |   "string":"string", | &&

                    |   "string":"string" | &&
                    | \} |.
                    
//For request where body is to be passed.
CALL METHOD lo_http_client1->request->set_data( lv_json_post_data ).
CALL METHOD lo_http_client->send
  EXCEPTIONS
    http_communication_failure = 1
    http_invalid_state         = 2
    http_processing_failed     = 3
    http_invalid_timeout       = 4
    OTHERS                     = 5.

IF sy-subrc = 0.
  CALL METHOD lo_http_client->receive
    EXCEPTIONS
      http_communication_failure = 1
      http_invalid_state         = 2
      http_processing_failed     = 3
      OTHERS                     = 5.
ENDIF.

IF sy-subrc <> 0.
 //error handling.
ENDIF.

response = lo_http_client->response->get_cdata( ).

WRITE: 'response: ', response. 

Parameters

Header parameters
Name Description
X-CSRF-Token*

Responses

Status: 200 - OK

Name Type Format Description
X-CSRF-Token String X-CSRF token

Status: 403 - Forbidden. You do not have a valid X-CSRF token.

Status: 500 - Internal system error. Please contact technical support.


Generated 2019-11-19T17:26:11.011+05:30