PIIPE API

Comments

commentCidDelete

Delete a comment.


/comment/{cid}

Usage and SDK Samples

curl -X DELETE \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://nextworkplace.staging/api/v1/comment/{cid}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommentsApi;

import java.io.File;
import java.util.*;

public class CommentsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        CommentsApi apiInstance = new CommentsApi();
        Integer cid = 42; // Integer | The comment ID.

        try {
            apiInstance.commentCidDelete(cid);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentsApi#commentCidDelete");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer cid = new Integer(); // Integer | The comment ID.

try {
    final result = await api_instance.commentCidDelete(cid);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->commentCidDelete: $e\n');
}

import org.openapitools.client.api.CommentsApi;

public class CommentsApiExample {
    public static void main(String[] args) {
        CommentsApi apiInstance = new CommentsApi();
        Integer cid = 42; // Integer | The comment ID.

        try {
            apiInstance.commentCidDelete(cid);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentsApi#commentCidDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
CommentsApi *apiInstance = [[CommentsApi alloc] init];
Integer *cid = 42; // The comment ID. (default to null)

// Delete a comment.
[apiInstance commentCidDeleteWith:cid
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.CommentsApi()
var cid = 42; // {Integer} The comment ID.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.commentCidDelete(cid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class commentCidDeleteExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CommentsApi();
            var cid = 42;  // Integer | The comment ID. (default to null)

            try {
                // Delete a comment.
                apiInstance.commentCidDelete(cid);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommentsApi.commentCidDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommentsApi();
$cid = 42; // Integer | The comment ID.

try {
    $api_instance->commentCidDelete($cid);
} catch (Exception $e) {
    echo 'Exception when calling CommentsApi->commentCidDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommentsApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommentsApi->new();
my $cid = 42; # Integer | The comment ID.

eval {
    $api_instance->commentCidDelete(cid => $cid);
};
if ($@) {
    warn "Exception when calling CommentsApi->commentCidDelete: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CommentsApi()
cid = 42 # Integer | The comment ID. (default to null)

try:
    # Delete a comment.
    api_instance.comment_cid_delete(cid)
except ApiException as e:
    print("Exception when calling CommentsApi->commentCidDelete: %s\n" % e)
extern crate CommentsApi;

pub fn main() {
    let cid = 42; // Integer

    let mut context = CommentsApi::Context::default();
    let result = client.commentCidDelete(cid, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
cid*
Integer
The comment ID.
Required

Responses


commentCidPatch

Edit a comment (Note: this endpoint doesn't have the prefix /api/v1 in the base URL).

Edit a comment. To like/unlike a comment, use the endpoint **/piipe_flags/flag** and pass the following body: ``` {"flag_id": "comments_like", "entity_type": "comment", "entity_id": CID, "action": "flag"} ``` Where CID is the comment ID, *action* can be either "flag" or "unflag" and *entity_type* can be either "comment" or "discussion_comments". To report a comment, use the same body as above with "flag_id": "comment_report" (example: {"flag_id": "comment_report", "entity_type": "comment", "entity_id": CID, "action": "flag"}).


/comment/{cid}

Usage and SDK Samples

curl -X PATCH \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://nextworkplace.staging/api/v1/comment/{cid}" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommentsApi;

import java.io.File;
import java.util.*;

public class CommentsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        CommentsApi apiInstance = new CommentsApi();
        Integer cid = 42; // Integer | The comment ID.
        CommentRequest commentRequest = ; // CommentRequest | Request body for editing a comment.

        try {
            Comment result = apiInstance.commentCidPatch(cid, commentRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentsApi#commentCidPatch");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer cid = new Integer(); // Integer | The comment ID.
final CommentRequest commentRequest = new CommentRequest(); // CommentRequest | Request body for editing a comment.

try {
    final result = await api_instance.commentCidPatch(cid, commentRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->commentCidPatch: $e\n');
}

import org.openapitools.client.api.CommentsApi;

public class CommentsApiExample {
    public static void main(String[] args) {
        CommentsApi apiInstance = new CommentsApi();
        Integer cid = 42; // Integer | The comment ID.
        CommentRequest commentRequest = ; // CommentRequest | Request body for editing a comment.

        try {
            Comment result = apiInstance.commentCidPatch(cid, commentRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentsApi#commentCidPatch");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
CommentsApi *apiInstance = [[CommentsApi alloc] init];
Integer *cid = 42; // The comment ID. (default to null)
CommentRequest *commentRequest = ; // Request body for editing a comment.

// Edit a comment (Note: this endpoint doesn't have the prefix /api/v1 in the base URL).
[apiInstance commentCidPatchWith:cid
    commentRequest:commentRequest
              completionHandler: ^(Comment output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.CommentsApi()
var cid = 42; // {Integer} The comment ID.
var commentRequest = ; // {CommentRequest} Request body for editing a comment.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.commentCidPatch(cid, commentRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class commentCidPatchExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CommentsApi();
            var cid = 42;  // Integer | The comment ID. (default to null)
            var commentRequest = new CommentRequest(); // CommentRequest | Request body for editing a comment.

            try {
                // Edit a comment (Note: this endpoint doesn't have the prefix /api/v1 in the base URL).
                Comment result = apiInstance.commentCidPatch(cid, commentRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommentsApi.commentCidPatch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommentsApi();
$cid = 42; // Integer | The comment ID.
$commentRequest = ; // CommentRequest | Request body for editing a comment.

try {
    $result = $api_instance->commentCidPatch($cid, $commentRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommentsApi->commentCidPatch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommentsApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommentsApi->new();
my $cid = 42; # Integer | The comment ID.
my $commentRequest = WWW::OPenAPIClient::Object::CommentRequest->new(); # CommentRequest | Request body for editing a comment.

eval {
    my $result = $api_instance->commentCidPatch(cid => $cid, commentRequest => $commentRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommentsApi->commentCidPatch: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CommentsApi()
cid = 42 # Integer | The comment ID. (default to null)
commentRequest =  # CommentRequest | Request body for editing a comment.

try:
    # Edit a comment (Note: this endpoint doesn't have the prefix /api/v1 in the base URL).
    api_response = api_instance.comment_cid_patch(cid, commentRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommentsApi->commentCidPatch: %s\n" % e)
extern crate CommentsApi;

pub fn main() {
    let cid = 42; // Integer
    let commentRequest = ; // CommentRequest

    let mut context = CommentsApi::Context::default();
    let result = client.commentCidPatch(cid, commentRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
cid*
Integer
The comment ID.
Required
Body parameters
Name Description
commentRequest *

Responses


commentPost

Create a new comment (Note: this endpoint doesn't have the prefix /api/v1 in the base URL).


/comment

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://nextworkplace.staging/api/v1/comment" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommentsApi;

import java.io.File;
import java.util.*;

public class CommentsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        CommentsApi apiInstance = new CommentsApi();
        CommentPostRequest commentPostRequest = ; // CommentPostRequest | 

        try {
            Comment result = apiInstance.commentPost(commentPostRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentsApi#commentPost");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final CommentPostRequest commentPostRequest = new CommentPostRequest(); // CommentPostRequest | 

try {
    final result = await api_instance.commentPost(commentPostRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->commentPost: $e\n');
}

import org.openapitools.client.api.CommentsApi;

public class CommentsApiExample {
    public static void main(String[] args) {
        CommentsApi apiInstance = new CommentsApi();
        CommentPostRequest commentPostRequest = ; // CommentPostRequest | 

        try {
            Comment result = apiInstance.commentPost(commentPostRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentsApi#commentPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
CommentsApi *apiInstance = [[CommentsApi alloc] init];
CommentPostRequest *commentPostRequest = ; // 

// Create a new comment (Note: this endpoint doesn't have the prefix /api/v1 in the base URL).
[apiInstance commentPostWith:commentPostRequest
              completionHandler: ^(Comment output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.CommentsApi()
var commentPostRequest = ; // {CommentPostRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.commentPost(commentPostRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class commentPostExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CommentsApi();
            var commentPostRequest = new CommentPostRequest(); // CommentPostRequest | 

            try {
                // Create a new comment (Note: this endpoint doesn't have the prefix /api/v1 in the base URL).
                Comment result = apiInstance.commentPost(commentPostRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommentsApi.commentPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommentsApi();
$commentPostRequest = ; // CommentPostRequest | 

try {
    $result = $api_instance->commentPost($commentPostRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommentsApi->commentPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommentsApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommentsApi->new();
my $commentPostRequest = WWW::OPenAPIClient::Object::CommentPostRequest->new(); # CommentPostRequest | 

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CommentsApi()
commentPostRequest =  # CommentPostRequest | 

try:
    # Create a new comment (Note: this endpoint doesn't have the prefix /api/v1 in the base URL).
    api_response = api_instance.comment_post(commentPostRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommentsApi->commentPost: %s\n" % e)
extern crate CommentsApi;

pub fn main() {
    let commentPostRequest = ; // CommentPostRequest

    let mut context = CommentsApi::Context::default();
    let result = client.commentPost(commentPostRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
commentPostRequest *

Responses


piipeCommentsCidGet

Get a comment.


/piipe_comments/{cid}

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/piipe_comments/{cid}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommentsApi;

import java.io.File;
import java.util.*;

public class CommentsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        CommentsApi apiInstance = new CommentsApi();
        Integer cid = 42; // Integer | Comment ID.

        try {
            Comment result = apiInstance.piipeCommentsCidGet(cid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentsApi#piipeCommentsCidGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer cid = new Integer(); // Integer | Comment ID.

try {
    final result = await api_instance.piipeCommentsCidGet(cid);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->piipeCommentsCidGet: $e\n');
}

import org.openapitools.client.api.CommentsApi;

public class CommentsApiExample {
    public static void main(String[] args) {
        CommentsApi apiInstance = new CommentsApi();
        Integer cid = 42; // Integer | Comment ID.

        try {
            Comment result = apiInstance.piipeCommentsCidGet(cid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentsApi#piipeCommentsCidGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
CommentsApi *apiInstance = [[CommentsApi alloc] init];
Integer *cid = 42; // Comment ID. (default to null)

// Get a comment.
[apiInstance piipeCommentsCidGetWith:cid
              completionHandler: ^(Comment output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.CommentsApi()
var cid = 42; // {Integer} Comment ID.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.piipeCommentsCidGet(cid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class piipeCommentsCidGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CommentsApi();
            var cid = 42;  // Integer | Comment ID. (default to null)

            try {
                // Get a comment.
                Comment result = apiInstance.piipeCommentsCidGet(cid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommentsApi.piipeCommentsCidGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommentsApi();
$cid = 42; // Integer | Comment ID.

try {
    $result = $api_instance->piipeCommentsCidGet($cid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommentsApi->piipeCommentsCidGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommentsApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommentsApi->new();
my $cid = 42; # Integer | Comment ID.

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CommentsApi()
cid = 42 # Integer | Comment ID. (default to null)

try:
    # Get a comment.
    api_response = api_instance.piipe_comments_cid_get(cid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommentsApi->piipeCommentsCidGet: %s\n" % e)
extern crate CommentsApi;

pub fn main() {
    let cid = 42; // Integer

    let mut context = CommentsApi::Context::default();
    let result = client.piipeCommentsCidGet(cid, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
cid*
Integer
Comment ID.
Required

Responses


piipeCommentsListGet

List comments / load answers

Lists root comments (or top-level discussion threads) with initial answers, or when cid & answer_page are provided returns paged answers for a specific comment.


/piipe_comments/list

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/piipe_comments/list?page=56&sort_dir=sortDir_example&sort_by=sortBy_example&entity_id=56&comment_type=commentType_example&nid=56&gid=56&cid=56&answer_page=56&exclude=exclude_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommentsApi;

import java.io.File;
import java.util.*;

public class CommentsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        CommentsApi apiInstance = new CommentsApi();
        Integer entityId = 56; // Integer | ID of the commented entity (node, discussion, etc.).
        String commentType = commentType_example; // String | Comment type machine name.
        Integer page = 56; // Integer | Page index for pagination.
        String sortDir = sortDir_example; // String | Sort direction.
        String sortBy = sortBy_example; // String | Sort criterion.
        Integer nid = 56; // Integer | Node ID (required when targeting a discussion in a node, and requires comment_type to be "discussion_comments").
        Integer gid = 56; // Integer | Community ID (required when targeting a discussion in a community, and requires comment_type to be "discussion_comments").
        Integer cid = 56; // Integer | Comment ID whose answers should be loaded and paged (requires answer_page).
        Integer answerPage = 56; // Integer | Page index for answers (requires cid).
        String exclude = exclude_example; // String | JSON encoded structure of already loaded comment IDs keyed by parent.

        try {
            Comments-List-Response result = apiInstance.piipeCommentsListGet(entityId, commentType, page, sortDir, sortBy, nid, gid, cid, answerPage, exclude);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentsApi#piipeCommentsListGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer entityId = new Integer(); // Integer | ID of the commented entity (node, discussion, etc.).
final String commentType = new String(); // String | Comment type machine name.
final Integer page = new Integer(); // Integer | Page index for pagination.
final String sortDir = new String(); // String | Sort direction.
final String sortBy = new String(); // String | Sort criterion.
final Integer nid = new Integer(); // Integer | Node ID (required when targeting a discussion in a node, and requires comment_type to be "discussion_comments").
final Integer gid = new Integer(); // Integer | Community ID (required when targeting a discussion in a community, and requires comment_type to be "discussion_comments").
final Integer cid = new Integer(); // Integer | Comment ID whose answers should be loaded and paged (requires answer_page).
final Integer answerPage = new Integer(); // Integer | Page index for answers (requires cid).
final String exclude = new String(); // String | JSON encoded structure of already loaded comment IDs keyed by parent.

try {
    final result = await api_instance.piipeCommentsListGet(entityId, commentType, page, sortDir, sortBy, nid, gid, cid, answerPage, exclude);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->piipeCommentsListGet: $e\n');
}

import org.openapitools.client.api.CommentsApi;

public class CommentsApiExample {
    public static void main(String[] args) {
        CommentsApi apiInstance = new CommentsApi();
        Integer entityId = 56; // Integer | ID of the commented entity (node, discussion, etc.).
        String commentType = commentType_example; // String | Comment type machine name.
        Integer page = 56; // Integer | Page index for pagination.
        String sortDir = sortDir_example; // String | Sort direction.
        String sortBy = sortBy_example; // String | Sort criterion.
        Integer nid = 56; // Integer | Node ID (required when targeting a discussion in a node, and requires comment_type to be "discussion_comments").
        Integer gid = 56; // Integer | Community ID (required when targeting a discussion in a community, and requires comment_type to be "discussion_comments").
        Integer cid = 56; // Integer | Comment ID whose answers should be loaded and paged (requires answer_page).
        Integer answerPage = 56; // Integer | Page index for answers (requires cid).
        String exclude = exclude_example; // String | JSON encoded structure of already loaded comment IDs keyed by parent.

        try {
            Comments-List-Response result = apiInstance.piipeCommentsListGet(entityId, commentType, page, sortDir, sortBy, nid, gid, cid, answerPage, exclude);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentsApi#piipeCommentsListGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
CommentsApi *apiInstance = [[CommentsApi alloc] init];
Integer *entityId = 56; // ID of the commented entity (node, discussion, etc.). (default to null)
String *commentType = commentType_example; // Comment type machine name. (default to null)
Integer *page = 56; // Page index for pagination. (optional) (default to 0)
String *sortDir = sortDir_example; // Sort direction. (optional) (default to DESC)
String *sortBy = sortBy_example; // Sort criterion. (optional) (default to null)
Integer *nid = 56; // Node ID (required when targeting a discussion in a node, and requires comment_type to be "discussion_comments"). (optional) (default to null)
Integer *gid = 56; // Community ID (required when targeting a discussion in a community, and requires comment_type to be "discussion_comments"). (optional) (default to null)
Integer *cid = 56; // Comment ID whose answers should be loaded and paged (requires answer_page). (optional) (default to null)
Integer *answerPage = 56; // Page index for answers (requires cid). (optional) (default to null)
String *exclude = exclude_example; // JSON encoded structure of already loaded comment IDs keyed by parent. (optional) (default to null)

// List comments / load answers
[apiInstance piipeCommentsListGetWith:entityId
    commentType:commentType
    page:page
    sortDir:sortDir
    sortBy:sortBy
    nid:nid
    gid:gid
    cid:cid
    answerPage:answerPage
    exclude:exclude
              completionHandler: ^(Comments-List-Response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.CommentsApi()
var entityId = 56; // {Integer} ID of the commented entity (node, discussion, etc.).
var commentType = commentType_example; // {String} Comment type machine name.
var opts = {
  'page': 56, // {Integer} Page index for pagination.
  'sortDir': sortDir_example, // {String} Sort direction.
  'sortBy': sortBy_example, // {String} Sort criterion.
  'nid': 56, // {Integer} Node ID (required when targeting a discussion in a node, and requires comment_type to be "discussion_comments").
  'gid': 56, // {Integer} Community ID (required when targeting a discussion in a community, and requires comment_type to be "discussion_comments").
  'cid': 56, // {Integer} Comment ID whose answers should be loaded and paged (requires answer_page).
  'answerPage': 56, // {Integer} Page index for answers (requires cid).
  'exclude': exclude_example // {String} JSON encoded structure of already loaded comment IDs keyed by parent.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.piipeCommentsListGet(entityId, commentType, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class piipeCommentsListGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CommentsApi();
            var entityId = 56;  // Integer | ID of the commented entity (node, discussion, etc.). (default to null)
            var commentType = commentType_example;  // String | Comment type machine name. (default to null)
            var page = 56;  // Integer | Page index for pagination. (optional)  (default to 0)
            var sortDir = sortDir_example;  // String | Sort direction. (optional)  (default to DESC)
            var sortBy = sortBy_example;  // String | Sort criterion. (optional)  (default to null)
            var nid = 56;  // Integer | Node ID (required when targeting a discussion in a node, and requires comment_type to be "discussion_comments"). (optional)  (default to null)
            var gid = 56;  // Integer | Community ID (required when targeting a discussion in a community, and requires comment_type to be "discussion_comments"). (optional)  (default to null)
            var cid = 56;  // Integer | Comment ID whose answers should be loaded and paged (requires answer_page). (optional)  (default to null)
            var answerPage = 56;  // Integer | Page index for answers (requires cid). (optional)  (default to null)
            var exclude = exclude_example;  // String | JSON encoded structure of already loaded comment IDs keyed by parent. (optional)  (default to null)

            try {
                // List comments / load answers
                Comments-List-Response result = apiInstance.piipeCommentsListGet(entityId, commentType, page, sortDir, sortBy, nid, gid, cid, answerPage, exclude);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommentsApi.piipeCommentsListGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommentsApi();
$entityId = 56; // Integer | ID of the commented entity (node, discussion, etc.).
$commentType = commentType_example; // String | Comment type machine name.
$page = 56; // Integer | Page index for pagination.
$sortDir = sortDir_example; // String | Sort direction.
$sortBy = sortBy_example; // String | Sort criterion.
$nid = 56; // Integer | Node ID (required when targeting a discussion in a node, and requires comment_type to be "discussion_comments").
$gid = 56; // Integer | Community ID (required when targeting a discussion in a community, and requires comment_type to be "discussion_comments").
$cid = 56; // Integer | Comment ID whose answers should be loaded and paged (requires answer_page).
$answerPage = 56; // Integer | Page index for answers (requires cid).
$exclude = exclude_example; // String | JSON encoded structure of already loaded comment IDs keyed by parent.

try {
    $result = $api_instance->piipeCommentsListGet($entityId, $commentType, $page, $sortDir, $sortBy, $nid, $gid, $cid, $answerPage, $exclude);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommentsApi->piipeCommentsListGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommentsApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommentsApi->new();
my $entityId = 56; # Integer | ID of the commented entity (node, discussion, etc.).
my $commentType = commentType_example; # String | Comment type machine name.
my $page = 56; # Integer | Page index for pagination.
my $sortDir = sortDir_example; # String | Sort direction.
my $sortBy = sortBy_example; # String | Sort criterion.
my $nid = 56; # Integer | Node ID (required when targeting a discussion in a node, and requires comment_type to be "discussion_comments").
my $gid = 56; # Integer | Community ID (required when targeting a discussion in a community, and requires comment_type to be "discussion_comments").
my $cid = 56; # Integer | Comment ID whose answers should be loaded and paged (requires answer_page).
my $answerPage = 56; # Integer | Page index for answers (requires cid).
my $exclude = exclude_example; # String | JSON encoded structure of already loaded comment IDs keyed by parent.

eval {
    my $result = $api_instance->piipeCommentsListGet(entityId => $entityId, commentType => $commentType, page => $page, sortDir => $sortDir, sortBy => $sortBy, nid => $nid, gid => $gid, cid => $cid, answerPage => $answerPage, exclude => $exclude);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommentsApi->piipeCommentsListGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CommentsApi()
entityId = 56 # Integer | ID of the commented entity (node, discussion, etc.). (default to null)
commentType = commentType_example # String | Comment type machine name. (default to null)
page = 56 # Integer | Page index for pagination. (optional) (default to 0)
sortDir = sortDir_example # String | Sort direction. (optional) (default to DESC)
sortBy = sortBy_example # String | Sort criterion. (optional) (default to null)
nid = 56 # Integer | Node ID (required when targeting a discussion in a node, and requires comment_type to be "discussion_comments"). (optional) (default to null)
gid = 56 # Integer | Community ID (required when targeting a discussion in a community, and requires comment_type to be "discussion_comments"). (optional) (default to null)
cid = 56 # Integer | Comment ID whose answers should be loaded and paged (requires answer_page). (optional) (default to null)
answerPage = 56 # Integer | Page index for answers (requires cid). (optional) (default to null)
exclude = exclude_example # String | JSON encoded structure of already loaded comment IDs keyed by parent. (optional) (default to null)

try:
    # List comments / load answers
    api_response = api_instance.piipe_comments_list_get(entityId, commentType, page=page, sortDir=sortDir, sortBy=sortBy, nid=nid, gid=gid, cid=cid, answerPage=answerPage, exclude=exclude)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommentsApi->piipeCommentsListGet: %s\n" % e)
extern crate CommentsApi;

pub fn main() {
    let entityId = 56; // Integer
    let commentType = commentType_example; // String
    let page = 56; // Integer
    let sortDir = sortDir_example; // String
    let sortBy = sortBy_example; // String
    let nid = 56; // Integer
    let gid = 56; // Integer
    let cid = 56; // Integer
    let answerPage = 56; // Integer
    let exclude = exclude_example; // String

    let mut context = CommentsApi::Context::default();
    let result = client.piipeCommentsListGet(entityId, commentType, page, sortDir, sortBy, nid, gid, cid, answerPage, exclude, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
page
Integer
Page index for pagination.
sort_dir
String
Sort direction.
sort_by
String
Sort criterion.
entity_id*
Integer
ID of the commented entity (node, discussion, etc.).
Required
comment_type*
String
Comment type machine name.
Required
nid
Integer
Node ID (required when targeting a discussion in a node, and requires comment_type to be "discussion_comments").
gid
Integer
Community ID (required when targeting a discussion in a community, and requires comment_type to be "discussion_comments").
cid
Integer
Comment ID whose answers should be loaded and paged (requires answer_page).
answer_page
Integer
Page index for answers (requires cid).
exclude
String
JSON encoded structure of already loaded comment IDs keyed by parent.

Responses


piipeCommentsMediaPost

Upload media (chunked)

Chunked upload endpoint creating File & Media entities. Returns partial status until final chunk.


/piipe_comments/media

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://nextworkplace.staging/api/v1/piipe_comments/media" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommentsApi;

import java.io.File;
import java.util.*;

public class CommentsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        CommentsApi apiInstance = new CommentsApi();
        PiipeCommentsMediaPostRequest piipeCommentsMediaPostRequest = ; // PiipeCommentsMediaPostRequest | 

        try {
            _piipe_comments_media_post_200_response result = apiInstance.piipeCommentsMediaPost(piipeCommentsMediaPostRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentsApi#piipeCommentsMediaPost");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final PiipeCommentsMediaPostRequest piipeCommentsMediaPostRequest = new PiipeCommentsMediaPostRequest(); // PiipeCommentsMediaPostRequest | 

try {
    final result = await api_instance.piipeCommentsMediaPost(piipeCommentsMediaPostRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->piipeCommentsMediaPost: $e\n');
}

import org.openapitools.client.api.CommentsApi;

public class CommentsApiExample {
    public static void main(String[] args) {
        CommentsApi apiInstance = new CommentsApi();
        PiipeCommentsMediaPostRequest piipeCommentsMediaPostRequest = ; // PiipeCommentsMediaPostRequest | 

        try {
            _piipe_comments_media_post_200_response result = apiInstance.piipeCommentsMediaPost(piipeCommentsMediaPostRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentsApi#piipeCommentsMediaPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
CommentsApi *apiInstance = [[CommentsApi alloc] init];
PiipeCommentsMediaPostRequest *piipeCommentsMediaPostRequest = ; // 

// Upload media (chunked)
[apiInstance piipeCommentsMediaPostWith:piipeCommentsMediaPostRequest
              completionHandler: ^(_piipe_comments_media_post_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.CommentsApi()
var piipeCommentsMediaPostRequest = ; // {PiipeCommentsMediaPostRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.piipeCommentsMediaPost(piipeCommentsMediaPostRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class piipeCommentsMediaPostExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CommentsApi();
            var piipeCommentsMediaPostRequest = new PiipeCommentsMediaPostRequest(); // PiipeCommentsMediaPostRequest | 

            try {
                // Upload media (chunked)
                _piipe_comments_media_post_200_response result = apiInstance.piipeCommentsMediaPost(piipeCommentsMediaPostRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommentsApi.piipeCommentsMediaPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommentsApi();
$piipeCommentsMediaPostRequest = ; // PiipeCommentsMediaPostRequest | 

try {
    $result = $api_instance->piipeCommentsMediaPost($piipeCommentsMediaPostRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommentsApi->piipeCommentsMediaPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommentsApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommentsApi->new();
my $piipeCommentsMediaPostRequest = WWW::OPenAPIClient::Object::PiipeCommentsMediaPostRequest->new(); # PiipeCommentsMediaPostRequest | 

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CommentsApi()
piipeCommentsMediaPostRequest =  # PiipeCommentsMediaPostRequest | 

try:
    # Upload media (chunked)
    api_response = api_instance.piipe_comments_media_post(piipeCommentsMediaPostRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommentsApi->piipeCommentsMediaPost: %s\n" % e)
extern crate CommentsApi;

pub fn main() {
    let piipeCommentsMediaPostRequest = ; // PiipeCommentsMediaPostRequest

    let mut context = CommentsApi::Context::default();
    let result = client.piipeCommentsMediaPost(piipeCommentsMediaPostRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
piipeCommentsMediaPostRequest *

Responses


piipeCommentsMentionPost

Get user mention suggestions

Returns up to 25 users whose display name begins with the provided text. If duplicate display names exist, the email is appended.


/piipe_comments/mention

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://nextworkplace.staging/api/v1/piipe_comments/mention" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommentsApi;

import java.io.File;
import java.util.*;

public class CommentsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        CommentsApi apiInstance = new CommentsApi();
        PiipeCommentsMentionPostRequest piipeCommentsMentionPostRequest = ; // PiipeCommentsMentionPostRequest | 

        try {
            array[Mention-User] result = apiInstance.piipeCommentsMentionPost(piipeCommentsMentionPostRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentsApi#piipeCommentsMentionPost");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final PiipeCommentsMentionPostRequest piipeCommentsMentionPostRequest = new PiipeCommentsMentionPostRequest(); // PiipeCommentsMentionPostRequest | 

try {
    final result = await api_instance.piipeCommentsMentionPost(piipeCommentsMentionPostRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->piipeCommentsMentionPost: $e\n');
}

import org.openapitools.client.api.CommentsApi;

public class CommentsApiExample {
    public static void main(String[] args) {
        CommentsApi apiInstance = new CommentsApi();
        PiipeCommentsMentionPostRequest piipeCommentsMentionPostRequest = ; // PiipeCommentsMentionPostRequest | 

        try {
            array[Mention-User] result = apiInstance.piipeCommentsMentionPost(piipeCommentsMentionPostRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentsApi#piipeCommentsMentionPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
CommentsApi *apiInstance = [[CommentsApi alloc] init];
PiipeCommentsMentionPostRequest *piipeCommentsMentionPostRequest = ; // 

// Get user mention suggestions
[apiInstance piipeCommentsMentionPostWith:piipeCommentsMentionPostRequest
              completionHandler: ^(array[Mention-User] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.CommentsApi()
var piipeCommentsMentionPostRequest = ; // {PiipeCommentsMentionPostRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.piipeCommentsMentionPost(piipeCommentsMentionPostRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class piipeCommentsMentionPostExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CommentsApi();
            var piipeCommentsMentionPostRequest = new PiipeCommentsMentionPostRequest(); // PiipeCommentsMentionPostRequest | 

            try {
                // Get user mention suggestions
                array[Mention-User] result = apiInstance.piipeCommentsMentionPost(piipeCommentsMentionPostRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommentsApi.piipeCommentsMentionPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommentsApi();
$piipeCommentsMentionPostRequest = ; // PiipeCommentsMentionPostRequest | 

try {
    $result = $api_instance->piipeCommentsMentionPost($piipeCommentsMentionPostRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommentsApi->piipeCommentsMentionPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommentsApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommentsApi->new();
my $piipeCommentsMentionPostRequest = WWW::OPenAPIClient::Object::PiipeCommentsMentionPostRequest->new(); # PiipeCommentsMentionPostRequest | 

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CommentsApi()
piipeCommentsMentionPostRequest =  # PiipeCommentsMentionPostRequest | 

try:
    # Get user mention suggestions
    api_response = api_instance.piipe_comments_mention_post(piipeCommentsMentionPostRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommentsApi->piipeCommentsMentionPost: %s\n" % e)
extern crate CommentsApi;

pub fn main() {
    let piipeCommentsMentionPostRequest = ; // PiipeCommentsMentionPostRequest

    let mut context = CommentsApi::Context::default();
    let result = client.piipeCommentsMentionPost(piipeCommentsMentionPostRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
piipeCommentsMentionPostRequest *

Responses


piipeCommentsThreadTraceCidGet

Get thread trace for a comment

Returns the chain from a comment to its root plus sibling context.


/piipe_comments/thread-trace/{cid}

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/piipe_comments/thread-trace/{cid}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommentsApi;

import java.io.File;
import java.util.*;

public class CommentsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        CommentsApi apiInstance = new CommentsApi();
        Integer cid = 56; // Integer | Comment ID.

        try {
            Thread-Trace-Response result = apiInstance.piipeCommentsThreadTraceCidGet(cid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentsApi#piipeCommentsThreadTraceCidGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer cid = new Integer(); // Integer | Comment ID.

try {
    final result = await api_instance.piipeCommentsThreadTraceCidGet(cid);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->piipeCommentsThreadTraceCidGet: $e\n');
}

import org.openapitools.client.api.CommentsApi;

public class CommentsApiExample {
    public static void main(String[] args) {
        CommentsApi apiInstance = new CommentsApi();
        Integer cid = 56; // Integer | Comment ID.

        try {
            Thread-Trace-Response result = apiInstance.piipeCommentsThreadTraceCidGet(cid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentsApi#piipeCommentsThreadTraceCidGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
CommentsApi *apiInstance = [[CommentsApi alloc] init];
Integer *cid = 56; // Comment ID. (default to null)

// Get thread trace for a comment
[apiInstance piipeCommentsThreadTraceCidGetWith:cid
              completionHandler: ^(Thread-Trace-Response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.CommentsApi()
var cid = 56; // {Integer} Comment ID.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.piipeCommentsThreadTraceCidGet(cid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class piipeCommentsThreadTraceCidGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CommentsApi();
            var cid = 56;  // Integer | Comment ID. (default to null)

            try {
                // Get thread trace for a comment
                Thread-Trace-Response result = apiInstance.piipeCommentsThreadTraceCidGet(cid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommentsApi.piipeCommentsThreadTraceCidGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommentsApi();
$cid = 56; // Integer | Comment ID.

try {
    $result = $api_instance->piipeCommentsThreadTraceCidGet($cid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommentsApi->piipeCommentsThreadTraceCidGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommentsApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommentsApi->new();
my $cid = 56; # Integer | Comment ID.

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CommentsApi()
cid = 56 # Integer | Comment ID. (default to null)

try:
    # Get thread trace for a comment
    api_response = api_instance.piipe_comments_thread_trace_cid_get(cid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommentsApi->piipeCommentsThreadTraceCidGet: %s\n" % e)
extern crate CommentsApi;

pub fn main() {
    let cid = 56; // Integer

    let mut context = CommentsApi::Context::default();
    let result = client.piipeCommentsThreadTraceCidGet(cid, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
cid*
Integer
Comment ID.
Required

Responses


Community

communityGidDelete

Delete a community by ID


/community/{gid}

Usage and SDK Samples

curl -X DELETE \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://nextworkplace.staging/api/v1/community/{gid}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommunityApi;

import java.io.File;
import java.util.*;

public class CommunityApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        CommunityApi apiInstance = new CommunityApi();
        String gid = gid_example; // String | Community ID

        try {
            apiInstance.communityGidDelete(gid);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommunityApi#communityGidDelete");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String gid = new String(); // String | Community ID

try {
    final result = await api_instance.communityGidDelete(gid);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->communityGidDelete: $e\n');
}

import org.openapitools.client.api.CommunityApi;

public class CommunityApiExample {
    public static void main(String[] args) {
        CommunityApi apiInstance = new CommunityApi();
        String gid = gid_example; // String | Community ID

        try {
            apiInstance.communityGidDelete(gid);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommunityApi#communityGidDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
CommunityApi *apiInstance = [[CommunityApi alloc] init];
String *gid = gid_example; // Community ID (default to null)

// Delete a community by ID
[apiInstance communityGidDeleteWith:gid
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.CommunityApi()
var gid = gid_example; // {String} Community ID

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.communityGidDelete(gid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class communityGidDeleteExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CommunityApi();
            var gid = gid_example;  // String | Community ID (default to null)

            try {
                // Delete a community by ID
                apiInstance.communityGidDelete(gid);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommunityApi.communityGidDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommunityApi();
$gid = gid_example; // String | Community ID

try {
    $api_instance->communityGidDelete($gid);
} catch (Exception $e) {
    echo 'Exception when calling CommunityApi->communityGidDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommunityApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommunityApi->new();
my $gid = gid_example; # String | Community ID

eval {
    $api_instance->communityGidDelete(gid => $gid);
};
if ($@) {
    warn "Exception when calling CommunityApi->communityGidDelete: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CommunityApi()
gid = gid_example # String | Community ID (default to null)

try:
    # Delete a community by ID
    api_instance.community_gid_delete(gid)
except ApiException as e:
    print("Exception when calling CommunityApi->communityGidDelete: %s\n" % e)
extern crate CommunityApi;

pub fn main() {
    let gid = gid_example; // String

    let mut context = CommunityApi::Context::default();
    let result = client.communityGidDelete(gid, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
gid*
String
Community ID
Required

Responses


communityGidGet

Get community details by ID


/community/{gid}

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/community/{gid}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommunityApi;

import java.io.File;
import java.util.*;

public class CommunityApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        CommunityApi apiInstance = new CommunityApi();
        String gid = gid_example; // String | Community ID

        try {
            Community-Info result = apiInstance.communityGidGet(gid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommunityApi#communityGidGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String gid = new String(); // String | Community ID

try {
    final result = await api_instance.communityGidGet(gid);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->communityGidGet: $e\n');
}

import org.openapitools.client.api.CommunityApi;

public class CommunityApiExample {
    public static void main(String[] args) {
        CommunityApi apiInstance = new CommunityApi();
        String gid = gid_example; // String | Community ID

        try {
            Community-Info result = apiInstance.communityGidGet(gid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommunityApi#communityGidGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
CommunityApi *apiInstance = [[CommunityApi alloc] init];
String *gid = gid_example; // Community ID (default to null)

// Get community details by ID
[apiInstance communityGidGetWith:gid
              completionHandler: ^(Community-Info output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.CommunityApi()
var gid = gid_example; // {String} Community ID

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.communityGidGet(gid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class communityGidGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CommunityApi();
            var gid = gid_example;  // String | Community ID (default to null)

            try {
                // Get community details by ID
                Community-Info result = apiInstance.communityGidGet(gid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommunityApi.communityGidGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommunityApi();
$gid = gid_example; // String | Community ID

try {
    $result = $api_instance->communityGidGet($gid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommunityApi->communityGidGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommunityApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommunityApi->new();
my $gid = gid_example; # String | Community ID

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CommunityApi()
gid = gid_example # String | Community ID (default to null)

try:
    # Get community details by ID
    api_response = api_instance.community_gid_get(gid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommunityApi->communityGidGet: %s\n" % e)
extern crate CommunityApi;

pub fn main() {
    let gid = gid_example; // String

    let mut context = CommunityApi::Context::default();
    let result = client.communityGidGet(gid, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
gid*
String
Community ID
Required

Responses


communityJoiningRequestGidPatch

Update or withdraw a joining request


/community/joining_request/{gid}

Usage and SDK Samples

curl -X PATCH \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://nextworkplace.staging/api/v1/community/joining_request/{gid}" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommunityApi;

import java.io.File;
import java.util.*;

public class CommunityApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        CommunityApi apiInstance = new CommunityApi();
        String gid = gid_example; // String | Community ID
        CommunityJoiningRequestGidPatchRequest communityJoiningRequestGidPatchRequest = ; // CommunityJoiningRequestGidPatchRequest | 

        try {
            'Integer' result = apiInstance.communityJoiningRequestGidPatch(gid, communityJoiningRequestGidPatchRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommunityApi#communityJoiningRequestGidPatch");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String gid = new String(); // String | Community ID
final CommunityJoiningRequestGidPatchRequest communityJoiningRequestGidPatchRequest = new CommunityJoiningRequestGidPatchRequest(); // CommunityJoiningRequestGidPatchRequest | 

try {
    final result = await api_instance.communityJoiningRequestGidPatch(gid, communityJoiningRequestGidPatchRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->communityJoiningRequestGidPatch: $e\n');
}

import org.openapitools.client.api.CommunityApi;

public class CommunityApiExample {
    public static void main(String[] args) {
        CommunityApi apiInstance = new CommunityApi();
        String gid = gid_example; // String | Community ID
        CommunityJoiningRequestGidPatchRequest communityJoiningRequestGidPatchRequest = ; // CommunityJoiningRequestGidPatchRequest | 

        try {
            'Integer' result = apiInstance.communityJoiningRequestGidPatch(gid, communityJoiningRequestGidPatchRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommunityApi#communityJoiningRequestGidPatch");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
CommunityApi *apiInstance = [[CommunityApi alloc] init];
String *gid = gid_example; // Community ID (default to null)
CommunityJoiningRequestGidPatchRequest *communityJoiningRequestGidPatchRequest = ; // 

// Update or withdraw a joining request
[apiInstance communityJoiningRequestGidPatchWith:gid
    communityJoiningRequestGidPatchRequest:communityJoiningRequestGidPatchRequest
              completionHandler: ^('Integer' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.CommunityApi()
var gid = gid_example; // {String} Community ID
var communityJoiningRequestGidPatchRequest = ; // {CommunityJoiningRequestGidPatchRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.communityJoiningRequestGidPatch(gid, communityJoiningRequestGidPatchRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class communityJoiningRequestGidPatchExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CommunityApi();
            var gid = gid_example;  // String | Community ID (default to null)
            var communityJoiningRequestGidPatchRequest = new CommunityJoiningRequestGidPatchRequest(); // CommunityJoiningRequestGidPatchRequest | 

            try {
                // Update or withdraw a joining request
                'Integer' result = apiInstance.communityJoiningRequestGidPatch(gid, communityJoiningRequestGidPatchRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommunityApi.communityJoiningRequestGidPatch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommunityApi();
$gid = gid_example; // String | Community ID
$communityJoiningRequestGidPatchRequest = ; // CommunityJoiningRequestGidPatchRequest | 

try {
    $result = $api_instance->communityJoiningRequestGidPatch($gid, $communityJoiningRequestGidPatchRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommunityApi->communityJoiningRequestGidPatch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommunityApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommunityApi->new();
my $gid = gid_example; # String | Community ID
my $communityJoiningRequestGidPatchRequest = WWW::OPenAPIClient::Object::CommunityJoiningRequestGidPatchRequest->new(); # CommunityJoiningRequestGidPatchRequest | 

eval {
    my $result = $api_instance->communityJoiningRequestGidPatch(gid => $gid, communityJoiningRequestGidPatchRequest => $communityJoiningRequestGidPatchRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommunityApi->communityJoiningRequestGidPatch: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CommunityApi()
gid = gid_example # String | Community ID (default to null)
communityJoiningRequestGidPatchRequest =  # CommunityJoiningRequestGidPatchRequest | 

try:
    # Update or withdraw a joining request
    api_response = api_instance.community_joining_request_gid_patch(gid, communityJoiningRequestGidPatchRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommunityApi->communityJoiningRequestGidPatch: %s\n" % e)
extern crate CommunityApi;

pub fn main() {
    let gid = gid_example; // String
    let communityJoiningRequestGidPatchRequest = ; // CommunityJoiningRequestGidPatchRequest

    let mut context = CommunityApi::Context::default();
    let result = client.communityJoiningRequestGidPatch(gid, communityJoiningRequestGidPatchRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
gid*
String
Community ID
Required
Body parameters
Name Description
communityJoiningRequestGidPatchRequest *

Responses


communityJoiningRequestPost

Create a new joining request for a community


/community/joining_request

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://nextworkplace.staging/api/v1/community/joining_request" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommunityApi;

import java.io.File;
import java.util.*;

public class CommunityApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        CommunityApi apiInstance = new CommunityApi();
        CommunityJoiningRequestPostRequest communityJoiningRequestPostRequest = ; // CommunityJoiningRequestPostRequest | 

        try {
            'Integer' result = apiInstance.communityJoiningRequestPost(communityJoiningRequestPostRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommunityApi#communityJoiningRequestPost");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final CommunityJoiningRequestPostRequest communityJoiningRequestPostRequest = new CommunityJoiningRequestPostRequest(); // CommunityJoiningRequestPostRequest | 

try {
    final result = await api_instance.communityJoiningRequestPost(communityJoiningRequestPostRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->communityJoiningRequestPost: $e\n');
}

import org.openapitools.client.api.CommunityApi;

public class CommunityApiExample {
    public static void main(String[] args) {
        CommunityApi apiInstance = new CommunityApi();
        CommunityJoiningRequestPostRequest communityJoiningRequestPostRequest = ; // CommunityJoiningRequestPostRequest | 

        try {
            'Integer' result = apiInstance.communityJoiningRequestPost(communityJoiningRequestPostRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommunityApi#communityJoiningRequestPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
CommunityApi *apiInstance = [[CommunityApi alloc] init];
CommunityJoiningRequestPostRequest *communityJoiningRequestPostRequest = ; // 

// Create a new joining request for a community
[apiInstance communityJoiningRequestPostWith:communityJoiningRequestPostRequest
              completionHandler: ^('Integer' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.CommunityApi()
var communityJoiningRequestPostRequest = ; // {CommunityJoiningRequestPostRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.communityJoiningRequestPost(communityJoiningRequestPostRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class communityJoiningRequestPostExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CommunityApi();
            var communityJoiningRequestPostRequest = new CommunityJoiningRequestPostRequest(); // CommunityJoiningRequestPostRequest | 

            try {
                // Create a new joining request for a community
                'Integer' result = apiInstance.communityJoiningRequestPost(communityJoiningRequestPostRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommunityApi.communityJoiningRequestPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommunityApi();
$communityJoiningRequestPostRequest = ; // CommunityJoiningRequestPostRequest | 

try {
    $result = $api_instance->communityJoiningRequestPost($communityJoiningRequestPostRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommunityApi->communityJoiningRequestPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommunityApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommunityApi->new();
my $communityJoiningRequestPostRequest = WWW::OPenAPIClient::Object::CommunityJoiningRequestPostRequest->new(); # CommunityJoiningRequestPostRequest | 

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CommunityApi()
communityJoiningRequestPostRequest =  # CommunityJoiningRequestPostRequest | 

try:
    # Create a new joining request for a community
    api_response = api_instance.community_joining_request_post(communityJoiningRequestPostRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommunityApi->communityJoiningRequestPost: %s\n" % e)
extern crate CommunityApi;

pub fn main() {
    let communityJoiningRequestPostRequest = ; // CommunityJoiningRequestPostRequest

    let mut context = CommunityApi::Context::default();
    let result = client.communityJoiningRequestPost(communityJoiningRequestPostRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
communityJoiningRequestPostRequest *

Responses


communityListGet

Get communities list.

Returns communities visible to the current user. Supports pagination, sorting, filtering and request-state scoping.


/community/list

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/community/list?page=56&sort_by=sortBy_example&sort_dir=sortDir_example&search=search_example&requests=true&filters[tab]=filtersLeft_Square_BrackettabRight_Square_Bracket_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommunityApi;

import java.io.File;
import java.util.*;

public class CommunityApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        CommunityApi apiInstance = new CommunityApi();
        Integer page = 56; // Integer | Zero-based page index. Each page contains 9 communities.
        String sortBy = sortBy_example; // String | Field to sort by.
        String sortDir = sortDir_example; // String | Sort direction.
        String search = search_example; // String | Fulltext search term.
        Boolean requests = true; // Boolean | If true with filters[tab]=own, shows communities the user has pending join requests for.
        String filtersLeft_Square_BrackettabRight_Square_Bracket = filtersLeft_Square_BrackettabRight_Square_Bracket_example; // String | Tab context. own = memberships (or pending requests if requests=true). all = discoverable communities excluding ones already joined or requested.

        try {
            _community_list_get_200_response result = apiInstance.communityListGet(page, sortBy, sortDir, search, requests, filtersLeft_Square_BrackettabRight_Square_Bracket);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommunityApi#communityListGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer page = new Integer(); // Integer | Zero-based page index. Each page contains 9 communities.
final String sortBy = new String(); // String | Field to sort by.
final String sortDir = new String(); // String | Sort direction.
final String search = new String(); // String | Fulltext search term.
final Boolean requests = new Boolean(); // Boolean | If true with filters[tab]=own, shows communities the user has pending join requests for.
final String filtersLeft_Square_BrackettabRight_Square_Bracket = new String(); // String | Tab context. own = memberships (or pending requests if requests=true). all = discoverable communities excluding ones already joined or requested.

try {
    final result = await api_instance.communityListGet(page, sortBy, sortDir, search, requests, filtersLeft_Square_BrackettabRight_Square_Bracket);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->communityListGet: $e\n');
}

import org.openapitools.client.api.CommunityApi;

public class CommunityApiExample {
    public static void main(String[] args) {
        CommunityApi apiInstance = new CommunityApi();
        Integer page = 56; // Integer | Zero-based page index. Each page contains 9 communities.
        String sortBy = sortBy_example; // String | Field to sort by.
        String sortDir = sortDir_example; // String | Sort direction.
        String search = search_example; // String | Fulltext search term.
        Boolean requests = true; // Boolean | If true with filters[tab]=own, shows communities the user has pending join requests for.
        String filtersLeft_Square_BrackettabRight_Square_Bracket = filtersLeft_Square_BrackettabRight_Square_Bracket_example; // String | Tab context. own = memberships (or pending requests if requests=true). all = discoverable communities excluding ones already joined or requested.

        try {
            _community_list_get_200_response result = apiInstance.communityListGet(page, sortBy, sortDir, search, requests, filtersLeft_Square_BrackettabRight_Square_Bracket);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommunityApi#communityListGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
CommunityApi *apiInstance = [[CommunityApi alloc] init];
Integer *page = 56; // Zero-based page index. Each page contains 9 communities. (optional) (default to 0)
String *sortBy = sortBy_example; // Field to sort by. (optional) (default to title)
String *sortDir = sortDir_example; // Sort direction. (optional) (default to ASC)
String *search = search_example; // Fulltext search term. (optional) (default to null)
Boolean *requests = true; // If true with filters[tab]=own, shows communities the user has pending join requests for. (optional) (default to false)
String *filtersLeft_Square_BrackettabRight_Square_Bracket = filtersLeft_Square_BrackettabRight_Square_Bracket_example; // Tab context. own = memberships (or pending requests if requests=true). all = discoverable communities excluding ones already joined or requested. (optional) (default to null)

// Get communities list.
[apiInstance communityListGetWith:page
    sortBy:sortBy
    sortDir:sortDir
    search:search
    requests:requests
    filtersLeft_Square_BrackettabRight_Square_Bracket:filtersLeft_Square_BrackettabRight_Square_Bracket
              completionHandler: ^(_community_list_get_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.CommunityApi()
var opts = {
  'page': 56, // {Integer} Zero-based page index. Each page contains 9 communities.
  'sortBy': sortBy_example, // {String} Field to sort by.
  'sortDir': sortDir_example, // {String} Sort direction.
  'search': search_example, // {String} Fulltext search term.
  'requests': true, // {Boolean} If true with filters[tab]=own, shows communities the user has pending join requests for.
  'filtersLeft_Square_BrackettabRight_Square_Bracket': filtersLeft_Square_BrackettabRight_Square_Bracket_example // {String} Tab context. own = memberships (or pending requests if requests=true). all = discoverable communities excluding ones already joined or requested.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.communityListGet(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class communityListGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CommunityApi();
            var page = 56;  // Integer | Zero-based page index. Each page contains 9 communities. (optional)  (default to 0)
            var sortBy = sortBy_example;  // String | Field to sort by. (optional)  (default to title)
            var sortDir = sortDir_example;  // String | Sort direction. (optional)  (default to ASC)
            var search = search_example;  // String | Fulltext search term. (optional)  (default to null)
            var requests = true;  // Boolean | If true with filters[tab]=own, shows communities the user has pending join requests for. (optional)  (default to false)
            var filtersLeft_Square_BrackettabRight_Square_Bracket = filtersLeft_Square_BrackettabRight_Square_Bracket_example;  // String | Tab context. own = memberships (or pending requests if requests=true). all = discoverable communities excluding ones already joined or requested. (optional)  (default to null)

            try {
                // Get communities list.
                _community_list_get_200_response result = apiInstance.communityListGet(page, sortBy, sortDir, search, requests, filtersLeft_Square_BrackettabRight_Square_Bracket);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommunityApi.communityListGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommunityApi();
$page = 56; // Integer | Zero-based page index. Each page contains 9 communities.
$sortBy = sortBy_example; // String | Field to sort by.
$sortDir = sortDir_example; // String | Sort direction.
$search = search_example; // String | Fulltext search term.
$requests = true; // Boolean | If true with filters[tab]=own, shows communities the user has pending join requests for.
$filtersLeft_Square_BrackettabRight_Square_Bracket = filtersLeft_Square_BrackettabRight_Square_Bracket_example; // String | Tab context. own = memberships (or pending requests if requests=true). all = discoverable communities excluding ones already joined or requested.

try {
    $result = $api_instance->communityListGet($page, $sortBy, $sortDir, $search, $requests, $filtersLeft_Square_BrackettabRight_Square_Bracket);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommunityApi->communityListGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommunityApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommunityApi->new();
my $page = 56; # Integer | Zero-based page index. Each page contains 9 communities.
my $sortBy = sortBy_example; # String | Field to sort by.
my $sortDir = sortDir_example; # String | Sort direction.
my $search = search_example; # String | Fulltext search term.
my $requests = true; # Boolean | If true with filters[tab]=own, shows communities the user has pending join requests for.
my $filtersLeft_Square_BrackettabRight_Square_Bracket = filtersLeft_Square_BrackettabRight_Square_Bracket_example; # String | Tab context. own = memberships (or pending requests if requests=true). all = discoverable communities excluding ones already joined or requested.

eval {
    my $result = $api_instance->communityListGet(page => $page, sortBy => $sortBy, sortDir => $sortDir, search => $search, requests => $requests, filtersLeft_Square_BrackettabRight_Square_Bracket => $filtersLeft_Square_BrackettabRight_Square_Bracket);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommunityApi->communityListGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CommunityApi()
page = 56 # Integer | Zero-based page index. Each page contains 9 communities. (optional) (default to 0)
sortBy = sortBy_example # String | Field to sort by. (optional) (default to title)
sortDir = sortDir_example # String | Sort direction. (optional) (default to ASC)
search = search_example # String | Fulltext search term. (optional) (default to null)
requests = true # Boolean | If true with filters[tab]=own, shows communities the user has pending join requests for. (optional) (default to false)
filtersLeft_Square_BrackettabRight_Square_Bracket = filtersLeft_Square_BrackettabRight_Square_Bracket_example # String | Tab context. own = memberships (or pending requests if requests=true). all = discoverable communities excluding ones already joined or requested. (optional) (default to null)

try:
    # Get communities list.
    api_response = api_instance.community_list_get(page=page, sortBy=sortBy, sortDir=sortDir, search=search, requests=requests, filtersLeft_Square_BrackettabRight_Square_Bracket=filtersLeft_Square_BrackettabRight_Square_Bracket)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommunityApi->communityListGet: %s\n" % e)
extern crate CommunityApi;

pub fn main() {
    let page = 56; // Integer
    let sortBy = sortBy_example; // String
    let sortDir = sortDir_example; // String
    let search = search_example; // String
    let requests = true; // Boolean
    let filtersLeft_Square_BrackettabRight_Square_Bracket = filtersLeft_Square_BrackettabRight_Square_Bracket_example; // String

    let mut context = CommunityApi::Context::default();
    let result = client.communityListGet(page, sortBy, sortDir, search, requests, filtersLeft_Square_BrackettabRight_Square_Bracket, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
page
Integer
Zero-based page index. Each page contains 9 communities.
sort_by
String
Field to sort by.
sort_dir
String
Sort direction.
search
requests
Boolean
If true with filters[tab]=own, shows communities the user has pending join requests for.
filters[tab]
String
Tab context. own = memberships (or pending requests if requests=true). all = discoverable communities excluding ones already joined or requested.

Responses


communityMembersGidGet

Get the list of members in a community.


/community/members/{gid}

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/community/members/{gid}?page=56&sort_by=sortBy_example&sort_dir=sortDir_example&search=search_example&requests=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommunityApi;

import java.io.File;
import java.util.*;

public class CommunityApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        CommunityApi apiInstance = new CommunityApi();
        Integer gid = 56; // Integer | The community identifier.
        Integer page = 56; // Integer | The page number.
        String sortBy = sortBy_example; // String | Sorting criteria.
        String sortDir = sortDir_example; // String | Sorting direction.
        String search = search_example; // String | Search a member by name.
        Integer requests = 56; // Integer | Whether to return only the members who requested to join. 0 for false, 1 for true.

        try {
            _community_members__gid__get_200_response result = apiInstance.communityMembersGidGet(gid, page, sortBy, sortDir, search, requests);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommunityApi#communityMembersGidGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer gid = new Integer(); // Integer | The community identifier.
final Integer page = new Integer(); // Integer | The page number.
final String sortBy = new String(); // String | Sorting criteria.
final String sortDir = new String(); // String | Sorting direction.
final String search = new String(); // String | Search a member by name.
final Integer requests = new Integer(); // Integer | Whether to return only the members who requested to join. 0 for false, 1 for true.

try {
    final result = await api_instance.communityMembersGidGet(gid, page, sortBy, sortDir, search, requests);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->communityMembersGidGet: $e\n');
}

import org.openapitools.client.api.CommunityApi;

public class CommunityApiExample {
    public static void main(String[] args) {
        CommunityApi apiInstance = new CommunityApi();
        Integer gid = 56; // Integer | The community identifier.
        Integer page = 56; // Integer | The page number.
        String sortBy = sortBy_example; // String | Sorting criteria.
        String sortDir = sortDir_example; // String | Sorting direction.
        String search = search_example; // String | Search a member by name.
        Integer requests = 56; // Integer | Whether to return only the members who requested to join. 0 for false, 1 for true.

        try {
            _community_members__gid__get_200_response result = apiInstance.communityMembersGidGet(gid, page, sortBy, sortDir, search, requests);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommunityApi#communityMembersGidGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
CommunityApi *apiInstance = [[CommunityApi alloc] init];
Integer *gid = 56; // The community identifier. (default to null)
Integer *page = 56; // The page number. (optional) (default to null)
String *sortBy = sortBy_example; // Sorting criteria. (optional) (default to null)
String *sortDir = sortDir_example; // Sorting direction. (optional) (default to null)
String *search = search_example; // Search a member by name. (optional) (default to null)
Integer *requests = 56; // Whether to return only the members who requested to join. 0 for false, 1 for true. (optional) (default to null)

// Get the list of members in a community.
[apiInstance communityMembersGidGetWith:gid
    page:page
    sortBy:sortBy
    sortDir:sortDir
    search:search
    requests:requests
              completionHandler: ^(_community_members__gid__get_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.CommunityApi()
var gid = 56; // {Integer} The community identifier.
var opts = {
  'page': 56, // {Integer} The page number.
  'sortBy': sortBy_example, // {String} Sorting criteria.
  'sortDir': sortDir_example, // {String} Sorting direction.
  'search': search_example, // {String} Search a member by name.
  'requests': 56 // {Integer} Whether to return only the members who requested to join. 0 for false, 1 for true.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.communityMembersGidGet(gid, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class communityMembersGidGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CommunityApi();
            var gid = 56;  // Integer | The community identifier. (default to null)
            var page = 56;  // Integer | The page number. (optional)  (default to null)
            var sortBy = sortBy_example;  // String | Sorting criteria. (optional)  (default to null)
            var sortDir = sortDir_example;  // String | Sorting direction. (optional)  (default to null)
            var search = search_example;  // String | Search a member by name. (optional)  (default to null)
            var requests = 56;  // Integer | Whether to return only the members who requested to join. 0 for false, 1 for true. (optional)  (default to null)

            try {
                // Get the list of members in a community.
                _community_members__gid__get_200_response result = apiInstance.communityMembersGidGet(gid, page, sortBy, sortDir, search, requests);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommunityApi.communityMembersGidGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommunityApi();
$gid = 56; // Integer | The community identifier.
$page = 56; // Integer | The page number.
$sortBy = sortBy_example; // String | Sorting criteria.
$sortDir = sortDir_example; // String | Sorting direction.
$search = search_example; // String | Search a member by name.
$requests = 56; // Integer | Whether to return only the members who requested to join. 0 for false, 1 for true.

try {
    $result = $api_instance->communityMembersGidGet($gid, $page, $sortBy, $sortDir, $search, $requests);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommunityApi->communityMembersGidGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommunityApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommunityApi->new();
my $gid = 56; # Integer | The community identifier.
my $page = 56; # Integer | The page number.
my $sortBy = sortBy_example; # String | Sorting criteria.
my $sortDir = sortDir_example; # String | Sorting direction.
my $search = search_example; # String | Search a member by name.
my $requests = 56; # Integer | Whether to return only the members who requested to join. 0 for false, 1 for true.

eval {
    my $result = $api_instance->communityMembersGidGet(gid => $gid, page => $page, sortBy => $sortBy, sortDir => $sortDir, search => $search, requests => $requests);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommunityApi->communityMembersGidGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CommunityApi()
gid = 56 # Integer | The community identifier. (default to null)
page = 56 # Integer | The page number. (optional) (default to null)
sortBy = sortBy_example # String | Sorting criteria. (optional) (default to null)
sortDir = sortDir_example # String | Sorting direction. (optional) (default to null)
search = search_example # String | Search a member by name. (optional) (default to null)
requests = 56 # Integer | Whether to return only the members who requested to join. 0 for false, 1 for true. (optional) (default to null)

try:
    # Get the list of members in a community.
    api_response = api_instance.community_members_gid_get(gid, page=page, sortBy=sortBy, sortDir=sortDir, search=search, requests=requests)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommunityApi->communityMembersGidGet: %s\n" % e)
extern crate CommunityApi;

pub fn main() {
    let gid = 56; // Integer
    let page = 56; // Integer
    let sortBy = sortBy_example; // String
    let sortDir = sortDir_example; // String
    let search = search_example; // String
    let requests = 56; // Integer

    let mut context = CommunityApi::Context::default();
    let result = client.communityMembersGidGet(gid, page, sortBy, sortDir, search, requests, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
gid*
Integer
The community identifier.
Required
Query parameters
Name Description
page
Integer
The page number.
sort_by
String
Sorting criteria.
sort_dir
String
Sorting direction.
search
requests
Integer
Whether to return only the members who requested to join. 0 for false, 1 for true.

Responses


communityMembersGidPatch

Update community member status or role

Perform actions such as join, leave, remove, or assignRole for a community member. If the community is closed (not public), use instead the endpoint community/joining_request to let user request for joining the community, and the endpoint community/joining_request/{gid} to approve/reject or withdraw request.


/community/members/{gid}

Usage and SDK Samples

curl -X PATCH \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://nextworkplace.staging/api/v1/community/members/{gid}" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommunityApi;

import java.io.File;
import java.util.*;

public class CommunityApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        CommunityApi apiInstance = new CommunityApi();
        String gid = 14; // String | The community group ID.
        CommunityMembersGidPatchRequest communityMembersGidPatchRequest = ; // CommunityMembersGidPatchRequest | 

        try {
            Object result = apiInstance.communityMembersGidPatch(gid, communityMembersGidPatchRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommunityApi#communityMembersGidPatch");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String gid = new String(); // String | The community group ID.
final CommunityMembersGidPatchRequest communityMembersGidPatchRequest = new CommunityMembersGidPatchRequest(); // CommunityMembersGidPatchRequest | 

try {
    final result = await api_instance.communityMembersGidPatch(gid, communityMembersGidPatchRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->communityMembersGidPatch: $e\n');
}

import org.openapitools.client.api.CommunityApi;

public class CommunityApiExample {
    public static void main(String[] args) {
        CommunityApi apiInstance = new CommunityApi();
        String gid = 14; // String | The community group ID.
        CommunityMembersGidPatchRequest communityMembersGidPatchRequest = ; // CommunityMembersGidPatchRequest | 

        try {
            Object result = apiInstance.communityMembersGidPatch(gid, communityMembersGidPatchRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommunityApi#communityMembersGidPatch");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
CommunityApi *apiInstance = [[CommunityApi alloc] init];
String *gid = 14; // The community group ID. (default to null)
CommunityMembersGidPatchRequest *communityMembersGidPatchRequest = ; // 

// Update community member status or role
[apiInstance communityMembersGidPatchWith:gid
    communityMembersGidPatchRequest:communityMembersGidPatchRequest
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.CommunityApi()
var gid = 14; // {String} The community group ID.
var communityMembersGidPatchRequest = ; // {CommunityMembersGidPatchRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.communityMembersGidPatch(gid, communityMembersGidPatchRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class communityMembersGidPatchExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CommunityApi();
            var gid = 14;  // String | The community group ID. (default to null)
            var communityMembersGidPatchRequest = new CommunityMembersGidPatchRequest(); // CommunityMembersGidPatchRequest | 

            try {
                // Update community member status or role
                Object result = apiInstance.communityMembersGidPatch(gid, communityMembersGidPatchRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommunityApi.communityMembersGidPatch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommunityApi();
$gid = 14; // String | The community group ID.
$communityMembersGidPatchRequest = ; // CommunityMembersGidPatchRequest | 

try {
    $result = $api_instance->communityMembersGidPatch($gid, $communityMembersGidPatchRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommunityApi->communityMembersGidPatch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommunityApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommunityApi->new();
my $gid = 14; # String | The community group ID.
my $communityMembersGidPatchRequest = WWW::OPenAPIClient::Object::CommunityMembersGidPatchRequest->new(); # CommunityMembersGidPatchRequest | 

eval {
    my $result = $api_instance->communityMembersGidPatch(gid => $gid, communityMembersGidPatchRequest => $communityMembersGidPatchRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommunityApi->communityMembersGidPatch: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CommunityApi()
gid = 14 # String | The community group ID. (default to null)
communityMembersGidPatchRequest =  # CommunityMembersGidPatchRequest | 

try:
    # Update community member status or role
    api_response = api_instance.community_members_gid_patch(gid, communityMembersGidPatchRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommunityApi->communityMembersGidPatch: %s\n" % e)
extern crate CommunityApi;

pub fn main() {
    let gid = 14; // String
    let communityMembersGidPatchRequest = ; // CommunityMembersGidPatchRequest

    let mut context = CommunityApi::Context::default();
    let result = client.communityMembersGidPatch(gid, communityMembersGidPatchRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
gid*
String
The community group ID.
Required
Body parameters
Name Description
communityMembersGidPatchRequest *

Responses


communityPost

Create a new community


/community

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://nextworkplace.staging/api/v1/community" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommunityApi;

import java.io.File;
import java.util.*;

public class CommunityApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        CommunityApi apiInstance = new CommunityApi();
        CommunityPostRequest communityPostRequest = ; // CommunityPostRequest | 

        try {
            apiInstance.communityPost(communityPostRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommunityApi#communityPost");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final CommunityPostRequest communityPostRequest = new CommunityPostRequest(); // CommunityPostRequest | 

try {
    final result = await api_instance.communityPost(communityPostRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->communityPost: $e\n');
}

import org.openapitools.client.api.CommunityApi;

public class CommunityApiExample {
    public static void main(String[] args) {
        CommunityApi apiInstance = new CommunityApi();
        CommunityPostRequest communityPostRequest = ; // CommunityPostRequest | 

        try {
            apiInstance.communityPost(communityPostRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommunityApi#communityPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
CommunityApi *apiInstance = [[CommunityApi alloc] init];
CommunityPostRequest *communityPostRequest = ; // 

// Create a new community
[apiInstance communityPostWith:communityPostRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.CommunityApi()
var communityPostRequest = ; // {CommunityPostRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.communityPost(communityPostRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class communityPostExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CommunityApi();
            var communityPostRequest = new CommunityPostRequest(); // CommunityPostRequest | 

            try {
                // Create a new community
                apiInstance.communityPost(communityPostRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommunityApi.communityPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommunityApi();
$communityPostRequest = ; // CommunityPostRequest | 

try {
    $api_instance->communityPost($communityPostRequest);
} catch (Exception $e) {
    echo 'Exception when calling CommunityApi->communityPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommunityApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommunityApi->new();
my $communityPostRequest = WWW::OPenAPIClient::Object::CommunityPostRequest->new(); # CommunityPostRequest | 

eval {
    $api_instance->communityPost(communityPostRequest => $communityPostRequest);
};
if ($@) {
    warn "Exception when calling CommunityApi->communityPost: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CommunityApi()
communityPostRequest =  # CommunityPostRequest | 

try:
    # Create a new community
    api_instance.community_post(communityPostRequest)
except ApiException as e:
    print("Exception when calling CommunityApi->communityPost: %s\n" % e)
extern crate CommunityApi;

pub fn main() {
    let communityPostRequest = ; // CommunityPostRequest

    let mut context = CommunityApi::Context::default();
    let result = client.communityPost(communityPostRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
communityPostRequest *

Responses


communitySettingsGidGet

Get community settings.

Returns general community settings fields (labels, types, required state, values, picture information, and other community-level data).


/community/settings/{gid}

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/community/settings/{gid}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommunityApi;

import java.io.File;
import java.util.*;

public class CommunityApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        CommunityApi apiInstance = new CommunityApi();
        Integer gid = 56; // Integer | The ID of the community.

        try {
            map['String', CommunityField] result = apiInstance.communitySettingsGidGet(gid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommunityApi#communitySettingsGidGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer gid = new Integer(); // Integer | The ID of the community.

try {
    final result = await api_instance.communitySettingsGidGet(gid);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->communitySettingsGidGet: $e\n');
}

import org.openapitools.client.api.CommunityApi;

public class CommunityApiExample {
    public static void main(String[] args) {
        CommunityApi apiInstance = new CommunityApi();
        Integer gid = 56; // Integer | The ID of the community.

        try {
            map['String', CommunityField] result = apiInstance.communitySettingsGidGet(gid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommunityApi#communitySettingsGidGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
CommunityApi *apiInstance = [[CommunityApi alloc] init];
Integer *gid = 56; // The ID of the community. (default to null)

// Get community settings.
[apiInstance communitySettingsGidGetWith:gid
              completionHandler: ^(map['String', CommunityField] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.CommunityApi()
var gid = 56; // {Integer} The ID of the community.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.communitySettingsGidGet(gid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class communitySettingsGidGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CommunityApi();
            var gid = 56;  // Integer | The ID of the community. (default to null)

            try {
                // Get community settings.
                map['String', CommunityField] result = apiInstance.communitySettingsGidGet(gid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommunityApi.communitySettingsGidGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommunityApi();
$gid = 56; // Integer | The ID of the community.

try {
    $result = $api_instance->communitySettingsGidGet($gid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommunityApi->communitySettingsGidGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommunityApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommunityApi->new();
my $gid = 56; # Integer | The ID of the community.

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CommunityApi()
gid = 56 # Integer | The ID of the community. (default to null)

try:
    # Get community settings.
    api_response = api_instance.community_settings_gid_get(gid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommunityApi->communitySettingsGidGet: %s\n" % e)
extern crate CommunityApi;

pub fn main() {
    let gid = 56; // Integer

    let mut context = CommunityApi::Context::default();
    let result = client.communitySettingsGidGet(gid, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
gid*
Integer
The ID of the community.
Required

Responses


communitySettingsGidPatch

Update community settings.

Updates editable community-level settings (for example title, picture, links, and other community fields). User-specific settings are managed via /community/settings/{gid}/user.


/community/settings/{gid}

Usage and SDK Samples

curl -X PATCH \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://nextworkplace.staging/api/v1/community/settings/{gid}" \
 -d '{
  "default" : {
    "alt" : "alt",
    "url" : "url"
  },
  "label" : "label",
  "type" : "type",
  "value" : "CommunityField_value",
  "required" : true
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommunityApi;

import java.io.File;
import java.util.*;

public class CommunityApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        CommunityApi apiInstance = new CommunityApi();
        Integer gid = 56; // Integer | The ID of the community.
        map[String, CommunityField] requestBody = {"gid":{"label":"ID","type":"integer","required":false,"value":"14"},"uuid":{"label":"UUID","type":"uuid","required":false,"value":"a94b5d1f-1f04-40ee-8129-f5de192937d8"},"langcode":{"label":"Sprache","type":"language","required":false,"value":"en"},"uid":{"label":"Created by","type":"entity_reference","required":false,"value":[{"target_id":112,"target_type":"user","target_uuid":"acddabfb-91a3-4c01-af18-bf977c88a77e","url":"/user/112"}]},"title":{"label":"Titel","type":"string","required":true,"value":"HR"},"type":{"label":"Typ","type":"string","required":false,"value":null},"created":{"label":"Created","type":"created","required":false,"value":"30.04.2024"},"members":{"label":"Mitglieder","type":"entity_reference","required":false,"value":[{"target_id":21,"target_type":"community_member","target_uuid":"66a575fb-9dce-4f79-826a-ed80eb5bc20b","url":"/community_member/21?community=14&group=14"},{"target_id":25,"target_type":"community_member","target_uuid":"dc186a71-4dea-4991-9bf3-4705f239790c","url":"/community_member/25?community=14&group=14"},{"target_id":27,"target_type":"community_member","target_uuid":"1544fca1-e21a-402f-aee4-c59f5faa8cde","url":"/community_member/27?community=14&group=14"},{"target_id":29,"target_type":"community_member","target_uuid":"ffca9969-abc5-44f8-8d78-73ff31a7a01b","url":"/community_member/29?community=14&group=14"},{"target_id":30,"target_type":"community_member","target_uuid":"f173c292-6855-4ee5-ba3c-c841b854f50f","url":"/community_member/30?community=14&group=14"},{"target_id":126,"target_type":"community_member","target_uuid":"09325eac-ac16-42cc-86d6-58044541b857","url":"/community_member/126?community=14&group=14"},{"target_id":263,"target_type":"community_member","target_uuid":"b93b5475-ae61-476b-a50b-2aa5bdd90526","url":"/community_member/263?community=14&group=14"}]},"community_visibility":{"label":"Gruppentyp","type":"integer","required":true,"value":"0"},"summary_configuration":{"label":"Zusammenfassungskonfiguration","type":"integer","required":false,"value":null},"joining_requests":{"label":"Beitrittsanfragen","type":"entity_reference","required":false,"value":[]},"default_langcode":{"label":"Standardübersetzung","type":"boolean","required":false,"value":"1"},"community_content":{"label":"Community-Inhalt","type":"entity_reference","required":false,"value":[{"target_id":764,"target_type":"node","target_uuid":"e45e068b-770c-432f-acc9-5eb0cd46155e","url":"/node/764"},{"target_id":1032,"target_type":"node","target_uuid":"231fe94d-ce50-4577-aa8d-59e22aebc1d8","url":"/node/1032"},{"target_id":1324,"target_type":"node","target_uuid":"289fca3a-c398-4c91-916a-8be7ec2e1e72","url":"/node/1324"}]},"associated_channels":{"label":"Zugehörige Newskanäle","type":"entity_reference","required":false,"value":[]},"associated_content":{"label":"Assoziierte Inhalte","type":"entity_reference","required":false,"value":[{"target_id":751,"target_type":"node","target_uuid":"66b7dee7-8aef-4d44-8216-24203b04cbf6","url":"/node/751"},{"target_id":1398}]},"community_picture":{"label":"Profilbild","type":"image","required":false,"default":{"url":"/themes/contrib/piipe_backend/images/icons/media/picture-placeholder.svg","alt":"Standardbild für die Community HR"},"value":{"url":"/system/files/styles/thumbnail/private/community/14/community-picture/Team.jpg?h=fa4a2dfc&itok=6RPHnm36","alt":"Standardbild für die Community HR"}},"description":{"label":"Beschreibung","type":"text_long","required":false,"value":"Willkommen im HR-Forum! Diese Community bietet allen Kolleginnen und Kollegen eine Plattform für den Austausch zu allen Themen rund um Human Resources. Ob es um Recruiting, Mitarbeiterentwicklung, Unternehmenskultur, Diversity, Arbeitsrecht oder Work-Life-Balance geht – hier können Fragen gestellt, Erfahrungen geteilt und Best Practices diskutiert werden. Unser Ziel ist es, Wissen zu bündeln, neue Ideen zu entwickeln und gemeinsam Lösungen für die täglichen Herausforderungen im Personalbereich zu finden.\n\nTritt der Community bei und gestalte aktiv mit, wie wir unsere Arbeitswelt noch besser machen können!"},"field_consent_text":{"label":"Zustimmungstext","type":"string_long","required":false,"value":null},"field_enable_consent":{"label":"Einwilligung aktivieren","type":"boolean","required":false,"value":null},"rules":{"label":"Regeln","type":"text_long","required":false,"value":null}}; // map[String, CommunityField] | 

        try {
            map['String', CommunityField] result = apiInstance.communitySettingsGidPatch(gid, requestBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommunityApi#communitySettingsGidPatch");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer gid = new Integer(); // Integer | The ID of the community.
final map[String, CommunityField] requestBody = new map[String, CommunityField](); // map[String, CommunityField] | 

try {
    final result = await api_instance.communitySettingsGidPatch(gid, requestBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->communitySettingsGidPatch: $e\n');
}

import org.openapitools.client.api.CommunityApi;

public class CommunityApiExample {
    public static void main(String[] args) {
        CommunityApi apiInstance = new CommunityApi();
        Integer gid = 56; // Integer | The ID of the community.
        map[String, CommunityField] requestBody = {"gid":{"label":"ID","type":"integer","required":false,"value":"14"},"uuid":{"label":"UUID","type":"uuid","required":false,"value":"a94b5d1f-1f04-40ee-8129-f5de192937d8"},"langcode":{"label":"Sprache","type":"language","required":false,"value":"en"},"uid":{"label":"Created by","type":"entity_reference","required":false,"value":[{"target_id":112,"target_type":"user","target_uuid":"acddabfb-91a3-4c01-af18-bf977c88a77e","url":"/user/112"}]},"title":{"label":"Titel","type":"string","required":true,"value":"HR"},"type":{"label":"Typ","type":"string","required":false,"value":null},"created":{"label":"Created","type":"created","required":false,"value":"30.04.2024"},"members":{"label":"Mitglieder","type":"entity_reference","required":false,"value":[{"target_id":21,"target_type":"community_member","target_uuid":"66a575fb-9dce-4f79-826a-ed80eb5bc20b","url":"/community_member/21?community=14&group=14"},{"target_id":25,"target_type":"community_member","target_uuid":"dc186a71-4dea-4991-9bf3-4705f239790c","url":"/community_member/25?community=14&group=14"},{"target_id":27,"target_type":"community_member","target_uuid":"1544fca1-e21a-402f-aee4-c59f5faa8cde","url":"/community_member/27?community=14&group=14"},{"target_id":29,"target_type":"community_member","target_uuid":"ffca9969-abc5-44f8-8d78-73ff31a7a01b","url":"/community_member/29?community=14&group=14"},{"target_id":30,"target_type":"community_member","target_uuid":"f173c292-6855-4ee5-ba3c-c841b854f50f","url":"/community_member/30?community=14&group=14"},{"target_id":126,"target_type":"community_member","target_uuid":"09325eac-ac16-42cc-86d6-58044541b857","url":"/community_member/126?community=14&group=14"},{"target_id":263,"target_type":"community_member","target_uuid":"b93b5475-ae61-476b-a50b-2aa5bdd90526","url":"/community_member/263?community=14&group=14"}]},"community_visibility":{"label":"Gruppentyp","type":"integer","required":true,"value":"0"},"summary_configuration":{"label":"Zusammenfassungskonfiguration","type":"integer","required":false,"value":null},"joining_requests":{"label":"Beitrittsanfragen","type":"entity_reference","required":false,"value":[]},"default_langcode":{"label":"Standardübersetzung","type":"boolean","required":false,"value":"1"},"community_content":{"label":"Community-Inhalt","type":"entity_reference","required":false,"value":[{"target_id":764,"target_type":"node","target_uuid":"e45e068b-770c-432f-acc9-5eb0cd46155e","url":"/node/764"},{"target_id":1032,"target_type":"node","target_uuid":"231fe94d-ce50-4577-aa8d-59e22aebc1d8","url":"/node/1032"},{"target_id":1324,"target_type":"node","target_uuid":"289fca3a-c398-4c91-916a-8be7ec2e1e72","url":"/node/1324"}]},"associated_channels":{"label":"Zugehörige Newskanäle","type":"entity_reference","required":false,"value":[]},"associated_content":{"label":"Assoziierte Inhalte","type":"entity_reference","required":false,"value":[{"target_id":751,"target_type":"node","target_uuid":"66b7dee7-8aef-4d44-8216-24203b04cbf6","url":"/node/751"},{"target_id":1398}]},"community_picture":{"label":"Profilbild","type":"image","required":false,"default":{"url":"/themes/contrib/piipe_backend/images/icons/media/picture-placeholder.svg","alt":"Standardbild für die Community HR"},"value":{"url":"/system/files/styles/thumbnail/private/community/14/community-picture/Team.jpg?h=fa4a2dfc&itok=6RPHnm36","alt":"Standardbild für die Community HR"}},"description":{"label":"Beschreibung","type":"text_long","required":false,"value":"Willkommen im HR-Forum! Diese Community bietet allen Kolleginnen und Kollegen eine Plattform für den Austausch zu allen Themen rund um Human Resources. Ob es um Recruiting, Mitarbeiterentwicklung, Unternehmenskultur, Diversity, Arbeitsrecht oder Work-Life-Balance geht – hier können Fragen gestellt, Erfahrungen geteilt und Best Practices diskutiert werden. Unser Ziel ist es, Wissen zu bündeln, neue Ideen zu entwickeln und gemeinsam Lösungen für die täglichen Herausforderungen im Personalbereich zu finden.\n\nTritt der Community bei und gestalte aktiv mit, wie wir unsere Arbeitswelt noch besser machen können!"},"field_consent_text":{"label":"Zustimmungstext","type":"string_long","required":false,"value":null},"field_enable_consent":{"label":"Einwilligung aktivieren","type":"boolean","required":false,"value":null},"rules":{"label":"Regeln","type":"text_long","required":false,"value":null}}; // map[String, CommunityField] | 

        try {
            map['String', CommunityField] result = apiInstance.communitySettingsGidPatch(gid, requestBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommunityApi#communitySettingsGidPatch");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
CommunityApi *apiInstance = [[CommunityApi alloc] init];
Integer *gid = 56; // The ID of the community. (default to null)
map[String, CommunityField] *requestBody = {"gid":{"label":"ID","type":"integer","required":false,"value":"14"},"uuid":{"label":"UUID","type":"uuid","required":false,"value":"a94b5d1f-1f04-40ee-8129-f5de192937d8"},"langcode":{"label":"Sprache","type":"language","required":false,"value":"en"},"uid":{"label":"Created by","type":"entity_reference","required":false,"value":[{"target_id":112,"target_type":"user","target_uuid":"acddabfb-91a3-4c01-af18-bf977c88a77e","url":"/user/112"}]},"title":{"label":"Titel","type":"string","required":true,"value":"HR"},"type":{"label":"Typ","type":"string","required":false,"value":null},"created":{"label":"Created","type":"created","required":false,"value":"30.04.2024"},"members":{"label":"Mitglieder","type":"entity_reference","required":false,"value":[{"target_id":21,"target_type":"community_member","target_uuid":"66a575fb-9dce-4f79-826a-ed80eb5bc20b","url":"/community_member/21?community=14&group=14"},{"target_id":25,"target_type":"community_member","target_uuid":"dc186a71-4dea-4991-9bf3-4705f239790c","url":"/community_member/25?community=14&group=14"},{"target_id":27,"target_type":"community_member","target_uuid":"1544fca1-e21a-402f-aee4-c59f5faa8cde","url":"/community_member/27?community=14&group=14"},{"target_id":29,"target_type":"community_member","target_uuid":"ffca9969-abc5-44f8-8d78-73ff31a7a01b","url":"/community_member/29?community=14&group=14"},{"target_id":30,"target_type":"community_member","target_uuid":"f173c292-6855-4ee5-ba3c-c841b854f50f","url":"/community_member/30?community=14&group=14"},{"target_id":126,"target_type":"community_member","target_uuid":"09325eac-ac16-42cc-86d6-58044541b857","url":"/community_member/126?community=14&group=14"},{"target_id":263,"target_type":"community_member","target_uuid":"b93b5475-ae61-476b-a50b-2aa5bdd90526","url":"/community_member/263?community=14&group=14"}]},"community_visibility":{"label":"Gruppentyp","type":"integer","required":true,"value":"0"},"summary_configuration":{"label":"Zusammenfassungskonfiguration","type":"integer","required":false,"value":null},"joining_requests":{"label":"Beitrittsanfragen","type":"entity_reference","required":false,"value":[]},"default_langcode":{"label":"Standardübersetzung","type":"boolean","required":false,"value":"1"},"community_content":{"label":"Community-Inhalt","type":"entity_reference","required":false,"value":[{"target_id":764,"target_type":"node","target_uuid":"e45e068b-770c-432f-acc9-5eb0cd46155e","url":"/node/764"},{"target_id":1032,"target_type":"node","target_uuid":"231fe94d-ce50-4577-aa8d-59e22aebc1d8","url":"/node/1032"},{"target_id":1324,"target_type":"node","target_uuid":"289fca3a-c398-4c91-916a-8be7ec2e1e72","url":"/node/1324"}]},"associated_channels":{"label":"Zugehörige Newskanäle","type":"entity_reference","required":false,"value":[]},"associated_content":{"label":"Assoziierte Inhalte","type":"entity_reference","required":false,"value":[{"target_id":751,"target_type":"node","target_uuid":"66b7dee7-8aef-4d44-8216-24203b04cbf6","url":"/node/751"},{"target_id":1398}]},"community_picture":{"label":"Profilbild","type":"image","required":false,"default":{"url":"/themes/contrib/piipe_backend/images/icons/media/picture-placeholder.svg","alt":"Standardbild für die Community HR"},"value":{"url":"/system/files/styles/thumbnail/private/community/14/community-picture/Team.jpg?h=fa4a2dfc&itok=6RPHnm36","alt":"Standardbild für die Community HR"}},"description":{"label":"Beschreibung","type":"text_long","required":false,"value":"Willkommen im HR-Forum! Diese Community bietet allen Kolleginnen und Kollegen eine Plattform für den Austausch zu allen Themen rund um Human Resources. Ob es um Recruiting, Mitarbeiterentwicklung, Unternehmenskultur, Diversity, Arbeitsrecht oder Work-Life-Balance geht – hier können Fragen gestellt, Erfahrungen geteilt und Best Practices diskutiert werden. Unser Ziel ist es, Wissen zu bündeln, neue Ideen zu entwickeln und gemeinsam Lösungen für die täglichen Herausforderungen im Personalbereich zu finden.\n\nTritt der Community bei und gestalte aktiv mit, wie wir unsere Arbeitswelt noch besser machen können!"},"field_consent_text":{"label":"Zustimmungstext","type":"string_long","required":false,"value":null},"field_enable_consent":{"label":"Einwilligung aktivieren","type":"boolean","required":false,"value":null},"rules":{"label":"Regeln","type":"text_long","required":false,"value":null}}; // 

// Update community settings.
[apiInstance communitySettingsGidPatchWith:gid
    requestBody:requestBody
              completionHandler: ^(map['String', CommunityField] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.CommunityApi()
var gid = 56; // {Integer} The ID of the community.
var requestBody = {"gid":{"label":"ID","type":"integer","required":false,"value":"14"},"uuid":{"label":"UUID","type":"uuid","required":false,"value":"a94b5d1f-1f04-40ee-8129-f5de192937d8"},"langcode":{"label":"Sprache","type":"language","required":false,"value":"en"},"uid":{"label":"Created by","type":"entity_reference","required":false,"value":[{"target_id":112,"target_type":"user","target_uuid":"acddabfb-91a3-4c01-af18-bf977c88a77e","url":"/user/112"}]},"title":{"label":"Titel","type":"string","required":true,"value":"HR"},"type":{"label":"Typ","type":"string","required":false,"value":null},"created":{"label":"Created","type":"created","required":false,"value":"30.04.2024"},"members":{"label":"Mitglieder","type":"entity_reference","required":false,"value":[{"target_id":21,"target_type":"community_member","target_uuid":"66a575fb-9dce-4f79-826a-ed80eb5bc20b","url":"/community_member/21?community=14&group=14"},{"target_id":25,"target_type":"community_member","target_uuid":"dc186a71-4dea-4991-9bf3-4705f239790c","url":"/community_member/25?community=14&group=14"},{"target_id":27,"target_type":"community_member","target_uuid":"1544fca1-e21a-402f-aee4-c59f5faa8cde","url":"/community_member/27?community=14&group=14"},{"target_id":29,"target_type":"community_member","target_uuid":"ffca9969-abc5-44f8-8d78-73ff31a7a01b","url":"/community_member/29?community=14&group=14"},{"target_id":30,"target_type":"community_member","target_uuid":"f173c292-6855-4ee5-ba3c-c841b854f50f","url":"/community_member/30?community=14&group=14"},{"target_id":126,"target_type":"community_member","target_uuid":"09325eac-ac16-42cc-86d6-58044541b857","url":"/community_member/126?community=14&group=14"},{"target_id":263,"target_type":"community_member","target_uuid":"b93b5475-ae61-476b-a50b-2aa5bdd90526","url":"/community_member/263?community=14&group=14"}]},"community_visibility":{"label":"Gruppentyp","type":"integer","required":true,"value":"0"},"summary_configuration":{"label":"Zusammenfassungskonfiguration","type":"integer","required":false,"value":null},"joining_requests":{"label":"Beitrittsanfragen","type":"entity_reference","required":false,"value":[]},"default_langcode":{"label":"Standardübersetzung","type":"boolean","required":false,"value":"1"},"community_content":{"label":"Community-Inhalt","type":"entity_reference","required":false,"value":[{"target_id":764,"target_type":"node","target_uuid":"e45e068b-770c-432f-acc9-5eb0cd46155e","url":"/node/764"},{"target_id":1032,"target_type":"node","target_uuid":"231fe94d-ce50-4577-aa8d-59e22aebc1d8","url":"/node/1032"},{"target_id":1324,"target_type":"node","target_uuid":"289fca3a-c398-4c91-916a-8be7ec2e1e72","url":"/node/1324"}]},"associated_channels":{"label":"Zugehörige Newskanäle","type":"entity_reference","required":false,"value":[]},"associated_content":{"label":"Assoziierte Inhalte","type":"entity_reference","required":false,"value":[{"target_id":751,"target_type":"node","target_uuid":"66b7dee7-8aef-4d44-8216-24203b04cbf6","url":"/node/751"},{"target_id":1398}]},"community_picture":{"label":"Profilbild","type":"image","required":false,"default":{"url":"/themes/contrib/piipe_backend/images/icons/media/picture-placeholder.svg","alt":"Standardbild für die Community HR"},"value":{"url":"/system/files/styles/thumbnail/private/community/14/community-picture/Team.jpg?h=fa4a2dfc&itok=6RPHnm36","alt":"Standardbild für die Community HR"}},"description":{"label":"Beschreibung","type":"text_long","required":false,"value":"Willkommen im HR-Forum! Diese Community bietet allen Kolleginnen und Kollegen eine Plattform für den Austausch zu allen Themen rund um Human Resources. Ob es um Recruiting, Mitarbeiterentwicklung, Unternehmenskultur, Diversity, Arbeitsrecht oder Work-Life-Balance geht – hier können Fragen gestellt, Erfahrungen geteilt und Best Practices diskutiert werden. Unser Ziel ist es, Wissen zu bündeln, neue Ideen zu entwickeln und gemeinsam Lösungen für die täglichen Herausforderungen im Personalbereich zu finden.\n\nTritt der Community bei und gestalte aktiv mit, wie wir unsere Arbeitswelt noch besser machen können!"},"field_consent_text":{"label":"Zustimmungstext","type":"string_long","required":false,"value":null},"field_enable_consent":{"label":"Einwilligung aktivieren","type":"boolean","required":false,"value":null},"rules":{"label":"Regeln","type":"text_long","required":false,"value":null}}; // {map[String, CommunityField]} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.communitySettingsGidPatch(gid, requestBody, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class communitySettingsGidPatchExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CommunityApi();
            var gid = 56;  // Integer | The ID of the community. (default to null)
            var requestBody = new map[String, CommunityField](); // map[String, CommunityField] | 

            try {
                // Update community settings.
                map['String', CommunityField] result = apiInstance.communitySettingsGidPatch(gid, requestBody);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommunityApi.communitySettingsGidPatch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommunityApi();
$gid = 56; // Integer | The ID of the community.
$requestBody = {"gid":{"label":"ID","type":"integer","required":false,"value":"14"},"uuid":{"label":"UUID","type":"uuid","required":false,"value":"a94b5d1f-1f04-40ee-8129-f5de192937d8"},"langcode":{"label":"Sprache","type":"language","required":false,"value":"en"},"uid":{"label":"Created by","type":"entity_reference","required":false,"value":[{"target_id":112,"target_type":"user","target_uuid":"acddabfb-91a3-4c01-af18-bf977c88a77e","url":"/user/112"}]},"title":{"label":"Titel","type":"string","required":true,"value":"HR"},"type":{"label":"Typ","type":"string","required":false,"value":null},"created":{"label":"Created","type":"created","required":false,"value":"30.04.2024"},"members":{"label":"Mitglieder","type":"entity_reference","required":false,"value":[{"target_id":21,"target_type":"community_member","target_uuid":"66a575fb-9dce-4f79-826a-ed80eb5bc20b","url":"/community_member/21?community=14&group=14"},{"target_id":25,"target_type":"community_member","target_uuid":"dc186a71-4dea-4991-9bf3-4705f239790c","url":"/community_member/25?community=14&group=14"},{"target_id":27,"target_type":"community_member","target_uuid":"1544fca1-e21a-402f-aee4-c59f5faa8cde","url":"/community_member/27?community=14&group=14"},{"target_id":29,"target_type":"community_member","target_uuid":"ffca9969-abc5-44f8-8d78-73ff31a7a01b","url":"/community_member/29?community=14&group=14"},{"target_id":30,"target_type":"community_member","target_uuid":"f173c292-6855-4ee5-ba3c-c841b854f50f","url":"/community_member/30?community=14&group=14"},{"target_id":126,"target_type":"community_member","target_uuid":"09325eac-ac16-42cc-86d6-58044541b857","url":"/community_member/126?community=14&group=14"},{"target_id":263,"target_type":"community_member","target_uuid":"b93b5475-ae61-476b-a50b-2aa5bdd90526","url":"/community_member/263?community=14&group=14"}]},"community_visibility":{"label":"Gruppentyp","type":"integer","required":true,"value":"0"},"summary_configuration":{"label":"Zusammenfassungskonfiguration","type":"integer","required":false,"value":null},"joining_requests":{"label":"Beitrittsanfragen","type":"entity_reference","required":false,"value":[]},"default_langcode":{"label":"Standardübersetzung","type":"boolean","required":false,"value":"1"},"community_content":{"label":"Community-Inhalt","type":"entity_reference","required":false,"value":[{"target_id":764,"target_type":"node","target_uuid":"e45e068b-770c-432f-acc9-5eb0cd46155e","url":"/node/764"},{"target_id":1032,"target_type":"node","target_uuid":"231fe94d-ce50-4577-aa8d-59e22aebc1d8","url":"/node/1032"},{"target_id":1324,"target_type":"node","target_uuid":"289fca3a-c398-4c91-916a-8be7ec2e1e72","url":"/node/1324"}]},"associated_channels":{"label":"Zugehörige Newskanäle","type":"entity_reference","required":false,"value":[]},"associated_content":{"label":"Assoziierte Inhalte","type":"entity_reference","required":false,"value":[{"target_id":751,"target_type":"node","target_uuid":"66b7dee7-8aef-4d44-8216-24203b04cbf6","url":"/node/751"},{"target_id":1398}]},"community_picture":{"label":"Profilbild","type":"image","required":false,"default":{"url":"/themes/contrib/piipe_backend/images/icons/media/picture-placeholder.svg","alt":"Standardbild für die Community HR"},"value":{"url":"/system/files/styles/thumbnail/private/community/14/community-picture/Team.jpg?h=fa4a2dfc&itok=6RPHnm36","alt":"Standardbild für die Community HR"}},"description":{"label":"Beschreibung","type":"text_long","required":false,"value":"Willkommen im HR-Forum! Diese Community bietet allen Kolleginnen und Kollegen eine Plattform für den Austausch zu allen Themen rund um Human Resources. Ob es um Recruiting, Mitarbeiterentwicklung, Unternehmenskultur, Diversity, Arbeitsrecht oder Work-Life-Balance geht – hier können Fragen gestellt, Erfahrungen geteilt und Best Practices diskutiert werden. Unser Ziel ist es, Wissen zu bündeln, neue Ideen zu entwickeln und gemeinsam Lösungen für die täglichen Herausforderungen im Personalbereich zu finden.\n\nTritt der Community bei und gestalte aktiv mit, wie wir unsere Arbeitswelt noch besser machen können!"},"field_consent_text":{"label":"Zustimmungstext","type":"string_long","required":false,"value":null},"field_enable_consent":{"label":"Einwilligung aktivieren","type":"boolean","required":false,"value":null},"rules":{"label":"Regeln","type":"text_long","required":false,"value":null}}; // map[String, CommunityField] | 

try {
    $result = $api_instance->communitySettingsGidPatch($gid, $requestBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommunityApi->communitySettingsGidPatch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommunityApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommunityApi->new();
my $gid = 56; # Integer | The ID of the community.
my $requestBody = WWW::OPenAPIClient::Object::map[String, CommunityField]->new(); # map[String, CommunityField] | 

eval {
    my $result = $api_instance->communitySettingsGidPatch(gid => $gid, requestBody => $requestBody);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommunityApi->communitySettingsGidPatch: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CommunityApi()
gid = 56 # Integer | The ID of the community. (default to null)
requestBody = {"gid":{"label":"ID","type":"integer","required":false,"value":"14"},"uuid":{"label":"UUID","type":"uuid","required":false,"value":"a94b5d1f-1f04-40ee-8129-f5de192937d8"},"langcode":{"label":"Sprache","type":"language","required":false,"value":"en"},"uid":{"label":"Created by","type":"entity_reference","required":false,"value":[{"target_id":112,"target_type":"user","target_uuid":"acddabfb-91a3-4c01-af18-bf977c88a77e","url":"/user/112"}]},"title":{"label":"Titel","type":"string","required":true,"value":"HR"},"type":{"label":"Typ","type":"string","required":false,"value":null},"created":{"label":"Created","type":"created","required":false,"value":"30.04.2024"},"members":{"label":"Mitglieder","type":"entity_reference","required":false,"value":[{"target_id":21,"target_type":"community_member","target_uuid":"66a575fb-9dce-4f79-826a-ed80eb5bc20b","url":"/community_member/21?community=14&group=14"},{"target_id":25,"target_type":"community_member","target_uuid":"dc186a71-4dea-4991-9bf3-4705f239790c","url":"/community_member/25?community=14&group=14"},{"target_id":27,"target_type":"community_member","target_uuid":"1544fca1-e21a-402f-aee4-c59f5faa8cde","url":"/community_member/27?community=14&group=14"},{"target_id":29,"target_type":"community_member","target_uuid":"ffca9969-abc5-44f8-8d78-73ff31a7a01b","url":"/community_member/29?community=14&group=14"},{"target_id":30,"target_type":"community_member","target_uuid":"f173c292-6855-4ee5-ba3c-c841b854f50f","url":"/community_member/30?community=14&group=14"},{"target_id":126,"target_type":"community_member","target_uuid":"09325eac-ac16-42cc-86d6-58044541b857","url":"/community_member/126?community=14&group=14"},{"target_id":263,"target_type":"community_member","target_uuid":"b93b5475-ae61-476b-a50b-2aa5bdd90526","url":"/community_member/263?community=14&group=14"}]},"community_visibility":{"label":"Gruppentyp","type":"integer","required":true,"value":"0"},"summary_configuration":{"label":"Zusammenfassungskonfiguration","type":"integer","required":false,"value":null},"joining_requests":{"label":"Beitrittsanfragen","type":"entity_reference","required":false,"value":[]},"default_langcode":{"label":"Standardübersetzung","type":"boolean","required":false,"value":"1"},"community_content":{"label":"Community-Inhalt","type":"entity_reference","required":false,"value":[{"target_id":764,"target_type":"node","target_uuid":"e45e068b-770c-432f-acc9-5eb0cd46155e","url":"/node/764"},{"target_id":1032,"target_type":"node","target_uuid":"231fe94d-ce50-4577-aa8d-59e22aebc1d8","url":"/node/1032"},{"target_id":1324,"target_type":"node","target_uuid":"289fca3a-c398-4c91-916a-8be7ec2e1e72","url":"/node/1324"}]},"associated_channels":{"label":"Zugehörige Newskanäle","type":"entity_reference","required":false,"value":[]},"associated_content":{"label":"Assoziierte Inhalte","type":"entity_reference","required":false,"value":[{"target_id":751,"target_type":"node","target_uuid":"66b7dee7-8aef-4d44-8216-24203b04cbf6","url":"/node/751"},{"target_id":1398}]},"community_picture":{"label":"Profilbild","type":"image","required":false,"default":{"url":"/themes/contrib/piipe_backend/images/icons/media/picture-placeholder.svg","alt":"Standardbild für die Community HR"},"value":{"url":"/system/files/styles/thumbnail/private/community/14/community-picture/Team.jpg?h=fa4a2dfc&itok=6RPHnm36","alt":"Standardbild für die Community HR"}},"description":{"label":"Beschreibung","type":"text_long","required":false,"value":"Willkommen im HR-Forum! Diese Community bietet allen Kolleginnen und Kollegen eine Plattform für den Austausch zu allen Themen rund um Human Resources. Ob es um Recruiting, Mitarbeiterentwicklung, Unternehmenskultur, Diversity, Arbeitsrecht oder Work-Life-Balance geht – hier können Fragen gestellt, Erfahrungen geteilt und Best Practices diskutiert werden. Unser Ziel ist es, Wissen zu bündeln, neue Ideen zu entwickeln und gemeinsam Lösungen für die täglichen Herausforderungen im Personalbereich zu finden.\n\nTritt der Community bei und gestalte aktiv mit, wie wir unsere Arbeitswelt noch besser machen können!"},"field_consent_text":{"label":"Zustimmungstext","type":"string_long","required":false,"value":null},"field_enable_consent":{"label":"Einwilligung aktivieren","type":"boolean","required":false,"value":null},"rules":{"label":"Regeln","type":"text_long","required":false,"value":null}} # map[String, CommunityField] | 

try:
    # Update community settings.
    api_response = api_instance.community_settings_gid_patch(gid, requestBody)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommunityApi->communitySettingsGidPatch: %s\n" % e)
extern crate CommunityApi;

pub fn main() {
    let gid = 56; // Integer
    let requestBody = {"gid":{"label":"ID","type":"integer","required":false,"value":"14"},"uuid":{"label":"UUID","type":"uuid","required":false,"value":"a94b5d1f-1f04-40ee-8129-f5de192937d8"},"langcode":{"label":"Sprache","type":"language","required":false,"value":"en"},"uid":{"label":"Created by","type":"entity_reference","required":false,"value":[{"target_id":112,"target_type":"user","target_uuid":"acddabfb-91a3-4c01-af18-bf977c88a77e","url":"/user/112"}]},"title":{"label":"Titel","type":"string","required":true,"value":"HR"},"type":{"label":"Typ","type":"string","required":false,"value":null},"created":{"label":"Created","type":"created","required":false,"value":"30.04.2024"},"members":{"label":"Mitglieder","type":"entity_reference","required":false,"value":[{"target_id":21,"target_type":"community_member","target_uuid":"66a575fb-9dce-4f79-826a-ed80eb5bc20b","url":"/community_member/21?community=14&group=14"},{"target_id":25,"target_type":"community_member","target_uuid":"dc186a71-4dea-4991-9bf3-4705f239790c","url":"/community_member/25?community=14&group=14"},{"target_id":27,"target_type":"community_member","target_uuid":"1544fca1-e21a-402f-aee4-c59f5faa8cde","url":"/community_member/27?community=14&group=14"},{"target_id":29,"target_type":"community_member","target_uuid":"ffca9969-abc5-44f8-8d78-73ff31a7a01b","url":"/community_member/29?community=14&group=14"},{"target_id":30,"target_type":"community_member","target_uuid":"f173c292-6855-4ee5-ba3c-c841b854f50f","url":"/community_member/30?community=14&group=14"},{"target_id":126,"target_type":"community_member","target_uuid":"09325eac-ac16-42cc-86d6-58044541b857","url":"/community_member/126?community=14&group=14"},{"target_id":263,"target_type":"community_member","target_uuid":"b93b5475-ae61-476b-a50b-2aa5bdd90526","url":"/community_member/263?community=14&group=14"}]},"community_visibility":{"label":"Gruppentyp","type":"integer","required":true,"value":"0"},"summary_configuration":{"label":"Zusammenfassungskonfiguration","type":"integer","required":false,"value":null},"joining_requests":{"label":"Beitrittsanfragen","type":"entity_reference","required":false,"value":[]},"default_langcode":{"label":"Standardübersetzung","type":"boolean","required":false,"value":"1"},"community_content":{"label":"Community-Inhalt","type":"entity_reference","required":false,"value":[{"target_id":764,"target_type":"node","target_uuid":"e45e068b-770c-432f-acc9-5eb0cd46155e","url":"/node/764"},{"target_id":1032,"target_type":"node","target_uuid":"231fe94d-ce50-4577-aa8d-59e22aebc1d8","url":"/node/1032"},{"target_id":1324,"target_type":"node","target_uuid":"289fca3a-c398-4c91-916a-8be7ec2e1e72","url":"/node/1324"}]},"associated_channels":{"label":"Zugehörige Newskanäle","type":"entity_reference","required":false,"value":[]},"associated_content":{"label":"Assoziierte Inhalte","type":"entity_reference","required":false,"value":[{"target_id":751,"target_type":"node","target_uuid":"66b7dee7-8aef-4d44-8216-24203b04cbf6","url":"/node/751"},{"target_id":1398}]},"community_picture":{"label":"Profilbild","type":"image","required":false,"default":{"url":"/themes/contrib/piipe_backend/images/icons/media/picture-placeholder.svg","alt":"Standardbild für die Community HR"},"value":{"url":"/system/files/styles/thumbnail/private/community/14/community-picture/Team.jpg?h=fa4a2dfc&itok=6RPHnm36","alt":"Standardbild für die Community HR"}},"description":{"label":"Beschreibung","type":"text_long","required":false,"value":"Willkommen im HR-Forum! Diese Community bietet allen Kolleginnen und Kollegen eine Plattform für den Austausch zu allen Themen rund um Human Resources. Ob es um Recruiting, Mitarbeiterentwicklung, Unternehmenskultur, Diversity, Arbeitsrecht oder Work-Life-Balance geht – hier können Fragen gestellt, Erfahrungen geteilt und Best Practices diskutiert werden. Unser Ziel ist es, Wissen zu bündeln, neue Ideen zu entwickeln und gemeinsam Lösungen für die täglichen Herausforderungen im Personalbereich zu finden.\n\nTritt der Community bei und gestalte aktiv mit, wie wir unsere Arbeitswelt noch besser machen können!"},"field_consent_text":{"label":"Zustimmungstext","type":"string_long","required":false,"value":null},"field_enable_consent":{"label":"Einwilligung aktivieren","type":"boolean","required":false,"value":null},"rules":{"label":"Regeln","type":"text_long","required":false,"value":null}}; // map[String, CommunityField]

    let mut context = CommunityApi::Context::default();
    let result = client.communitySettingsGidPatch(gid, requestBody, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
gid*
Integer
The ID of the community.
Required
Body parameters
Name Description
requestBody *

Patch community settings.

Responses


communitySettingsGidUserGet

Get community user settings.

Returns user-specific settings for the current user in the specified community.


/community/settings/{gid}/user

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/community/settings/{gid}/user"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommunityApi;

import java.io.File;
import java.util.*;

public class CommunityApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        CommunityApi apiInstance = new CommunityApi();
        Integer gid = 56; // Integer | The ID of the community.

        try {
            CommunityUserSettings result = apiInstance.communitySettingsGidUserGet(gid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommunityApi#communitySettingsGidUserGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer gid = new Integer(); // Integer | The ID of the community.

try {
    final result = await api_instance.communitySettingsGidUserGet(gid);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->communitySettingsGidUserGet: $e\n');
}

import org.openapitools.client.api.CommunityApi;

public class CommunityApiExample {
    public static void main(String[] args) {
        CommunityApi apiInstance = new CommunityApi();
        Integer gid = 56; // Integer | The ID of the community.

        try {
            CommunityUserSettings result = apiInstance.communitySettingsGidUserGet(gid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommunityApi#communitySettingsGidUserGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
CommunityApi *apiInstance = [[CommunityApi alloc] init];
Integer *gid = 56; // The ID of the community. (default to null)

// Get community user settings.
[apiInstance communitySettingsGidUserGetWith:gid
              completionHandler: ^(CommunityUserSettings output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.CommunityApi()
var gid = 56; // {Integer} The ID of the community.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.communitySettingsGidUserGet(gid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class communitySettingsGidUserGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CommunityApi();
            var gid = 56;  // Integer | The ID of the community. (default to null)

            try {
                // Get community user settings.
                CommunityUserSettings result = apiInstance.communitySettingsGidUserGet(gid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommunityApi.communitySettingsGidUserGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommunityApi();
$gid = 56; // Integer | The ID of the community.

try {
    $result = $api_instance->communitySettingsGidUserGet($gid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommunityApi->communitySettingsGidUserGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommunityApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommunityApi->new();
my $gid = 56; # Integer | The ID of the community.

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CommunityApi()
gid = 56 # Integer | The ID of the community. (default to null)

try:
    # Get community user settings.
    api_response = api_instance.community_settings_gid_user_get(gid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommunityApi->communitySettingsGidUserGet: %s\n" % e)
extern crate CommunityApi;

pub fn main() {
    let gid = 56; // Integer

    let mut context = CommunityApi::Context::default();
    let result = client.communitySettingsGidUserGet(gid, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
gid*
Integer
The ID of the community.
Required

Responses


communitySettingsGidUserPatch

Update community user settings.

Updates user-specific settings for the current user in the specified community.


/community/settings/{gid}/user

Usage and SDK Samples

curl -X PATCH \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://nextworkplace.staging/api/v1/community/settings/{gid}/user" \
 -d '{
  "community_notifications" : [ {
    "system" : true,
    "mail" : true,
    "id" : 0,
    "push" : true
  }, {
    "system" : true,
    "mail" : true,
    "id" : 0,
    "push" : true
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommunityApi;

import java.io.File;
import java.util.*;

public class CommunityApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        CommunityApi apiInstance = new CommunityApi();
        Integer gid = 56; // Integer | The ID of the community.
        CommunityUserSettingsPatchRequest communityUserSettingsPatchRequest = ; // CommunityUserSettingsPatchRequest | 

        try {
            CommunityUserSettings result = apiInstance.communitySettingsGidUserPatch(gid, communityUserSettingsPatchRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommunityApi#communitySettingsGidUserPatch");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer gid = new Integer(); // Integer | The ID of the community.
final CommunityUserSettingsPatchRequest communityUserSettingsPatchRequest = new CommunityUserSettingsPatchRequest(); // CommunityUserSettingsPatchRequest | 

try {
    final result = await api_instance.communitySettingsGidUserPatch(gid, communityUserSettingsPatchRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->communitySettingsGidUserPatch: $e\n');
}

import org.openapitools.client.api.CommunityApi;

public class CommunityApiExample {
    public static void main(String[] args) {
        CommunityApi apiInstance = new CommunityApi();
        Integer gid = 56; // Integer | The ID of the community.
        CommunityUserSettingsPatchRequest communityUserSettingsPatchRequest = ; // CommunityUserSettingsPatchRequest | 

        try {
            CommunityUserSettings result = apiInstance.communitySettingsGidUserPatch(gid, communityUserSettingsPatchRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommunityApi#communitySettingsGidUserPatch");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
CommunityApi *apiInstance = [[CommunityApi alloc] init];
Integer *gid = 56; // The ID of the community. (default to null)
CommunityUserSettingsPatchRequest *communityUserSettingsPatchRequest = ; // 

// Update community user settings.
[apiInstance communitySettingsGidUserPatchWith:gid
    communityUserSettingsPatchRequest:communityUserSettingsPatchRequest
              completionHandler: ^(CommunityUserSettings output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.CommunityApi()
var gid = 56; // {Integer} The ID of the community.
var communityUserSettingsPatchRequest = ; // {CommunityUserSettingsPatchRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.communitySettingsGidUserPatch(gid, communityUserSettingsPatchRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class communitySettingsGidUserPatchExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CommunityApi();
            var gid = 56;  // Integer | The ID of the community. (default to null)
            var communityUserSettingsPatchRequest = new CommunityUserSettingsPatchRequest(); // CommunityUserSettingsPatchRequest | 

            try {
                // Update community user settings.
                CommunityUserSettings result = apiInstance.communitySettingsGidUserPatch(gid, communityUserSettingsPatchRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommunityApi.communitySettingsGidUserPatch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommunityApi();
$gid = 56; // Integer | The ID of the community.
$communityUserSettingsPatchRequest = ; // CommunityUserSettingsPatchRequest | 

try {
    $result = $api_instance->communitySettingsGidUserPatch($gid, $communityUserSettingsPatchRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommunityApi->communitySettingsGidUserPatch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommunityApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommunityApi->new();
my $gid = 56; # Integer | The ID of the community.
my $communityUserSettingsPatchRequest = WWW::OPenAPIClient::Object::CommunityUserSettingsPatchRequest->new(); # CommunityUserSettingsPatchRequest | 

eval {
    my $result = $api_instance->communitySettingsGidUserPatch(gid => $gid, communityUserSettingsPatchRequest => $communityUserSettingsPatchRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommunityApi->communitySettingsGidUserPatch: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CommunityApi()
gid = 56 # Integer | The ID of the community. (default to null)
communityUserSettingsPatchRequest =  # CommunityUserSettingsPatchRequest | 

try:
    # Update community user settings.
    api_response = api_instance.community_settings_gid_user_patch(gid, communityUserSettingsPatchRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommunityApi->communitySettingsGidUserPatch: %s\n" % e)
extern crate CommunityApi;

pub fn main() {
    let gid = 56; // Integer
    let communityUserSettingsPatchRequest = ; // CommunityUserSettingsPatchRequest

    let mut context = CommunityApi::Context::default();
    let result = client.communitySettingsGidUserPatch(gid, communityUserSettingsPatchRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
gid*
Integer
The ID of the community.
Required
Body parameters
Name Description
communityUserSettingsPatchRequest *

User-specific community settings to update.

Responses


Configuration

birthdayCalendarFiltersGet

Get birthday calendar filters.


/birthday_calendar_filters

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/birthday_calendar_filters"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConfigurationApi;

import java.io.File;
import java.util.*;

public class ConfigurationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ConfigurationApi apiInstance = new ConfigurationApi();

        try {
            _birthday_calendar_filters_get_200_response result = apiInstance.birthdayCalendarFiltersGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationApi#birthdayCalendarFiltersGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.birthdayCalendarFiltersGet();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->birthdayCalendarFiltersGet: $e\n');
}

import org.openapitools.client.api.ConfigurationApi;

public class ConfigurationApiExample {
    public static void main(String[] args) {
        ConfigurationApi apiInstance = new ConfigurationApi();

        try {
            _birthday_calendar_filters_get_200_response result = apiInstance.birthdayCalendarFiltersGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationApi#birthdayCalendarFiltersGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ConfigurationApi *apiInstance = [[ConfigurationApi alloc] init];

// Get birthday calendar filters.
[apiInstance birthdayCalendarFiltersGetWithCompletionHandler: 
              ^(_birthday_calendar_filters_get_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.ConfigurationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.birthdayCalendarFiltersGet(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class birthdayCalendarFiltersGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ConfigurationApi();

            try {
                // Get birthday calendar filters.
                _birthday_calendar_filters_get_200_response result = apiInstance.birthdayCalendarFiltersGet();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ConfigurationApi.birthdayCalendarFiltersGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ConfigurationApi();

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ConfigurationApi->new();

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ConfigurationApi()

try:
    # Get birthday calendar filters.
    api_response = api_instance.birthday_calendar_filters_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->birthdayCalendarFiltersGet: %s\n" % e)
extern crate ConfigurationApi;

pub fn main() {

    let mut context = ConfigurationApi::Context::default();
    let result = client.birthdayCalendarFiltersGet(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


boxPagesFrontendBoxesReorderGet

Get reorder settings in dynamic box pages.

Reorder boxes as they appeare in a dynamic box page.


/box_pages/frontend/boxes/reorder

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/box_pages/frontend/boxes/reorder?machine_name=my_page"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConfigurationApi;

import java.io.File;
import java.util.*;

public class ConfigurationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ConfigurationApi apiInstance = new ConfigurationApi();
        String machineName = my_page; // String | The box page machine name.

        try {
            array[Box-Page-Reorder-Settings] result = apiInstance.boxPagesFrontendBoxesReorderGet(machineName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationApi#boxPagesFrontendBoxesReorderGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String machineName = new String(); // String | The box page machine name.

try {
    final result = await api_instance.boxPagesFrontendBoxesReorderGet(machineName);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->boxPagesFrontendBoxesReorderGet: $e\n');
}

import org.openapitools.client.api.ConfigurationApi;

public class ConfigurationApiExample {
    public static void main(String[] args) {
        ConfigurationApi apiInstance = new ConfigurationApi();
        String machineName = my_page; // String | The box page machine name.

        try {
            array[Box-Page-Reorder-Settings] result = apiInstance.boxPagesFrontendBoxesReorderGet(machineName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationApi#boxPagesFrontendBoxesReorderGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ConfigurationApi *apiInstance = [[ConfigurationApi alloc] init];
String *machineName = my_page; // The box page machine name. (optional) (default to null)

// Get reorder settings in dynamic box pages.
[apiInstance boxPagesFrontendBoxesReorderGetWith:machineName
              completionHandler: ^(array[Box-Page-Reorder-Settings] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.ConfigurationApi()
var opts = {
  'machineName': my_page // {String} The box page machine name.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.boxPagesFrontendBoxesReorderGet(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class boxPagesFrontendBoxesReorderGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ConfigurationApi();
            var machineName = my_page;  // String | The box page machine name. (optional)  (default to null)

            try {
                // Get reorder settings in dynamic box pages.
                array[Box-Page-Reorder-Settings] result = apiInstance.boxPagesFrontendBoxesReorderGet(machineName);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ConfigurationApi.boxPagesFrontendBoxesReorderGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ConfigurationApi();
$machineName = my_page; // String | The box page machine name.

try {
    $result = $api_instance->boxPagesFrontendBoxesReorderGet($machineName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConfigurationApi->boxPagesFrontendBoxesReorderGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ConfigurationApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ConfigurationApi->new();
my $machineName = my_page; # String | The box page machine name.

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ConfigurationApi()
machineName = my_page # String | The box page machine name. (optional) (default to null)

try:
    # Get reorder settings in dynamic box pages.
    api_response = api_instance.box_pages_frontend_boxes_reorder_get(machineName=machineName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->boxPagesFrontendBoxesReorderGet: %s\n" % e)
extern crate ConfigurationApi;

pub fn main() {
    let machineName = my_page; // String

    let mut context = ConfigurationApi::Context::default();
    let result = client.boxPagesFrontendBoxesReorderGet(machineName, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
machine_name
String
The box page machine name.

Responses


boxPagesFrontendBoxesReorderPatch

Apply reorder settings in dynamic box pages.

Reorder boxes as they appeare in a dynamic box page.


/box_pages/frontend/boxes/reorder

Usage and SDK Samples

curl -X PATCH \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://nextworkplace.staging/api/v1/box_pages/frontend/boxes/reorder" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConfigurationApi;

import java.io.File;
import java.util.*;

public class ConfigurationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ConfigurationApi apiInstance = new ConfigurationApi();
        BoxPagesFrontendBoxesReorderPatchRequest boxPagesFrontendBoxesReorderPatchRequest = ; // BoxPagesFrontendBoxesReorderPatchRequest | 

        try {
            apiInstance.boxPagesFrontendBoxesReorderPatch(boxPagesFrontendBoxesReorderPatchRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationApi#boxPagesFrontendBoxesReorderPatch");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final BoxPagesFrontendBoxesReorderPatchRequest boxPagesFrontendBoxesReorderPatchRequest = new BoxPagesFrontendBoxesReorderPatchRequest(); // BoxPagesFrontendBoxesReorderPatchRequest | 

try {
    final result = await api_instance.boxPagesFrontendBoxesReorderPatch(boxPagesFrontendBoxesReorderPatchRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->boxPagesFrontendBoxesReorderPatch: $e\n');
}

import org.openapitools.client.api.ConfigurationApi;

public class ConfigurationApiExample {
    public static void main(String[] args) {
        ConfigurationApi apiInstance = new ConfigurationApi();
        BoxPagesFrontendBoxesReorderPatchRequest boxPagesFrontendBoxesReorderPatchRequest = ; // BoxPagesFrontendBoxesReorderPatchRequest | 

        try {
            apiInstance.boxPagesFrontendBoxesReorderPatch(boxPagesFrontendBoxesReorderPatchRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationApi#boxPagesFrontendBoxesReorderPatch");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ConfigurationApi *apiInstance = [[ConfigurationApi alloc] init];
BoxPagesFrontendBoxesReorderPatchRequest *boxPagesFrontendBoxesReorderPatchRequest = ; // 

// Apply reorder settings in dynamic box pages.
[apiInstance boxPagesFrontendBoxesReorderPatchWith:boxPagesFrontendBoxesReorderPatchRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.ConfigurationApi()
var boxPagesFrontendBoxesReorderPatchRequest = ; // {BoxPagesFrontendBoxesReorderPatchRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.boxPagesFrontendBoxesReorderPatch(boxPagesFrontendBoxesReorderPatchRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class boxPagesFrontendBoxesReorderPatchExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ConfigurationApi();
            var boxPagesFrontendBoxesReorderPatchRequest = new BoxPagesFrontendBoxesReorderPatchRequest(); // BoxPagesFrontendBoxesReorderPatchRequest | 

            try {
                // Apply reorder settings in dynamic box pages.
                apiInstance.boxPagesFrontendBoxesReorderPatch(boxPagesFrontendBoxesReorderPatchRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling ConfigurationApi.boxPagesFrontendBoxesReorderPatch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ConfigurationApi();
$boxPagesFrontendBoxesReorderPatchRequest = ; // BoxPagesFrontendBoxesReorderPatchRequest | 

try {
    $api_instance->boxPagesFrontendBoxesReorderPatch($boxPagesFrontendBoxesReorderPatchRequest);
} catch (Exception $e) {
    echo 'Exception when calling ConfigurationApi->boxPagesFrontendBoxesReorderPatch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ConfigurationApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ConfigurationApi->new();
my $boxPagesFrontendBoxesReorderPatchRequest = WWW::OPenAPIClient::Object::BoxPagesFrontendBoxesReorderPatchRequest->new(); # BoxPagesFrontendBoxesReorderPatchRequest | 

eval {
    $api_instance->boxPagesFrontendBoxesReorderPatch(boxPagesFrontendBoxesReorderPatchRequest => $boxPagesFrontendBoxesReorderPatchRequest);
};
if ($@) {
    warn "Exception when calling ConfigurationApi->boxPagesFrontendBoxesReorderPatch: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ConfigurationApi()
boxPagesFrontendBoxesReorderPatchRequest =  # BoxPagesFrontendBoxesReorderPatchRequest | 

try:
    # Apply reorder settings in dynamic box pages.
    api_instance.box_pages_frontend_boxes_reorder_patch(boxPagesFrontendBoxesReorderPatchRequest)
except ApiException as e:
    print("Exception when calling ConfigurationApi->boxPagesFrontendBoxesReorderPatch: %s\n" % e)
extern crate ConfigurationApi;

pub fn main() {
    let boxPagesFrontendBoxesReorderPatchRequest = ; // BoxPagesFrontendBoxesReorderPatchRequest

    let mut context = ConfigurationApi::Context::default();
    let result = client.boxPagesFrontendBoxesReorderPatch(boxPagesFrontendBoxesReorderPatchRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
boxPagesFrontendBoxesReorderPatchRequest *

The reorder settings.

Responses


boxPagesMyPageAddPatch

Add/remove a node to/from my page.

Adding or removing nodes can only be done on nodes which are contained in boxes of type "content box".


/box_pages/my_page_add

Usage and SDK Samples

curl -X PATCH \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://nextworkplace.staging/api/v1/box_pages/my_page_add" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConfigurationApi;

import java.io.File;
import java.util.*;

public class ConfigurationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ConfigurationApi apiInstance = new ConfigurationApi();
        BoxPagesMyPageAddPatchRequest boxPagesMyPageAddPatchRequest = ; // BoxPagesMyPageAddPatchRequest | 

        try {
            _box_pages_my_page_add_patch_200_response result = apiInstance.boxPagesMyPageAddPatch(boxPagesMyPageAddPatchRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationApi#boxPagesMyPageAddPatch");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final BoxPagesMyPageAddPatchRequest boxPagesMyPageAddPatchRequest = new BoxPagesMyPageAddPatchRequest(); // BoxPagesMyPageAddPatchRequest | 

try {
    final result = await api_instance.boxPagesMyPageAddPatch(boxPagesMyPageAddPatchRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->boxPagesMyPageAddPatch: $e\n');
}

import org.openapitools.client.api.ConfigurationApi;

public class ConfigurationApiExample {
    public static void main(String[] args) {
        ConfigurationApi apiInstance = new ConfigurationApi();
        BoxPagesMyPageAddPatchRequest boxPagesMyPageAddPatchRequest = ; // BoxPagesMyPageAddPatchRequest | 

        try {
            _box_pages_my_page_add_patch_200_response result = apiInstance.boxPagesMyPageAddPatch(boxPagesMyPageAddPatchRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationApi#boxPagesMyPageAddPatch");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ConfigurationApi *apiInstance = [[ConfigurationApi alloc] init];
BoxPagesMyPageAddPatchRequest *boxPagesMyPageAddPatchRequest = ; // 

// Add/remove a node to/from my page.
[apiInstance boxPagesMyPageAddPatchWith:boxPagesMyPageAddPatchRequest
              completionHandler: ^(_box_pages_my_page_add_patch_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.ConfigurationApi()
var boxPagesMyPageAddPatchRequest = ; // {BoxPagesMyPageAddPatchRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.boxPagesMyPageAddPatch(boxPagesMyPageAddPatchRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class boxPagesMyPageAddPatchExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ConfigurationApi();
            var boxPagesMyPageAddPatchRequest = new BoxPagesMyPageAddPatchRequest(); // BoxPagesMyPageAddPatchRequest | 

            try {
                // Add/remove a node to/from my page.
                _box_pages_my_page_add_patch_200_response result = apiInstance.boxPagesMyPageAddPatch(boxPagesMyPageAddPatchRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ConfigurationApi.boxPagesMyPageAddPatch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ConfigurationApi();
$boxPagesMyPageAddPatchRequest = ; // BoxPagesMyPageAddPatchRequest | 

try {
    $result = $api_instance->boxPagesMyPageAddPatch($boxPagesMyPageAddPatchRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConfigurationApi->boxPagesMyPageAddPatch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ConfigurationApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ConfigurationApi->new();
my $boxPagesMyPageAddPatchRequest = WWW::OPenAPIClient::Object::BoxPagesMyPageAddPatchRequest->new(); # BoxPagesMyPageAddPatchRequest | 

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ConfigurationApi()
boxPagesMyPageAddPatchRequest =  # BoxPagesMyPageAddPatchRequest | 

try:
    # Add/remove a node to/from my page.
    api_response = api_instance.box_pages_my_page_add_patch(boxPagesMyPageAddPatchRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->boxPagesMyPageAddPatch: %s\n" % e)
extern crate ConfigurationApi;

pub fn main() {
    let boxPagesMyPageAddPatchRequest = ; // BoxPagesMyPageAddPatchRequest

    let mut context = ConfigurationApi::Context::default();
    let result = client.boxPagesMyPageAddPatch(boxPagesMyPageAddPatchRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
boxPagesMyPageAddPatchRequest *

Perform action on node

Responses


bulletinConfigGet

Get the configuration of bulletin board.


/bulletin/config

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/bulletin/config"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConfigurationApi;

import java.io.File;
import java.util.*;

public class ConfigurationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ConfigurationApi apiInstance = new ConfigurationApi();

        try {
            array[Bulletin-Config] result = apiInstance.bulletinConfigGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationApi#bulletinConfigGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.bulletinConfigGet();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->bulletinConfigGet: $e\n');
}

import org.openapitools.client.api.ConfigurationApi;

public class ConfigurationApiExample {
    public static void main(String[] args) {
        ConfigurationApi apiInstance = new ConfigurationApi();

        try {
            array[Bulletin-Config] result = apiInstance.bulletinConfigGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationApi#bulletinConfigGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ConfigurationApi *apiInstance = [[ConfigurationApi alloc] init];

// Get the configuration of bulletin board.
[apiInstance bulletinConfigGetWithCompletionHandler: 
              ^(array[Bulletin-Config] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.ConfigurationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.bulletinConfigGet(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class bulletinConfigGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ConfigurationApi();

            try {
                // Get the configuration of bulletin board.
                array[Bulletin-Config] result = apiInstance.bulletinConfigGet();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ConfigurationApi.bulletinConfigGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ConfigurationApi();

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ConfigurationApi->new();

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ConfigurationApi()

try:
    # Get the configuration of bulletin board.
    api_response = api_instance.bulletin_config_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->bulletinConfigGet: %s\n" % e)
extern crate ConfigurationApi;

pub fn main() {

    let mut context = ConfigurationApi::Context::default();
    let result = client.bulletinConfigGet(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


employeeDirectoryConfigGet

Get the configuration of employee directory.


/employee_directory/config

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/employee_directory/config"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConfigurationApi;

import java.io.File;
import java.util.*;

public class ConfigurationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ConfigurationApi apiInstance = new ConfigurationApi();

        try {
            array[Employees-Config] result = apiInstance.employeeDirectoryConfigGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationApi#employeeDirectoryConfigGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.employeeDirectoryConfigGet();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->employeeDirectoryConfigGet: $e\n');
}

import org.openapitools.client.api.ConfigurationApi;

public class ConfigurationApiExample {
    public static void main(String[] args) {
        ConfigurationApi apiInstance = new ConfigurationApi();

        try {
            array[Employees-Config] result = apiInstance.employeeDirectoryConfigGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationApi#employeeDirectoryConfigGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ConfigurationApi *apiInstance = [[ConfigurationApi alloc] init];

// Get the configuration of employee directory.
[apiInstance employeeDirectoryConfigGetWithCompletionHandler: 
              ^(array[Employees-Config] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.ConfigurationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.employeeDirectoryConfigGet(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class employeeDirectoryConfigGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ConfigurationApi();

            try {
                // Get the configuration of employee directory.
                array[Employees-Config] result = apiInstance.employeeDirectoryConfigGet();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ConfigurationApi.employeeDirectoryConfigGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ConfigurationApi();

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ConfigurationApi->new();

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ConfigurationApi()

try:
    # Get the configuration of employee directory.
    api_response = api_instance.employee_directory_config_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->employeeDirectoryConfigGet: %s\n" % e)
extern crate ConfigurationApi;

pub fn main() {

    let mut context = ConfigurationApi::Context::default();
    let result = client.employeeDirectoryConfigGet(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


scssadminGet

Get SCSS variables.


/scssadmin

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/scssadmin"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConfigurationApi;

import java.io.File;
import java.util.*;

public class ConfigurationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ConfigurationApi apiInstance = new ConfigurationApi();

        try {
            map['String', array[_scssadmin_get_200_response_value_inner]] result = apiInstance.scssadminGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationApi#scssadminGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.scssadminGet();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->scssadminGet: $e\n');
}

import org.openapitools.client.api.ConfigurationApi;

public class ConfigurationApiExample {
    public static void main(String[] args) {
        ConfigurationApi apiInstance = new ConfigurationApi();

        try {
            map['String', array[_scssadmin_get_200_response_value_inner]] result = apiInstance.scssadminGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationApi#scssadminGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ConfigurationApi *apiInstance = [[ConfigurationApi alloc] init];

// Get SCSS variables.
[apiInstance scssadminGetWithCompletionHandler: 
              ^(map['String', array[_scssadmin_get_200_response_value_inner]] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.ConfigurationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.scssadminGet(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class scssadminGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ConfigurationApi();

            try {
                // Get SCSS variables.
                map['String', array[_scssadmin_get_200_response_value_inner]] result = apiInstance.scssadminGet();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ConfigurationApi.scssadminGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ConfigurationApi();

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ConfigurationApi->new();

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ConfigurationApi()

try:
    # Get SCSS variables.
    api_response = api_instance.scssadmin_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->scssadminGet: %s\n" % e)
extern crate ConfigurationApi;

pub fn main() {

    let mut context = ConfigurationApi::Context::default();
    let result = client.scssadminGet(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


Entities

boxBidViewModeGet

Get a box in a view mode.

The view mode should be specified in the query parameter view_mode.


/box/{bid}/{view_mode}

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/box/{bid}/{view_mode}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntitiesApi;

import java.io.File;
import java.util.*;

public class EntitiesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        EntitiesApi apiInstance = new EntitiesApi();
        Integer bid = 56; // Integer | Box ID.
        String viewMode = viewMode_example; // String | Retreive box data as it appears in the specified view mode.

        try {
            Box result = apiInstance.boxBidViewModeGet(bid, viewMode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntitiesApi#boxBidViewModeGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer bid = new Integer(); // Integer | Box ID.
final String viewMode = new String(); // String | Retreive box data as it appears in the specified view mode.

try {
    final result = await api_instance.boxBidViewModeGet(bid, viewMode);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->boxBidViewModeGet: $e\n');
}

import org.openapitools.client.api.EntitiesApi;

public class EntitiesApiExample {
    public static void main(String[] args) {
        EntitiesApi apiInstance = new EntitiesApi();
        Integer bid = 56; // Integer | Box ID.
        String viewMode = viewMode_example; // String | Retreive box data as it appears in the specified view mode.

        try {
            Box result = apiInstance.boxBidViewModeGet(bid, viewMode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntitiesApi#boxBidViewModeGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
EntitiesApi *apiInstance = [[EntitiesApi alloc] init];
Integer *bid = 56; // Box ID. (default to null)
String *viewMode = viewMode_example; // Retreive box data as it appears in the specified view mode. (default to null)

// Get a box in a view mode.
[apiInstance boxBidViewModeGetWith:bid
    viewMode:viewMode
              completionHandler: ^(Box output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.EntitiesApi()
var bid = 56; // {Integer} Box ID.
var viewMode = viewMode_example; // {String} Retreive box data as it appears in the specified view mode.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.boxBidViewModeGet(bid, viewMode, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class boxBidViewModeGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new EntitiesApi();
            var bid = 56;  // Integer | Box ID. (default to null)
            var viewMode = viewMode_example;  // String | Retreive box data as it appears in the specified view mode. (default to null)

            try {
                // Get a box in a view mode.
                Box result = apiInstance.boxBidViewModeGet(bid, viewMode);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntitiesApi.boxBidViewModeGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntitiesApi();
$bid = 56; // Integer | Box ID.
$viewMode = viewMode_example; // String | Retreive box data as it appears in the specified view mode.

try {
    $result = $api_instance->boxBidViewModeGet($bid, $viewMode);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntitiesApi->boxBidViewModeGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EntitiesApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntitiesApi->new();
my $bid = 56; # Integer | Box ID.
my $viewMode = viewMode_example; # String | Retreive box data as it appears in the specified view mode.

eval {
    my $result = $api_instance->boxBidViewModeGet(bid => $bid, viewMode => $viewMode);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntitiesApi->boxBidViewModeGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.EntitiesApi()
bid = 56 # Integer | Box ID. (default to null)
viewMode = viewMode_example # String | Retreive box data as it appears in the specified view mode. (default to null)

try:
    # Get a box in a view mode.
    api_response = api_instance.box_bid_view_mode_get(bid, viewMode)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntitiesApi->boxBidViewModeGet: %s\n" % e)
extern crate EntitiesApi;

pub fn main() {
    let bid = 56; // Integer
    let viewMode = viewMode_example; // String

    let mut context = EntitiesApi::Context::default();
    let result = client.boxBidViewModeGet(bid, viewMode, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
bid*
Integer
Box ID.
Required
view_mode*
String
Retreive box data as it appears in the specified view mode.
Required

Responses


nodeNidViewModeGet

Get a node in a view mode.

The view mode should be specified in the query parameter view_mode.


/node/{nid}/{view_mode}

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/node/{nid}/{view_mode}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntitiesApi;

import java.io.File;
import java.util.*;

public class EntitiesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        EntitiesApi apiInstance = new EntitiesApi();
        Integer nid = 56; // Integer | Node ID.
        String viewMode = viewMode_example; // String | Retreive node data as it appears in the specified view mode.

        try {
            Node-View-Mode result = apiInstance.nodeNidViewModeGet(nid, viewMode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntitiesApi#nodeNidViewModeGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer nid = new Integer(); // Integer | Node ID.
final String viewMode = new String(); // String | Retreive node data as it appears in the specified view mode.

try {
    final result = await api_instance.nodeNidViewModeGet(nid, viewMode);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->nodeNidViewModeGet: $e\n');
}

import org.openapitools.client.api.EntitiesApi;

public class EntitiesApiExample {
    public static void main(String[] args) {
        EntitiesApi apiInstance = new EntitiesApi();
        Integer nid = 56; // Integer | Node ID.
        String viewMode = viewMode_example; // String | Retreive node data as it appears in the specified view mode.

        try {
            Node-View-Mode result = apiInstance.nodeNidViewModeGet(nid, viewMode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntitiesApi#nodeNidViewModeGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
EntitiesApi *apiInstance = [[EntitiesApi alloc] init];
Integer *nid = 56; // Node ID. (default to null)
String *viewMode = viewMode_example; // Retreive node data as it appears in the specified view mode. (default to null)

// Get a node in a view mode.
[apiInstance nodeNidViewModeGetWith:nid
    viewMode:viewMode
              completionHandler: ^(Node-View-Mode output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.EntitiesApi()
var nid = 56; // {Integer} Node ID.
var viewMode = viewMode_example; // {String} Retreive node data as it appears in the specified view mode.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.nodeNidViewModeGet(nid, viewMode, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class nodeNidViewModeGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new EntitiesApi();
            var nid = 56;  // Integer | Node ID. (default to null)
            var viewMode = viewMode_example;  // String | Retreive node data as it appears in the specified view mode. (default to null)

            try {
                // Get a node in a view mode.
                Node-View-Mode result = apiInstance.nodeNidViewModeGet(nid, viewMode);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntitiesApi.nodeNidViewModeGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntitiesApi();
$nid = 56; // Integer | Node ID.
$viewMode = viewMode_example; // String | Retreive node data as it appears in the specified view mode.

try {
    $result = $api_instance->nodeNidViewModeGet($nid, $viewMode);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntitiesApi->nodeNidViewModeGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EntitiesApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntitiesApi->new();
my $nid = 56; # Integer | Node ID.
my $viewMode = viewMode_example; # String | Retreive node data as it appears in the specified view mode.

eval {
    my $result = $api_instance->nodeNidViewModeGet(nid => $nid, viewMode => $viewMode);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntitiesApi->nodeNidViewModeGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.EntitiesApi()
nid = 56 # Integer | Node ID. (default to null)
viewMode = viewMode_example # String | Retreive node data as it appears in the specified view mode. (default to null)

try:
    # Get a node in a view mode.
    api_response = api_instance.node_nid_view_mode_get(nid, viewMode)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntitiesApi->nodeNidViewModeGet: %s\n" % e)
extern crate EntitiesApi;

pub fn main() {
    let nid = 56; // Integer
    let viewMode = viewMode_example; // String

    let mut context = EntitiesApi::Context::default();
    let result = client.nodeNidViewModeGet(nid, viewMode, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
nid*
Integer
Node ID.
Required
view_mode*
String
Retreive node data as it appears in the specified view mode.
Required

Responses


piipeFlagsFlagPost

Flag/unflag an entity.

The entity (e.g. node, comment) should be marked with a flag in order to be flagged/unflagged.


/piipe_flags/flag

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://nextworkplace.staging/api/v1/piipe_flags/flag" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntitiesApi;

import java.io.File;
import java.util.*;

public class EntitiesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        EntitiesApi apiInstance = new EntitiesApi();
        PiipeFlagsFlagPostRequest piipeFlagsFlagPostRequest = ; // PiipeFlagsFlagPostRequest | 

        try {
            Flag-Status result = apiInstance.piipeFlagsFlagPost(piipeFlagsFlagPostRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntitiesApi#piipeFlagsFlagPost");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final PiipeFlagsFlagPostRequest piipeFlagsFlagPostRequest = new PiipeFlagsFlagPostRequest(); // PiipeFlagsFlagPostRequest | 

try {
    final result = await api_instance.piipeFlagsFlagPost(piipeFlagsFlagPostRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->piipeFlagsFlagPost: $e\n');
}

import org.openapitools.client.api.EntitiesApi;

public class EntitiesApiExample {
    public static void main(String[] args) {
        EntitiesApi apiInstance = new EntitiesApi();
        PiipeFlagsFlagPostRequest piipeFlagsFlagPostRequest = ; // PiipeFlagsFlagPostRequest | 

        try {
            Flag-Status result = apiInstance.piipeFlagsFlagPost(piipeFlagsFlagPostRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntitiesApi#piipeFlagsFlagPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
EntitiesApi *apiInstance = [[EntitiesApi alloc] init];
PiipeFlagsFlagPostRequest *piipeFlagsFlagPostRequest = ; // 

// Flag/unflag an entity.
[apiInstance piipeFlagsFlagPostWith:piipeFlagsFlagPostRequest
              completionHandler: ^(Flag-Status output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.EntitiesApi()
var piipeFlagsFlagPostRequest = ; // {PiipeFlagsFlagPostRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.piipeFlagsFlagPost(piipeFlagsFlagPostRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class piipeFlagsFlagPostExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new EntitiesApi();
            var piipeFlagsFlagPostRequest = new PiipeFlagsFlagPostRequest(); // PiipeFlagsFlagPostRequest | 

            try {
                // Flag/unflag an entity.
                Flag-Status result = apiInstance.piipeFlagsFlagPost(piipeFlagsFlagPostRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntitiesApi.piipeFlagsFlagPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntitiesApi();
$piipeFlagsFlagPostRequest = ; // PiipeFlagsFlagPostRequest | 

try {
    $result = $api_instance->piipeFlagsFlagPost($piipeFlagsFlagPostRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntitiesApi->piipeFlagsFlagPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EntitiesApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntitiesApi->new();
my $piipeFlagsFlagPostRequest = WWW::OPenAPIClient::Object::PiipeFlagsFlagPostRequest->new(); # PiipeFlagsFlagPostRequest | 

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.EntitiesApi()
piipeFlagsFlagPostRequest =  # PiipeFlagsFlagPostRequest | 

try:
    # Flag/unflag an entity.
    api_response = api_instance.piipe_flags_flag_post(piipeFlagsFlagPostRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntitiesApi->piipeFlagsFlagPost: %s\n" % e)
extern crate EntitiesApi;

pub fn main() {
    let piipeFlagsFlagPostRequest = ; // PiipeFlagsFlagPostRequest

    let mut context = EntitiesApi::Context::default();
    let result = client.piipeFlagsFlagPost(piipeFlagsFlagPostRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
piipeFlagsFlagPostRequest *

The flag/unflag request.

Responses


pollPatch

Vote/cancel vote in a poll.

There are two possible actions (vote/cancel a vote). The action has to be specified in the request body.


/poll

Usage and SDK Samples

curl -X PATCH \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://nextworkplace.staging/api/v1/poll" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntitiesApi;

import java.io.File;
import java.util.*;

public class EntitiesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        EntitiesApi apiInstance = new EntitiesApi();
        PollPatchRequest pollPatchRequest = ; // PollPatchRequest | 

        try {
            Poll-Block result = apiInstance.pollPatch(pollPatchRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntitiesApi#pollPatch");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final PollPatchRequest pollPatchRequest = new PollPatchRequest(); // PollPatchRequest | 

try {
    final result = await api_instance.pollPatch(pollPatchRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pollPatch: $e\n');
}

import org.openapitools.client.api.EntitiesApi;

public class EntitiesApiExample {
    public static void main(String[] args) {
        EntitiesApi apiInstance = new EntitiesApi();
        PollPatchRequest pollPatchRequest = ; // PollPatchRequest | 

        try {
            Poll-Block result = apiInstance.pollPatch(pollPatchRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntitiesApi#pollPatch");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
EntitiesApi *apiInstance = [[EntitiesApi alloc] init];
PollPatchRequest *pollPatchRequest = ; // 

// Vote/cancel vote in a poll.
[apiInstance pollPatchWith:pollPatchRequest
              completionHandler: ^(Poll-Block output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.EntitiesApi()
var pollPatchRequest = ; // {PollPatchRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pollPatch(pollPatchRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pollPatchExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new EntitiesApi();
            var pollPatchRequest = new PollPatchRequest(); // PollPatchRequest | 

            try {
                // Vote/cancel vote in a poll.
                Poll-Block result = apiInstance.pollPatch(pollPatchRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntitiesApi.pollPatch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntitiesApi();
$pollPatchRequest = ; // PollPatchRequest | 

try {
    $result = $api_instance->pollPatch($pollPatchRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntitiesApi->pollPatch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EntitiesApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntitiesApi->new();
my $pollPatchRequest = WWW::OPenAPIClient::Object::PollPatchRequest->new(); # PollPatchRequest | 

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.EntitiesApi()
pollPatchRequest =  # PollPatchRequest | 

try:
    # Vote/cancel vote in a poll.
    api_response = api_instance.poll_patch(pollPatchRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntitiesApi->pollPatch: %s\n" % e)
extern crate EntitiesApi;

pub fn main() {
    let pollPatchRequest = ; // PollPatchRequest

    let mut context = EntitiesApi::Context::default();
    let result = client.pollPatch(pollPatchRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
pollPatchRequest *

Perform action on poll

Responses


socialIconsNidGet

Get a node's social icons.


/social_icons/{nid}

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/social_icons/{nid}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntitiesApi;

import java.io.File;
import java.util.*;

public class EntitiesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        EntitiesApi apiInstance = new EntitiesApi();
        Integer nid = 56; // Integer | Node ID.

        try {
            Social-Icons result = apiInstance.socialIconsNidGet(nid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntitiesApi#socialIconsNidGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer nid = new Integer(); // Integer | Node ID.

try {
    final result = await api_instance.socialIconsNidGet(nid);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->socialIconsNidGet: $e\n');
}

import org.openapitools.client.api.EntitiesApi;

public class EntitiesApiExample {
    public static void main(String[] args) {
        EntitiesApi apiInstance = new EntitiesApi();
        Integer nid = 56; // Integer | Node ID.

        try {
            Social-Icons result = apiInstance.socialIconsNidGet(nid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntitiesApi#socialIconsNidGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
EntitiesApi *apiInstance = [[EntitiesApi alloc] init];
Integer *nid = 56; // Node ID. (default to null)

// Get a node's social icons.
[apiInstance socialIconsNidGetWith:nid
              completionHandler: ^(Social-Icons output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.EntitiesApi()
var nid = 56; // {Integer} Node ID.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.socialIconsNidGet(nid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class socialIconsNidGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new EntitiesApi();
            var nid = 56;  // Integer | Node ID. (default to null)

            try {
                // Get a node's social icons.
                Social-Icons result = apiInstance.socialIconsNidGet(nid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntitiesApi.socialIconsNidGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntitiesApi();
$nid = 56; // Integer | Node ID.

try {
    $result = $api_instance->socialIconsNidGet($nid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntitiesApi->socialIconsNidGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EntitiesApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntitiesApi->new();
my $nid = 56; # Integer | Node ID.

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.EntitiesApi()
nid = 56 # Integer | Node ID. (default to null)

try:
    # Get a node's social icons.
    api_response = api_instance.social_icons_nid_get(nid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntitiesApi->socialIconsNidGet: %s\n" % e)
extern crate EntitiesApi;

pub fn main() {
    let nid = 56; // Integer

    let mut context = EntitiesApi::Context::default();
    let result = client.socialIconsNidGet(nid, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
nid*
Integer
Node ID.
Required

Responses


FrontpageMagazine

frontpageGet

Returns the current list of frontpage sections.

Each section includes a list of components and their configuration.


/frontpage

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/frontpage"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FrontpageMagazineApi;

import java.io.File;
import java.util.*;

public class FrontpageMagazineApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        FrontpageMagazineApi apiInstance = new FrontpageMagazineApi();

        try {
            array[Section] result = apiInstance.frontpageGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontpageMagazineApi#frontpageGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.frontpageGet();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->frontpageGet: $e\n');
}

import org.openapitools.client.api.FrontpageMagazineApi;

public class FrontpageMagazineApiExample {
    public static void main(String[] args) {
        FrontpageMagazineApi apiInstance = new FrontpageMagazineApi();

        try {
            array[Section] result = apiInstance.frontpageGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontpageMagazineApi#frontpageGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
FrontpageMagazineApi *apiInstance = [[FrontpageMagazineApi alloc] init];

// Returns the current list of frontpage sections.
[apiInstance frontpageGetWithCompletionHandler: 
              ^(array[Section] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.FrontpageMagazineApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.frontpageGet(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class frontpageGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FrontpageMagazineApi();

            try {
                // Returns the current list of frontpage sections.
                array[Section] result = apiInstance.frontpageGet();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FrontpageMagazineApi.frontpageGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FrontpageMagazineApi();

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FrontpageMagazineApi->new();

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FrontpageMagazineApi()

try:
    # Returns the current list of frontpage sections.
    api_response = api_instance.frontpage_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FrontpageMagazineApi->frontpageGet: %s\n" % e)
extern crate FrontpageMagazineApi;

pub fn main() {

    let mut context = FrontpageMagazineApi::Context::default();
    let result = client.frontpageGet(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


frontpageUuidGet

Returns the frontpage component referenced by uuid.

Each frontpage component has a distinct structure and is identified throgh a unique id.


/frontpage/{uuid}

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/frontpage/{uuid}?field_magazine_channel=fieldMagazineChannel_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FrontpageMagazineApi;

import java.io.File;
import java.util.*;

public class FrontpageMagazineApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        FrontpageMagazineApi apiInstance = new FrontpageMagazineApi();
        String uuid = uuid_example; // String | uuid of frontpage component to return.
        String fieldMagazineChannel = fieldMagazineChannel_example; // String | Filter results by magazine channel. Pass a facet item_id from the `sub_facets` of a `magazine_category_filter_box` component to restrict `search_results` to that channel.

        try {
            Concrete-Component result = apiInstance.frontpageUuidGet(uuid, fieldMagazineChannel);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontpageMagazineApi#frontpageUuidGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String uuid = new String(); // String | uuid of frontpage component to return.
final String fieldMagazineChannel = new String(); // String | Filter results by magazine channel. Pass a facet item_id from the `sub_facets` of a `magazine_category_filter_box` component to restrict `search_results` to that channel.

try {
    final result = await api_instance.frontpageUuidGet(uuid, fieldMagazineChannel);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->frontpageUuidGet: $e\n');
}

import org.openapitools.client.api.FrontpageMagazineApi;

public class FrontpageMagazineApiExample {
    public static void main(String[] args) {
        FrontpageMagazineApi apiInstance = new FrontpageMagazineApi();
        String uuid = uuid_example; // String | uuid of frontpage component to return.
        String fieldMagazineChannel = fieldMagazineChannel_example; // String | Filter results by magazine channel. Pass a facet item_id from the `sub_facets` of a `magazine_category_filter_box` component to restrict `search_results` to that channel.

        try {
            Concrete-Component result = apiInstance.frontpageUuidGet(uuid, fieldMagazineChannel);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontpageMagazineApi#frontpageUuidGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
FrontpageMagazineApi *apiInstance = [[FrontpageMagazineApi alloc] init];
String *uuid = uuid_example; // uuid of frontpage component to return. (default to null)
String *fieldMagazineChannel = fieldMagazineChannel_example; // Filter results by magazine channel. Pass a facet item_id from the `sub_facets` of a `magazine_category_filter_box` component to restrict `search_results` to that channel. (optional) (default to null)

// Returns the frontpage component referenced by uuid.
[apiInstance frontpageUuidGetWith:uuid
    fieldMagazineChannel:fieldMagazineChannel
              completionHandler: ^(Concrete-Component output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.FrontpageMagazineApi()
var uuid = uuid_example; // {String} uuid of frontpage component to return.
var opts = {
  'fieldMagazineChannel': fieldMagazineChannel_example // {String} Filter results by magazine channel. Pass a facet item_id from the `sub_facets` of a `magazine_category_filter_box` component to restrict `search_results` to that channel.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.frontpageUuidGet(uuid, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class frontpageUuidGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FrontpageMagazineApi();
            var uuid = uuid_example;  // String | uuid of frontpage component to return. (default to null)
            var fieldMagazineChannel = fieldMagazineChannel_example;  // String | Filter results by magazine channel. Pass a facet item_id from the `sub_facets` of a `magazine_category_filter_box` component to restrict `search_results` to that channel. (optional)  (default to null)

            try {
                // Returns the frontpage component referenced by uuid.
                Concrete-Component result = apiInstance.frontpageUuidGet(uuid, fieldMagazineChannel);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FrontpageMagazineApi.frontpageUuidGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FrontpageMagazineApi();
$uuid = uuid_example; // String | uuid of frontpage component to return.
$fieldMagazineChannel = fieldMagazineChannel_example; // String | Filter results by magazine channel. Pass a facet item_id from the `sub_facets` of a `magazine_category_filter_box` component to restrict `search_results` to that channel.

try {
    $result = $api_instance->frontpageUuidGet($uuid, $fieldMagazineChannel);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FrontpageMagazineApi->frontpageUuidGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FrontpageMagazineApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FrontpageMagazineApi->new();
my $uuid = uuid_example; # String | uuid of frontpage component to return.
my $fieldMagazineChannel = fieldMagazineChannel_example; # String | Filter results by magazine channel. Pass a facet item_id from the `sub_facets` of a `magazine_category_filter_box` component to restrict `search_results` to that channel.

eval {
    my $result = $api_instance->frontpageUuidGet(uuid => $uuid, fieldMagazineChannel => $fieldMagazineChannel);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FrontpageMagazineApi->frontpageUuidGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FrontpageMagazineApi()
uuid = uuid_example # String | uuid of frontpage component to return. (default to null)
fieldMagazineChannel = fieldMagazineChannel_example # String | Filter results by magazine channel. Pass a facet item_id from the `sub_facets` of a `magazine_category_filter_box` component to restrict `search_results` to that channel. (optional) (default to null)

try:
    # Returns the frontpage component referenced by uuid.
    api_response = api_instance.frontpage_uuid_get(uuid, fieldMagazineChannel=fieldMagazineChannel)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FrontpageMagazineApi->frontpageUuidGet: %s\n" % e)
extern crate FrontpageMagazineApi;

pub fn main() {
    let uuid = uuid_example; // String
    let fieldMagazineChannel = fieldMagazineChannel_example; // String

    let mut context = FrontpageMagazineApi::Context::default();
    let result = client.frontpageUuidGet(uuid, fieldMagazineChannel, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
uuid*
String
uuid of frontpage component to return.
Required
Query parameters
Name Description
field_magazine_channel
String
Filter results by magazine channel. Pass a facet item_id from the `sub_facets` of a `magazine_category_filter_box` component to restrict `search_results` to that channel.

Responses


magazineGet

Returns the current list of magazine sections.

Each section includes a list of components and their configuration.


/magazine

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/magazine"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FrontpageMagazineApi;

import java.io.File;
import java.util.*;

public class FrontpageMagazineApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        FrontpageMagazineApi apiInstance = new FrontpageMagazineApi();

        try {
            array[Section] result = apiInstance.magazineGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontpageMagazineApi#magazineGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.magazineGet();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->magazineGet: $e\n');
}

import org.openapitools.client.api.FrontpageMagazineApi;

public class FrontpageMagazineApiExample {
    public static void main(String[] args) {
        FrontpageMagazineApi apiInstance = new FrontpageMagazineApi();

        try {
            array[Section] result = apiInstance.magazineGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontpageMagazineApi#magazineGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
FrontpageMagazineApi *apiInstance = [[FrontpageMagazineApi alloc] init];

// Returns the current list of magazine sections.
[apiInstance magazineGetWithCompletionHandler: 
              ^(array[Section] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.FrontpageMagazineApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.magazineGet(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class magazineGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FrontpageMagazineApi();

            try {
                // Returns the current list of magazine sections.
                array[Section] result = apiInstance.magazineGet();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FrontpageMagazineApi.magazineGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FrontpageMagazineApi();

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FrontpageMagazineApi->new();

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FrontpageMagazineApi()

try:
    # Returns the current list of magazine sections.
    api_response = api_instance.magazine_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FrontpageMagazineApi->magazineGet: %s\n" % e)
extern crate FrontpageMagazineApi;

pub fn main() {

    let mut context = FrontpageMagazineApi::Context::default();
    let result = client.magazineGet(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


magazineUuidGet

Returns the magazine component referenced by uuid.

Each magazine component has a distinct structure and is identified throgh a unique id.


/magazine/{uuid}

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/magazine/{uuid}?field_magazine_channel=fieldMagazineChannel_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FrontpageMagazineApi;

import java.io.File;
import java.util.*;

public class FrontpageMagazineApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        FrontpageMagazineApi apiInstance = new FrontpageMagazineApi();
        String uuid = uuid_example; // String | uuid of magazine component to return.
        String fieldMagazineChannel = fieldMagazineChannel_example; // String | Filter results by magazine channel. Pass a facet item_id from the `sub_facets` of a `magazine_category_filter_box` component to restrict `search_results` to that channel.

        try {
            Concrete-Component result = apiInstance.magazineUuidGet(uuid, fieldMagazineChannel);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontpageMagazineApi#magazineUuidGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String uuid = new String(); // String | uuid of magazine component to return.
final String fieldMagazineChannel = new String(); // String | Filter results by magazine channel. Pass a facet item_id from the `sub_facets` of a `magazine_category_filter_box` component to restrict `search_results` to that channel.

try {
    final result = await api_instance.magazineUuidGet(uuid, fieldMagazineChannel);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->magazineUuidGet: $e\n');
}

import org.openapitools.client.api.FrontpageMagazineApi;

public class FrontpageMagazineApiExample {
    public static void main(String[] args) {
        FrontpageMagazineApi apiInstance = new FrontpageMagazineApi();
        String uuid = uuid_example; // String | uuid of magazine component to return.
        String fieldMagazineChannel = fieldMagazineChannel_example; // String | Filter results by magazine channel. Pass a facet item_id from the `sub_facets` of a `magazine_category_filter_box` component to restrict `search_results` to that channel.

        try {
            Concrete-Component result = apiInstance.magazineUuidGet(uuid, fieldMagazineChannel);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrontpageMagazineApi#magazineUuidGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
FrontpageMagazineApi *apiInstance = [[FrontpageMagazineApi alloc] init];
String *uuid = uuid_example; // uuid of magazine component to return. (default to null)
String *fieldMagazineChannel = fieldMagazineChannel_example; // Filter results by magazine channel. Pass a facet item_id from the `sub_facets` of a `magazine_category_filter_box` component to restrict `search_results` to that channel. (optional) (default to null)

// Returns the magazine component referenced by uuid.
[apiInstance magazineUuidGetWith:uuid
    fieldMagazineChannel:fieldMagazineChannel
              completionHandler: ^(Concrete-Component output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.FrontpageMagazineApi()
var uuid = uuid_example; // {String} uuid of magazine component to return.
var opts = {
  'fieldMagazineChannel': fieldMagazineChannel_example // {String} Filter results by magazine channel. Pass a facet item_id from the `sub_facets` of a `magazine_category_filter_box` component to restrict `search_results` to that channel.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.magazineUuidGet(uuid, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class magazineUuidGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FrontpageMagazineApi();
            var uuid = uuid_example;  // String | uuid of magazine component to return. (default to null)
            var fieldMagazineChannel = fieldMagazineChannel_example;  // String | Filter results by magazine channel. Pass a facet item_id from the `sub_facets` of a `magazine_category_filter_box` component to restrict `search_results` to that channel. (optional)  (default to null)

            try {
                // Returns the magazine component referenced by uuid.
                Concrete-Component result = apiInstance.magazineUuidGet(uuid, fieldMagazineChannel);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FrontpageMagazineApi.magazineUuidGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FrontpageMagazineApi();
$uuid = uuid_example; // String | uuid of magazine component to return.
$fieldMagazineChannel = fieldMagazineChannel_example; // String | Filter results by magazine channel. Pass a facet item_id from the `sub_facets` of a `magazine_category_filter_box` component to restrict `search_results` to that channel.

try {
    $result = $api_instance->magazineUuidGet($uuid, $fieldMagazineChannel);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FrontpageMagazineApi->magazineUuidGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FrontpageMagazineApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FrontpageMagazineApi->new();
my $uuid = uuid_example; # String | uuid of magazine component to return.
my $fieldMagazineChannel = fieldMagazineChannel_example; # String | Filter results by magazine channel. Pass a facet item_id from the `sub_facets` of a `magazine_category_filter_box` component to restrict `search_results` to that channel.

eval {
    my $result = $api_instance->magazineUuidGet(uuid => $uuid, fieldMagazineChannel => $fieldMagazineChannel);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FrontpageMagazineApi->magazineUuidGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FrontpageMagazineApi()
uuid = uuid_example # String | uuid of magazine component to return. (default to null)
fieldMagazineChannel = fieldMagazineChannel_example # String | Filter results by magazine channel. Pass a facet item_id from the `sub_facets` of a `magazine_category_filter_box` component to restrict `search_results` to that channel. (optional) (default to null)

try:
    # Returns the magazine component referenced by uuid.
    api_response = api_instance.magazine_uuid_get(uuid, fieldMagazineChannel=fieldMagazineChannel)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FrontpageMagazineApi->magazineUuidGet: %s\n" % e)
extern crate FrontpageMagazineApi;

pub fn main() {
    let uuid = uuid_example; // String
    let fieldMagazineChannel = fieldMagazineChannel_example; // String

    let mut context = FrontpageMagazineApi::Context::default();
    let result = client.magazineUuidGet(uuid, fieldMagazineChannel, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
uuid*
String
uuid of magazine component to return.
Required
Query parameters
Name Description
field_magazine_channel
String
Filter results by magazine channel. Pass a facet item_id from the `sub_facets` of a `magazine_category_filter_box` component to restrict `search_results` to that channel.

Responses


Navigation

menuMenuNameGet

Get menu items.

The following menus can be accessed by authenticated users&#58; [Main navigation, News Tab Menu, User account menu, Footer].


/menu/{menu_name}

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/menu/{menu_name}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NavigationApi;

import java.io.File;
import java.util.*;

public class NavigationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        NavigationApi apiInstance = new NavigationApi();
        String menuName = main; // String | Menu name.

        try {
            array[Menu-Link] result = apiInstance.menuMenuNameGet(menuName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NavigationApi#menuMenuNameGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String menuName = new String(); // String | Menu name.

try {
    final result = await api_instance.menuMenuNameGet(menuName);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->menuMenuNameGet: $e\n');
}

import org.openapitools.client.api.NavigationApi;

public class NavigationApiExample {
    public static void main(String[] args) {
        NavigationApi apiInstance = new NavigationApi();
        String menuName = main; // String | Menu name.

        try {
            array[Menu-Link] result = apiInstance.menuMenuNameGet(menuName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NavigationApi#menuMenuNameGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
NavigationApi *apiInstance = [[NavigationApi alloc] init];
String *menuName = main; // Menu name. (default to null)

// Get menu items.
[apiInstance menuMenuNameGetWith:menuName
              completionHandler: ^(array[Menu-Link] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.NavigationApi()
var menuName = main; // {String} Menu name.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.menuMenuNameGet(menuName, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class menuMenuNameGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new NavigationApi();
            var menuName = main;  // String | Menu name. (default to null)

            try {
                // Get menu items.
                array[Menu-Link] result = apiInstance.menuMenuNameGet(menuName);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling NavigationApi.menuMenuNameGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NavigationApi();
$menuName = main; // String | Menu name.

try {
    $result = $api_instance->menuMenuNameGet($menuName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NavigationApi->menuMenuNameGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NavigationApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::NavigationApi->new();
my $menuName = main; # String | Menu name.

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.NavigationApi()
menuName = main # String | Menu name. (default to null)

try:
    # Get menu items.
    api_response = api_instance.menu_menu_name_get(menuName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NavigationApi->menuMenuNameGet: %s\n" % e)
extern crate NavigationApi;

pub fn main() {
    let menuName = main; // String

    let mut context = NavigationApi::Context::default();
    let result = client.menuMenuNameGet(menuName, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
menu_name*
String
Menu name.
Required

Responses


piipeToolbarConfigGet

Get default toolbar items.

Use the toolbar items from this endpoint. The set of items can be extended by defining custom items (endpoint "/piipe_toolbar/custom_objects"), and their settings can be overridden (endpoint "/piipe_toolbar/settings").


/piipe_toolbar/config

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/piipe_toolbar/config"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NavigationApi;

import java.io.File;
import java.util.*;

public class NavigationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        NavigationApi apiInstance = new NavigationApi();

        try {
            map['String', Toolbar_Default_Items_value] result = apiInstance.piipeToolbarConfigGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NavigationApi#piipeToolbarConfigGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.piipeToolbarConfigGet();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->piipeToolbarConfigGet: $e\n');
}

import org.openapitools.client.api.NavigationApi;

public class NavigationApiExample {
    public static void main(String[] args) {
        NavigationApi apiInstance = new NavigationApi();

        try {
            map['String', Toolbar_Default_Items_value] result = apiInstance.piipeToolbarConfigGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NavigationApi#piipeToolbarConfigGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
NavigationApi *apiInstance = [[NavigationApi alloc] init];

// Get default toolbar items.
[apiInstance piipeToolbarConfigGetWithCompletionHandler: 
              ^(map['String', Toolbar_Default_Items_value] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.NavigationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.piipeToolbarConfigGet(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class piipeToolbarConfigGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new NavigationApi();

            try {
                // Get default toolbar items.
                map['String', Toolbar_Default_Items_value] result = apiInstance.piipeToolbarConfigGet();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling NavigationApi.piipeToolbarConfigGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NavigationApi();

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::NavigationApi->new();

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.NavigationApi()

try:
    # Get default toolbar items.
    api_response = api_instance.piipe_toolbar_config_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NavigationApi->piipeToolbarConfigGet: %s\n" % e)
extern crate NavigationApi;

pub fn main() {

    let mut context = NavigationApi::Context::default();
    let result = client.piipeToolbarConfigGet(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


piipeToolbarCustomObjectsGet

Get custom toolbar items.

Users can define their own toolbar items to extend the set of default toolbar items (endpoint "/piipe_toolbar/config"). For example, the user can add a new link inside an existing section.


/piipe_toolbar/custom_objects

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/piipe_toolbar/custom_objects"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NavigationApi;

import java.io.File;
import java.util.*;

public class NavigationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        NavigationApi apiInstance = new NavigationApi();

        try {
            map['String', Toolbar-Custom-Item] result = apiInstance.piipeToolbarCustomObjectsGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NavigationApi#piipeToolbarCustomObjectsGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.piipeToolbarCustomObjectsGet();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->piipeToolbarCustomObjectsGet: $e\n');
}

import org.openapitools.client.api.NavigationApi;

public class NavigationApiExample {
    public static void main(String[] args) {
        NavigationApi apiInstance = new NavigationApi();

        try {
            map['String', Toolbar-Custom-Item] result = apiInstance.piipeToolbarCustomObjectsGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NavigationApi#piipeToolbarCustomObjectsGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
NavigationApi *apiInstance = [[NavigationApi alloc] init];

// Get custom toolbar items.
[apiInstance piipeToolbarCustomObjectsGetWithCompletionHandler: 
              ^(map['String', Toolbar-Custom-Item] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.NavigationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.piipeToolbarCustomObjectsGet(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class piipeToolbarCustomObjectsGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new NavigationApi();

            try {
                // Get custom toolbar items.
                map['String', Toolbar-Custom-Item] result = apiInstance.piipeToolbarCustomObjectsGet();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling NavigationApi.piipeToolbarCustomObjectsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NavigationApi();

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::NavigationApi->new();

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.NavigationApi()

try:
    # Get custom toolbar items.
    api_response = api_instance.piipe_toolbar_custom_objects_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NavigationApi->piipeToolbarCustomObjectsGet: %s\n" % e)
extern crate NavigationApi;

pub fn main() {

    let mut context = NavigationApi::Context::default();
    let result = client.piipeToolbarCustomObjectsGet(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


piipeToolbarCustomObjectsPatch

Manage custom toolbar item.

Update/delete custom toolbar items defined by the user. If a deletion action is to be performed on a folder toolbar item, then this will have the effect of deleting all toolbar items included in that folder.


/piipe_toolbar/custom_objects

Usage and SDK Samples

curl -X PATCH \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://nextworkplace.staging/api/v1/piipe_toolbar/custom_objects" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NavigationApi;

import java.io.File;
import java.util.*;

public class NavigationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        NavigationApi apiInstance = new NavigationApi();
        PiipeToolbarCustomObjectsPatchRequest piipeToolbarCustomObjectsPatchRequest = ; // PiipeToolbarCustomObjectsPatchRequest | 

        try {
            apiInstance.piipeToolbarCustomObjectsPatch(piipeToolbarCustomObjectsPatchRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling NavigationApi#piipeToolbarCustomObjectsPatch");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final PiipeToolbarCustomObjectsPatchRequest piipeToolbarCustomObjectsPatchRequest = new PiipeToolbarCustomObjectsPatchRequest(); // PiipeToolbarCustomObjectsPatchRequest | 

try {
    final result = await api_instance.piipeToolbarCustomObjectsPatch(piipeToolbarCustomObjectsPatchRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->piipeToolbarCustomObjectsPatch: $e\n');
}

import org.openapitools.client.api.NavigationApi;

public class NavigationApiExample {
    public static void main(String[] args) {
        NavigationApi apiInstance = new NavigationApi();
        PiipeToolbarCustomObjectsPatchRequest piipeToolbarCustomObjectsPatchRequest = ; // PiipeToolbarCustomObjectsPatchRequest | 

        try {
            apiInstance.piipeToolbarCustomObjectsPatch(piipeToolbarCustomObjectsPatchRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling NavigationApi#piipeToolbarCustomObjectsPatch");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
NavigationApi *apiInstance = [[NavigationApi alloc] init];
PiipeToolbarCustomObjectsPatchRequest *piipeToolbarCustomObjectsPatchRequest = ; // 

// Manage custom toolbar item.
[apiInstance piipeToolbarCustomObjectsPatchWith:piipeToolbarCustomObjectsPatchRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.NavigationApi()
var piipeToolbarCustomObjectsPatchRequest = ; // {PiipeToolbarCustomObjectsPatchRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.piipeToolbarCustomObjectsPatch(piipeToolbarCustomObjectsPatchRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class piipeToolbarCustomObjectsPatchExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new NavigationApi();
            var piipeToolbarCustomObjectsPatchRequest = new PiipeToolbarCustomObjectsPatchRequest(); // PiipeToolbarCustomObjectsPatchRequest | 

            try {
                // Manage custom toolbar item.
                apiInstance.piipeToolbarCustomObjectsPatch(piipeToolbarCustomObjectsPatchRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling NavigationApi.piipeToolbarCustomObjectsPatch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NavigationApi();
$piipeToolbarCustomObjectsPatchRequest = ; // PiipeToolbarCustomObjectsPatchRequest | 

try {
    $api_instance->piipeToolbarCustomObjectsPatch($piipeToolbarCustomObjectsPatchRequest);
} catch (Exception $e) {
    echo 'Exception when calling NavigationApi->piipeToolbarCustomObjectsPatch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NavigationApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::NavigationApi->new();
my $piipeToolbarCustomObjectsPatchRequest = WWW::OPenAPIClient::Object::PiipeToolbarCustomObjectsPatchRequest->new(); # PiipeToolbarCustomObjectsPatchRequest | 

eval {
    $api_instance->piipeToolbarCustomObjectsPatch(piipeToolbarCustomObjectsPatchRequest => $piipeToolbarCustomObjectsPatchRequest);
};
if ($@) {
    warn "Exception when calling NavigationApi->piipeToolbarCustomObjectsPatch: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.NavigationApi()
piipeToolbarCustomObjectsPatchRequest =  # PiipeToolbarCustomObjectsPatchRequest | 

try:
    # Manage custom toolbar item.
    api_instance.piipe_toolbar_custom_objects_patch(piipeToolbarCustomObjectsPatchRequest)
except ApiException as e:
    print("Exception when calling NavigationApi->piipeToolbarCustomObjectsPatch: %s\n" % e)
extern crate NavigationApi;

pub fn main() {
    let piipeToolbarCustomObjectsPatchRequest = ; // PiipeToolbarCustomObjectsPatchRequest

    let mut context = NavigationApi::Context::default();
    let result = client.piipeToolbarCustomObjectsPatch(piipeToolbarCustomObjectsPatchRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
piipeToolbarCustomObjectsPatchRequest *

List of custom toolbar items to manage.

Responses


piipeToolbarCustomObjectsPost

Create custom toolbar item.

Lets the user create a custom toolbar item.


/piipe_toolbar/custom_objects

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://nextworkplace.staging/api/v1/piipe_toolbar/custom_objects" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NavigationApi;

import java.io.File;
import java.util.*;

public class NavigationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        NavigationApi apiInstance = new NavigationApi();
        PiipeToolbarCustomObjectsPostRequest piipeToolbarCustomObjectsPostRequest = ; // PiipeToolbarCustomObjectsPostRequest | 

        try {
            apiInstance.piipeToolbarCustomObjectsPost(piipeToolbarCustomObjectsPostRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling NavigationApi#piipeToolbarCustomObjectsPost");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final PiipeToolbarCustomObjectsPostRequest piipeToolbarCustomObjectsPostRequest = new PiipeToolbarCustomObjectsPostRequest(); // PiipeToolbarCustomObjectsPostRequest | 

try {
    final result = await api_instance.piipeToolbarCustomObjectsPost(piipeToolbarCustomObjectsPostRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->piipeToolbarCustomObjectsPost: $e\n');
}

import org.openapitools.client.api.NavigationApi;

public class NavigationApiExample {
    public static void main(String[] args) {
        NavigationApi apiInstance = new NavigationApi();
        PiipeToolbarCustomObjectsPostRequest piipeToolbarCustomObjectsPostRequest = ; // PiipeToolbarCustomObjectsPostRequest | 

        try {
            apiInstance.piipeToolbarCustomObjectsPost(piipeToolbarCustomObjectsPostRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling NavigationApi#piipeToolbarCustomObjectsPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
NavigationApi *apiInstance = [[NavigationApi alloc] init];
PiipeToolbarCustomObjectsPostRequest *piipeToolbarCustomObjectsPostRequest = ; //  (optional)

// Create custom toolbar item.
[apiInstance piipeToolbarCustomObjectsPostWith:piipeToolbarCustomObjectsPostRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.NavigationApi()
var opts = {
  'piipeToolbarCustomObjectsPostRequest':  // {PiipeToolbarCustomObjectsPostRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.piipeToolbarCustomObjectsPost(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class piipeToolbarCustomObjectsPostExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new NavigationApi();
            var piipeToolbarCustomObjectsPostRequest = new PiipeToolbarCustomObjectsPostRequest(); // PiipeToolbarCustomObjectsPostRequest |  (optional) 

            try {
                // Create custom toolbar item.
                apiInstance.piipeToolbarCustomObjectsPost(piipeToolbarCustomObjectsPostRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling NavigationApi.piipeToolbarCustomObjectsPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NavigationApi();
$piipeToolbarCustomObjectsPostRequest = ; // PiipeToolbarCustomObjectsPostRequest | 

try {
    $api_instance->piipeToolbarCustomObjectsPost($piipeToolbarCustomObjectsPostRequest);
} catch (Exception $e) {
    echo 'Exception when calling NavigationApi->piipeToolbarCustomObjectsPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NavigationApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::NavigationApi->new();
my $piipeToolbarCustomObjectsPostRequest = WWW::OPenAPIClient::Object::PiipeToolbarCustomObjectsPostRequest->new(); # PiipeToolbarCustomObjectsPostRequest | 

eval {
    $api_instance->piipeToolbarCustomObjectsPost(piipeToolbarCustomObjectsPostRequest => $piipeToolbarCustomObjectsPostRequest);
};
if ($@) {
    warn "Exception when calling NavigationApi->piipeToolbarCustomObjectsPost: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.NavigationApi()
piipeToolbarCustomObjectsPostRequest =  # PiipeToolbarCustomObjectsPostRequest |  (optional)

try:
    # Create custom toolbar item.
    api_instance.piipe_toolbar_custom_objects_post(piipeToolbarCustomObjectsPostRequest=piipeToolbarCustomObjectsPostRequest)
except ApiException as e:
    print("Exception when calling NavigationApi->piipeToolbarCustomObjectsPost: %s\n" % e)
extern crate NavigationApi;

pub fn main() {
    let piipeToolbarCustomObjectsPostRequest = ; // PiipeToolbarCustomObjectsPostRequest

    let mut context = NavigationApi::Context::default();
    let result = client.piipeToolbarCustomObjectsPost(piipeToolbarCustomObjectsPostRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
piipeToolbarCustomObjectsPostRequest

A new custom toolbar item.

Responses


piipeToolbarSettingsGet

Get toolbar items settings overrides.

Users can override the default settings of default toolbar items (endpoint "/piipe_toolbar/config"). For example, the user can hide a hidable default link, or change the default source and target languages in a dictionary.


/piipe_toolbar/settings

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/piipe_toolbar/settings"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NavigationApi;

import java.io.File;
import java.util.*;

public class NavigationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        NavigationApi apiInstance = new NavigationApi();

        try {
            map['String', Toolbar-Settings-Object] result = apiInstance.piipeToolbarSettingsGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NavigationApi#piipeToolbarSettingsGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.piipeToolbarSettingsGet();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->piipeToolbarSettingsGet: $e\n');
}

import org.openapitools.client.api.NavigationApi;

public class NavigationApiExample {
    public static void main(String[] args) {
        NavigationApi apiInstance = new NavigationApi();

        try {
            map['String', Toolbar-Settings-Object] result = apiInstance.piipeToolbarSettingsGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NavigationApi#piipeToolbarSettingsGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
NavigationApi *apiInstance = [[NavigationApi alloc] init];

// Get toolbar items settings overrides.
[apiInstance piipeToolbarSettingsGetWithCompletionHandler: 
              ^(map['String', Toolbar-Settings-Object] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.NavigationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.piipeToolbarSettingsGet(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class piipeToolbarSettingsGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new NavigationApi();

            try {
                // Get toolbar items settings overrides.
                map['String', Toolbar-Settings-Object] result = apiInstance.piipeToolbarSettingsGet();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling NavigationApi.piipeToolbarSettingsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NavigationApi();

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::NavigationApi->new();

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.NavigationApi()

try:
    # Get toolbar items settings overrides.
    api_response = api_instance.piipe_toolbar_settings_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NavigationApi->piipeToolbarSettingsGet: %s\n" % e)
extern crate NavigationApi;

pub fn main() {

    let mut context = NavigationApi::Context::default();
    let result = client.piipeToolbarSettingsGet(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


piipeToolbarSettingsPatch

Manage toolbar item settings.

Lets the user update/delete toolbar item settings.


/piipe_toolbar/settings

Usage and SDK Samples

curl -X PATCH \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://nextworkplace.staging/api/v1/piipe_toolbar/settings" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NavigationApi;

import java.io.File;
import java.util.*;

public class NavigationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        NavigationApi apiInstance = new NavigationApi();
        PiipeToolbarSettingsPatchRequest piipeToolbarSettingsPatchRequest = ; // PiipeToolbarSettingsPatchRequest | 

        try {
            apiInstance.piipeToolbarSettingsPatch(piipeToolbarSettingsPatchRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling NavigationApi#piipeToolbarSettingsPatch");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final PiipeToolbarSettingsPatchRequest piipeToolbarSettingsPatchRequest = new PiipeToolbarSettingsPatchRequest(); // PiipeToolbarSettingsPatchRequest | 

try {
    final result = await api_instance.piipeToolbarSettingsPatch(piipeToolbarSettingsPatchRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->piipeToolbarSettingsPatch: $e\n');
}

import org.openapitools.client.api.NavigationApi;

public class NavigationApiExample {
    public static void main(String[] args) {
        NavigationApi apiInstance = new NavigationApi();
        PiipeToolbarSettingsPatchRequest piipeToolbarSettingsPatchRequest = ; // PiipeToolbarSettingsPatchRequest | 

        try {
            apiInstance.piipeToolbarSettingsPatch(piipeToolbarSettingsPatchRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling NavigationApi#piipeToolbarSettingsPatch");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
NavigationApi *apiInstance = [[NavigationApi alloc] init];
PiipeToolbarSettingsPatchRequest *piipeToolbarSettingsPatchRequest = ; //  (optional)

// Manage toolbar item settings.
[apiInstance piipeToolbarSettingsPatchWith:piipeToolbarSettingsPatchRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.NavigationApi()
var opts = {
  'piipeToolbarSettingsPatchRequest':  // {PiipeToolbarSettingsPatchRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.piipeToolbarSettingsPatch(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class piipeToolbarSettingsPatchExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new NavigationApi();
            var piipeToolbarSettingsPatchRequest = new PiipeToolbarSettingsPatchRequest(); // PiipeToolbarSettingsPatchRequest |  (optional) 

            try {
                // Manage toolbar item settings.
                apiInstance.piipeToolbarSettingsPatch(piipeToolbarSettingsPatchRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling NavigationApi.piipeToolbarSettingsPatch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NavigationApi();
$piipeToolbarSettingsPatchRequest = ; // PiipeToolbarSettingsPatchRequest | 

try {
    $api_instance->piipeToolbarSettingsPatch($piipeToolbarSettingsPatchRequest);
} catch (Exception $e) {
    echo 'Exception when calling NavigationApi->piipeToolbarSettingsPatch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NavigationApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::NavigationApi->new();
my $piipeToolbarSettingsPatchRequest = WWW::OPenAPIClient::Object::PiipeToolbarSettingsPatchRequest->new(); # PiipeToolbarSettingsPatchRequest | 

eval {
    $api_instance->piipeToolbarSettingsPatch(piipeToolbarSettingsPatchRequest => $piipeToolbarSettingsPatchRequest);
};
if ($@) {
    warn "Exception when calling NavigationApi->piipeToolbarSettingsPatch: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.NavigationApi()
piipeToolbarSettingsPatchRequest =  # PiipeToolbarSettingsPatchRequest |  (optional)

try:
    # Manage toolbar item settings.
    api_instance.piipe_toolbar_settings_patch(piipeToolbarSettingsPatchRequest=piipeToolbarSettingsPatchRequest)
except ApiException as e:
    print("Exception when calling NavigationApi->piipeToolbarSettingsPatch: %s\n" % e)
extern crate NavigationApi;

pub fn main() {
    let piipeToolbarSettingsPatchRequest = ; // PiipeToolbarSettingsPatchRequest

    let mut context = NavigationApi::Context::default();
    let result = client.piipeToolbarSettingsPatch(piipeToolbarSettingsPatchRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
piipeToolbarSettingsPatchRequest

List of toolbar items settings.

Responses


piipeToolbarSettingsPost

Add toolbar item settings.

Lets the user add toolbar item settings.


/piipe_toolbar/settings

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://nextworkplace.staging/api/v1/piipe_toolbar/settings" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NavigationApi;

import java.io.File;
import java.util.*;

public class NavigationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        NavigationApi apiInstance = new NavigationApi();
        PiipeToolbarSettingsPostRequest piipeToolbarSettingsPostRequest = ; // PiipeToolbarSettingsPostRequest | 

        try {
            apiInstance.piipeToolbarSettingsPost(piipeToolbarSettingsPostRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling NavigationApi#piipeToolbarSettingsPost");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final PiipeToolbarSettingsPostRequest piipeToolbarSettingsPostRequest = new PiipeToolbarSettingsPostRequest(); // PiipeToolbarSettingsPostRequest | 

try {
    final result = await api_instance.piipeToolbarSettingsPost(piipeToolbarSettingsPostRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->piipeToolbarSettingsPost: $e\n');
}

import org.openapitools.client.api.NavigationApi;

public class NavigationApiExample {
    public static void main(String[] args) {
        NavigationApi apiInstance = new NavigationApi();
        PiipeToolbarSettingsPostRequest piipeToolbarSettingsPostRequest = ; // PiipeToolbarSettingsPostRequest | 

        try {
            apiInstance.piipeToolbarSettingsPost(piipeToolbarSettingsPostRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling NavigationApi#piipeToolbarSettingsPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
NavigationApi *apiInstance = [[NavigationApi alloc] init];
PiipeToolbarSettingsPostRequest *piipeToolbarSettingsPostRequest = ; //  (optional)

// Add toolbar item settings.
[apiInstance piipeToolbarSettingsPostWith:piipeToolbarSettingsPostRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.NavigationApi()
var opts = {
  'piipeToolbarSettingsPostRequest':  // {PiipeToolbarSettingsPostRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.piipeToolbarSettingsPost(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class piipeToolbarSettingsPostExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new NavigationApi();
            var piipeToolbarSettingsPostRequest = new PiipeToolbarSettingsPostRequest(); // PiipeToolbarSettingsPostRequest |  (optional) 

            try {
                // Add toolbar item settings.
                apiInstance.piipeToolbarSettingsPost(piipeToolbarSettingsPostRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling NavigationApi.piipeToolbarSettingsPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NavigationApi();
$piipeToolbarSettingsPostRequest = ; // PiipeToolbarSettingsPostRequest | 

try {
    $api_instance->piipeToolbarSettingsPost($piipeToolbarSettingsPostRequest);
} catch (Exception $e) {
    echo 'Exception when calling NavigationApi->piipeToolbarSettingsPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NavigationApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::NavigationApi->new();
my $piipeToolbarSettingsPostRequest = WWW::OPenAPIClient::Object::PiipeToolbarSettingsPostRequest->new(); # PiipeToolbarSettingsPostRequest | 

eval {
    $api_instance->piipeToolbarSettingsPost(piipeToolbarSettingsPostRequest => $piipeToolbarSettingsPostRequest);
};
if ($@) {
    warn "Exception when calling NavigationApi->piipeToolbarSettingsPost: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.NavigationApi()
piipeToolbarSettingsPostRequest =  # PiipeToolbarSettingsPostRequest |  (optional)

try:
    # Add toolbar item settings.
    api_instance.piipe_toolbar_settings_post(piipeToolbarSettingsPostRequest=piipeToolbarSettingsPostRequest)
except ApiException as e:
    print("Exception when calling NavigationApi->piipeToolbarSettingsPost: %s\n" % e)
extern crate NavigationApi;

pub fn main() {
    let piipeToolbarSettingsPostRequest = ; // PiipeToolbarSettingsPostRequest

    let mut context = NavigationApi::Context::default();
    let result = client.piipeToolbarSettingsPost(piipeToolbarSettingsPostRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
piipeToolbarSettingsPostRequest

New toolbar item settings.

Responses


Notifications

notificationsGet

Retrieve user notifications

Get a paginated list of notifications for the current user


/notifications

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/notifications?page=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NotificationsApi;

import java.io.File;
import java.util.*;

public class NotificationsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        NotificationsApi apiInstance = new NotificationsApi();
        Integer page = 56; // Integer | Page number for pagination

        try {
            _notifications_get_200_response result = apiInstance.notificationsGet(page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationsApi#notificationsGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer page = new Integer(); // Integer | Page number for pagination

try {
    final result = await api_instance.notificationsGet(page);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->notificationsGet: $e\n');
}

import org.openapitools.client.api.NotificationsApi;

public class NotificationsApiExample {
    public static void main(String[] args) {
        NotificationsApi apiInstance = new NotificationsApi();
        Integer page = 56; // Integer | Page number for pagination

        try {
            _notifications_get_200_response result = apiInstance.notificationsGet(page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationsApi#notificationsGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
NotificationsApi *apiInstance = [[NotificationsApi alloc] init];
Integer *page = 56; // Page number for pagination (optional) (default to 0)

// Retrieve user notifications
[apiInstance notificationsGetWith:page
              completionHandler: ^(_notifications_get_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.NotificationsApi()
var opts = {
  'page': 56 // {Integer} Page number for pagination
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.notificationsGet(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class notificationsGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new NotificationsApi();
            var page = 56;  // Integer | Page number for pagination (optional)  (default to 0)

            try {
                // Retrieve user notifications
                _notifications_get_200_response result = apiInstance.notificationsGet(page);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling NotificationsApi.notificationsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NotificationsApi();
$page = 56; // Integer | Page number for pagination

try {
    $result = $api_instance->notificationsGet($page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NotificationsApi->notificationsGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NotificationsApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::NotificationsApi->new();
my $page = 56; # Integer | Page number for pagination

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.NotificationsApi()
page = 56 # Integer | Page number for pagination (optional) (default to 0)

try:
    # Retrieve user notifications
    api_response = api_instance.notifications_get(page=page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NotificationsApi->notificationsGet: %s\n" % e)
extern crate NotificationsApi;

pub fn main() {
    let page = 56; // Integer

    let mut context = NotificationsApi::Context::default();
    let result = client.notificationsGet(page, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
page
Integer
Page number for pagination

Responses


notificationsPatch

Perform actions on notifications

Update, mark, or delete notifications


/notifications

Usage and SDK Samples

curl -X PATCH \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://nextworkplace.staging/api/v1/notifications" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NotificationsApi;

import java.io.File;
import java.util.*;

public class NotificationsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        NotificationsApi apiInstance = new NotificationsApi();
        NotificationsPatchRequest notificationsPatchRequest = {"action":"update_message_status","mid":1,"status":true}; // NotificationsPatchRequest | 

        try {
            apiInstance.notificationsPatch(notificationsPatchRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationsApi#notificationsPatch");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final NotificationsPatchRequest notificationsPatchRequest = new NotificationsPatchRequest(); // NotificationsPatchRequest | 

try {
    final result = await api_instance.notificationsPatch(notificationsPatchRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->notificationsPatch: $e\n');
}

import org.openapitools.client.api.NotificationsApi;

public class NotificationsApiExample {
    public static void main(String[] args) {
        NotificationsApi apiInstance = new NotificationsApi();
        NotificationsPatchRequest notificationsPatchRequest = {"action":"update_message_status","mid":1,"status":true}; // NotificationsPatchRequest | 

        try {
            apiInstance.notificationsPatch(notificationsPatchRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationsApi#notificationsPatch");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
NotificationsApi *apiInstance = [[NotificationsApi alloc] init];
NotificationsPatchRequest *notificationsPatchRequest = {"action":"update_message_status","mid":1,"status":true}; // 

// Perform actions on notifications
[apiInstance notificationsPatchWith:notificationsPatchRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.NotificationsApi()
var notificationsPatchRequest = {"action":"update_message_status","mid":1,"status":true}; // {NotificationsPatchRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.notificationsPatch(notificationsPatchRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class notificationsPatchExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new NotificationsApi();
            var notificationsPatchRequest = new NotificationsPatchRequest(); // NotificationsPatchRequest | 

            try {
                // Perform actions on notifications
                apiInstance.notificationsPatch(notificationsPatchRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling NotificationsApi.notificationsPatch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NotificationsApi();
$notificationsPatchRequest = {"action":"update_message_status","mid":1,"status":true}; // NotificationsPatchRequest | 

try {
    $api_instance->notificationsPatch($notificationsPatchRequest);
} catch (Exception $e) {
    echo 'Exception when calling NotificationsApi->notificationsPatch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NotificationsApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::NotificationsApi->new();
my $notificationsPatchRequest = WWW::OPenAPIClient::Object::NotificationsPatchRequest->new(); # NotificationsPatchRequest | 

eval {
    $api_instance->notificationsPatch(notificationsPatchRequest => $notificationsPatchRequest);
};
if ($@) {
    warn "Exception when calling NotificationsApi->notificationsPatch: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.NotificationsApi()
notificationsPatchRequest = {"action":"update_message_status","mid":1,"status":true} # NotificationsPatchRequest | 

try:
    # Perform actions on notifications
    api_instance.notifications_patch(notificationsPatchRequest)
except ApiException as e:
    print("Exception when calling NotificationsApi->notificationsPatch: %s\n" % e)
extern crate NotificationsApi;

pub fn main() {
    let notificationsPatchRequest = {"action":"update_message_status","mid":1,"status":true}; // NotificationsPatchRequest

    let mut context = NotificationsApi::Context::default();
    let result = client.notificationsPatch(notificationsPatchRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
notificationsPatchRequest *

Responses


registerDeviceTokenPost

Register a device token for a specific app.

The device token is needed for sending push notifications to the app.


/register_device_token

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://nextworkplace.staging/api/v1/register_device_token" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NotificationsApi;

import java.io.File;
import java.util.*;

public class NotificationsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        NotificationsApi apiInstance = new NotificationsApi();
        RegisterDeviceTokenPostRequest registerDeviceTokenPostRequest = ; // RegisterDeviceTokenPostRequest | 

        try {
            'String' result = apiInstance.registerDeviceTokenPost(registerDeviceTokenPostRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationsApi#registerDeviceTokenPost");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final RegisterDeviceTokenPostRequest registerDeviceTokenPostRequest = new RegisterDeviceTokenPostRequest(); // RegisterDeviceTokenPostRequest | 

try {
    final result = await api_instance.registerDeviceTokenPost(registerDeviceTokenPostRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->registerDeviceTokenPost: $e\n');
}

import org.openapitools.client.api.NotificationsApi;

public class NotificationsApiExample {
    public static void main(String[] args) {
        NotificationsApi apiInstance = new NotificationsApi();
        RegisterDeviceTokenPostRequest registerDeviceTokenPostRequest = ; // RegisterDeviceTokenPostRequest | 

        try {
            'String' result = apiInstance.registerDeviceTokenPost(registerDeviceTokenPostRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationsApi#registerDeviceTokenPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
NotificationsApi *apiInstance = [[NotificationsApi alloc] init];
RegisterDeviceTokenPostRequest *registerDeviceTokenPostRequest = ; //  (optional)

// Register a device token for a specific app.
[apiInstance registerDeviceTokenPostWith:registerDeviceTokenPostRequest
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.NotificationsApi()
var opts = {
  'registerDeviceTokenPostRequest':  // {RegisterDeviceTokenPostRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.registerDeviceTokenPost(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class registerDeviceTokenPostExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new NotificationsApi();
            var registerDeviceTokenPostRequest = new RegisterDeviceTokenPostRequest(); // RegisterDeviceTokenPostRequest |  (optional) 

            try {
                // Register a device token for a specific app.
                'String' result = apiInstance.registerDeviceTokenPost(registerDeviceTokenPostRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling NotificationsApi.registerDeviceTokenPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NotificationsApi();
$registerDeviceTokenPostRequest = ; // RegisterDeviceTokenPostRequest | 

try {
    $result = $api_instance->registerDeviceTokenPost($registerDeviceTokenPostRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NotificationsApi->registerDeviceTokenPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NotificationsApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::NotificationsApi->new();
my $registerDeviceTokenPostRequest = WWW::OPenAPIClient::Object::RegisterDeviceTokenPostRequest->new(); # RegisterDeviceTokenPostRequest | 

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.NotificationsApi()
registerDeviceTokenPostRequest =  # RegisterDeviceTokenPostRequest |  (optional)

try:
    # Register a device token for a specific app.
    api_response = api_instance.register_device_token_post(registerDeviceTokenPostRequest=registerDeviceTokenPostRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NotificationsApi->registerDeviceTokenPost: %s\n" % e)
extern crate NotificationsApi;

pub fn main() {
    let registerDeviceTokenPostRequest = ; // RegisterDeviceTokenPostRequest

    let mut context = NotificationsApi::Context::default();
    let result = client.registerDeviceTokenPost(registerDeviceTokenPostRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
registerDeviceTokenPostRequest

The device token to be registered and the tageted push notification service ("apns" for IOS and "fcm" for android).

Responses


registerDeviceTokenTokenDelete

Delete a registered device token.


/register_device_token/{token}

Usage and SDK Samples

curl -X DELETE \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/register_device_token/{token}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NotificationsApi;

import java.io.File;
import java.util.*;

public class NotificationsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        NotificationsApi apiInstance = new NotificationsApi();
        String token = 2a362eaec47afc3d1c8965a7fd985cabe2c2bae84dadb15a1cc1823a85423188; // String | The device token to be deleted.

        try {
            apiInstance.registerDeviceTokenTokenDelete(token);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationsApi#registerDeviceTokenTokenDelete");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String token = new String(); // String | The device token to be deleted.

try {
    final result = await api_instance.registerDeviceTokenTokenDelete(token);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->registerDeviceTokenTokenDelete: $e\n');
}

import org.openapitools.client.api.NotificationsApi;

public class NotificationsApiExample {
    public static void main(String[] args) {
        NotificationsApi apiInstance = new NotificationsApi();
        String token = 2a362eaec47afc3d1c8965a7fd985cabe2c2bae84dadb15a1cc1823a85423188; // String | The device token to be deleted.

        try {
            apiInstance.registerDeviceTokenTokenDelete(token);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationsApi#registerDeviceTokenTokenDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
NotificationsApi *apiInstance = [[NotificationsApi alloc] init];
String *token = 2a362eaec47afc3d1c8965a7fd985cabe2c2bae84dadb15a1cc1823a85423188; // The device token to be deleted. (default to null)

// Delete a registered device token.
[apiInstance registerDeviceTokenTokenDeleteWith:token
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.NotificationsApi()
var token = 2a362eaec47afc3d1c8965a7fd985cabe2c2bae84dadb15a1cc1823a85423188; // {String} The device token to be deleted.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.registerDeviceTokenTokenDelete(token, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class registerDeviceTokenTokenDeleteExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new NotificationsApi();
            var token = 2a362eaec47afc3d1c8965a7fd985cabe2c2bae84dadb15a1cc1823a85423188;  // String | The device token to be deleted. (default to null)

            try {
                // Delete a registered device token.
                apiInstance.registerDeviceTokenTokenDelete(token);
            } catch (Exception e) {
                Debug.Print("Exception when calling NotificationsApi.registerDeviceTokenTokenDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NotificationsApi();
$token = 2a362eaec47afc3d1c8965a7fd985cabe2c2bae84dadb15a1cc1823a85423188; // String | The device token to be deleted.

try {
    $api_instance->registerDeviceTokenTokenDelete($token);
} catch (Exception $e) {
    echo 'Exception when calling NotificationsApi->registerDeviceTokenTokenDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NotificationsApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::NotificationsApi->new();
my $token = 2a362eaec47afc3d1c8965a7fd985cabe2c2bae84dadb15a1cc1823a85423188; # String | The device token to be deleted.

eval {
    $api_instance->registerDeviceTokenTokenDelete(token => $token);
};
if ($@) {
    warn "Exception when calling NotificationsApi->registerDeviceTokenTokenDelete: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.NotificationsApi()
token = 2a362eaec47afc3d1c8965a7fd985cabe2c2bae84dadb15a1cc1823a85423188 # String | The device token to be deleted. (default to null)

try:
    # Delete a registered device token.
    api_instance.register_device_token_token_delete(token)
except ApiException as e:
    print("Exception when calling NotificationsApi->registerDeviceTokenTokenDelete: %s\n" % e)
extern crate NotificationsApi;

pub fn main() {
    let token = 2a362eaec47afc3d1c8965a7fd985cabe2c2bae84dadb15a1cc1823a85423188; // String

    let mut context = NotificationsApi::Context::default();
    let result = client.registerDeviceTokenTokenDelete(token, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
token*
String
The device token to be deleted.
Required

Responses


OverviewPages

apiV1PiipePictureGalleryCreatePost

Create a new gallery post


/api/v1/piipe_picture_gallery/create

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://nextworkplace.staging/api/v1/api/v1/piipe_picture_gallery/create" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OverviewPagesApi;

import java.io.File;
import java.util.*;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        ApiV1PiipePictureGalleryCreatePostRequest apiV1PiipePictureGalleryCreatePostRequest = ; // ApiV1PiipePictureGalleryCreatePostRequest | 

        try {
            _api_v1_piipe_picture_gallery_create_post_200_response result = apiInstance.apiV1PiipePictureGalleryCreatePost(apiV1PiipePictureGalleryCreatePostRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#apiV1PiipePictureGalleryCreatePost");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final ApiV1PiipePictureGalleryCreatePostRequest apiV1PiipePictureGalleryCreatePostRequest = new ApiV1PiipePictureGalleryCreatePostRequest(); // ApiV1PiipePictureGalleryCreatePostRequest | 

try {
    final result = await api_instance.apiV1PiipePictureGalleryCreatePost(apiV1PiipePictureGalleryCreatePostRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->apiV1PiipePictureGalleryCreatePost: $e\n');
}

import org.openapitools.client.api.OverviewPagesApi;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        ApiV1PiipePictureGalleryCreatePostRequest apiV1PiipePictureGalleryCreatePostRequest = ; // ApiV1PiipePictureGalleryCreatePostRequest | 

        try {
            _api_v1_piipe_picture_gallery_create_post_200_response result = apiInstance.apiV1PiipePictureGalleryCreatePost(apiV1PiipePictureGalleryCreatePostRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#apiV1PiipePictureGalleryCreatePost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
OverviewPagesApi *apiInstance = [[OverviewPagesApi alloc] init];
ApiV1PiipePictureGalleryCreatePostRequest *apiV1PiipePictureGalleryCreatePostRequest = ; // 

// Create a new gallery post
[apiInstance apiV1PiipePictureGalleryCreatePostWith:apiV1PiipePictureGalleryCreatePostRequest
              completionHandler: ^(_api_v1_piipe_picture_gallery_create_post_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.OverviewPagesApi()
var apiV1PiipePictureGalleryCreatePostRequest = ; // {ApiV1PiipePictureGalleryCreatePostRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiV1PiipePictureGalleryCreatePost(apiV1PiipePictureGalleryCreatePostRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class apiV1PiipePictureGalleryCreatePostExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OverviewPagesApi();
            var apiV1PiipePictureGalleryCreatePostRequest = new ApiV1PiipePictureGalleryCreatePostRequest(); // ApiV1PiipePictureGalleryCreatePostRequest | 

            try {
                // Create a new gallery post
                _api_v1_piipe_picture_gallery_create_post_200_response result = apiInstance.apiV1PiipePictureGalleryCreatePost(apiV1PiipePictureGalleryCreatePostRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OverviewPagesApi.apiV1PiipePictureGalleryCreatePost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OverviewPagesApi();
$apiV1PiipePictureGalleryCreatePostRequest = ; // ApiV1PiipePictureGalleryCreatePostRequest | 

try {
    $result = $api_instance->apiV1PiipePictureGalleryCreatePost($apiV1PiipePictureGalleryCreatePostRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OverviewPagesApi->apiV1PiipePictureGalleryCreatePost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OverviewPagesApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OverviewPagesApi->new();
my $apiV1PiipePictureGalleryCreatePostRequest = WWW::OPenAPIClient::Object::ApiV1PiipePictureGalleryCreatePostRequest->new(); # ApiV1PiipePictureGalleryCreatePostRequest | 

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OverviewPagesApi()
apiV1PiipePictureGalleryCreatePostRequest =  # ApiV1PiipePictureGalleryCreatePostRequest | 

try:
    # Create a new gallery post
    api_response = api_instance.api_v1_piipe_picture_gallery_create_post(apiV1PiipePictureGalleryCreatePostRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OverviewPagesApi->apiV1PiipePictureGalleryCreatePost: %s\n" % e)
extern crate OverviewPagesApi;

pub fn main() {
    let apiV1PiipePictureGalleryCreatePostRequest = ; // ApiV1PiipePictureGalleryCreatePostRequest

    let mut context = OverviewPagesApi::Context::default();
    let result = client.apiV1PiipePictureGalleryCreatePost(apiV1PiipePictureGalleryCreatePostRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
apiV1PiipePictureGalleryCreatePostRequest *

Responses


birthdayCalendarGet

Get birthday calendar content.

Get list of birthday entries of a specific month.


/birthday_calendar

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/birthday_calendar?pageNo=56&activeMonthIndex=56&location=Berlin"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OverviewPagesApi;

import java.io.File;
import java.util.*;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        Integer pageNo = 56; // Integer | Pager for the content.
        Integer activeMonthIndex = 56; // Integer | Month filter .
        String location = Berlin; // String | Location filter.

        try {
            _birthday_calendar_get_200_response result = apiInstance.birthdayCalendarGet(pageNo, activeMonthIndex, location);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#birthdayCalendarGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer pageNo = new Integer(); // Integer | Pager for the content.
final Integer activeMonthIndex = new Integer(); // Integer | Month filter .
final String location = new String(); // String | Location filter.

try {
    final result = await api_instance.birthdayCalendarGet(pageNo, activeMonthIndex, location);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->birthdayCalendarGet: $e\n');
}

import org.openapitools.client.api.OverviewPagesApi;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        Integer pageNo = 56; // Integer | Pager for the content.
        Integer activeMonthIndex = 56; // Integer | Month filter .
        String location = Berlin; // String | Location filter.

        try {
            _birthday_calendar_get_200_response result = apiInstance.birthdayCalendarGet(pageNo, activeMonthIndex, location);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#birthdayCalendarGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
OverviewPagesApi *apiInstance = [[OverviewPagesApi alloc] init];
Integer *pageNo = 56; // Pager for the content. (optional) (default to null)
Integer *activeMonthIndex = 56; // Month filter . (optional) (default to null)
String *location = Berlin; // Location filter. (optional) (default to null)

// Get birthday calendar content.
[apiInstance birthdayCalendarGetWith:pageNo
    activeMonthIndex:activeMonthIndex
    location:location
              completionHandler: ^(_birthday_calendar_get_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.OverviewPagesApi()
var opts = {
  'pageNo': 56, // {Integer} Pager for the content.
  'activeMonthIndex': 56, // {Integer} Month filter .
  'location': Berlin // {String} Location filter.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.birthdayCalendarGet(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class birthdayCalendarGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OverviewPagesApi();
            var pageNo = 56;  // Integer | Pager for the content. (optional)  (default to null)
            var activeMonthIndex = 56;  // Integer | Month filter . (optional)  (default to null)
            var location = Berlin;  // String | Location filter. (optional)  (default to null)

            try {
                // Get birthday calendar content.
                _birthday_calendar_get_200_response result = apiInstance.birthdayCalendarGet(pageNo, activeMonthIndex, location);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OverviewPagesApi.birthdayCalendarGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OverviewPagesApi();
$pageNo = 56; // Integer | Pager for the content.
$activeMonthIndex = 56; // Integer | Month filter .
$location = Berlin; // String | Location filter.

try {
    $result = $api_instance->birthdayCalendarGet($pageNo, $activeMonthIndex, $location);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OverviewPagesApi->birthdayCalendarGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OverviewPagesApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OverviewPagesApi->new();
my $pageNo = 56; # Integer | Pager for the content.
my $activeMonthIndex = 56; # Integer | Month filter .
my $location = Berlin; # String | Location filter.

eval {
    my $result = $api_instance->birthdayCalendarGet(pageNo => $pageNo, activeMonthIndex => $activeMonthIndex, location => $location);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OverviewPagesApi->birthdayCalendarGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OverviewPagesApi()
pageNo = 56 # Integer | Pager for the content. (optional) (default to null)
activeMonthIndex = 56 # Integer | Month filter . (optional) (default to null)
location = Berlin # String | Location filter. (optional) (default to null)

try:
    # Get birthday calendar content.
    api_response = api_instance.birthday_calendar_get(pageNo=pageNo, activeMonthIndex=activeMonthIndex, location=location)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OverviewPagesApi->birthdayCalendarGet: %s\n" % e)
extern crate OverviewPagesApi;

pub fn main() {
    let pageNo = 56; // Integer
    let activeMonthIndex = 56; // Integer
    let location = Berlin; // String

    let mut context = OverviewPagesApi::Context::default();
    let result = client.birthdayCalendarGet(pageNo, activeMonthIndex, location, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
pageNo
Integer
Pager for the content.
activeMonthIndex
Integer
Month filter .
location
String
Location filter.

Responses


birthdayCalendarRecentBirthdayTypeGet

Get birthday calendar recent content.

Get list of birthday entries of either today or tomorrow.


/birthday_calendar/recent_birthday/{type}

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/birthday_calendar/recent_birthday/{type}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OverviewPagesApi;

import java.io.File;
import java.util.*;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        String type = type_example; // String | Filter of recent Birthdays (either today or tomorrow).

        try {
            array[_birthday_calendar_recent_birthday__type__get_200_response_inner] result = apiInstance.birthdayCalendarRecentBirthdayTypeGet(type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#birthdayCalendarRecentBirthdayTypeGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String type = new String(); // String | Filter of recent Birthdays (either today or tomorrow).

try {
    final result = await api_instance.birthdayCalendarRecentBirthdayTypeGet(type);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->birthdayCalendarRecentBirthdayTypeGet: $e\n');
}

import org.openapitools.client.api.OverviewPagesApi;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        String type = type_example; // String | Filter of recent Birthdays (either today or tomorrow).

        try {
            array[_birthday_calendar_recent_birthday__type__get_200_response_inner] result = apiInstance.birthdayCalendarRecentBirthdayTypeGet(type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#birthdayCalendarRecentBirthdayTypeGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
OverviewPagesApi *apiInstance = [[OverviewPagesApi alloc] init];
String *type = type_example; // Filter of recent Birthdays (either today or tomorrow). (default to null)

// Get birthday calendar recent content.
[apiInstance birthdayCalendarRecentBirthdayTypeGetWith:type
              completionHandler: ^(array[_birthday_calendar_recent_birthday__type__get_200_response_inner] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.OverviewPagesApi()
var type = type_example; // {String} Filter of recent Birthdays (either today or tomorrow).

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.birthdayCalendarRecentBirthdayTypeGet(type, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class birthdayCalendarRecentBirthdayTypeGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OverviewPagesApi();
            var type = type_example;  // String | Filter of recent Birthdays (either today or tomorrow). (default to null)

            try {
                // Get birthday calendar recent content.
                array[_birthday_calendar_recent_birthday__type__get_200_response_inner] result = apiInstance.birthdayCalendarRecentBirthdayTypeGet(type);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OverviewPagesApi.birthdayCalendarRecentBirthdayTypeGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OverviewPagesApi();
$type = type_example; // String | Filter of recent Birthdays (either today or tomorrow).

try {
    $result = $api_instance->birthdayCalendarRecentBirthdayTypeGet($type);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OverviewPagesApi->birthdayCalendarRecentBirthdayTypeGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OverviewPagesApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OverviewPagesApi->new();
my $type = type_example; # String | Filter of recent Birthdays (either today or tomorrow).

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OverviewPagesApi()
type = type_example # String | Filter of recent Birthdays (either today or tomorrow). (default to null)

try:
    # Get birthday calendar recent content.
    api_response = api_instance.birthday_calendar_recent_birthday_type_get(type)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OverviewPagesApi->birthdayCalendarRecentBirthdayTypeGet: %s\n" % e)
extern crate OverviewPagesApi;

pub fn main() {
    let type = type_example; // String

    let mut context = OverviewPagesApi::Context::default();
    let result = client.birthdayCalendarRecentBirthdayTypeGet(type, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
type*
String
Filter of recent Birthdays (either today or tomorrow).
Required

Responses


boxPagesPageNameGet

Get a box page content.

Static and dynamic (user specific) box pages can be retreived through this endpoint.


/box_pages/{page_name}

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/box_pages/{page_name}?view_mode=viewMode_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OverviewPagesApi;

import java.io.File;
import java.util.*;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        String pageName = company; // String | Box page name.
        String viewMode = viewMode_example; // String | Retreive boxes data in the box page as they appear in the specified view mode. If the parameter is not included, the "box" view mode will be used. (list view mode is not yet implemented)

        try {
            _box_pages__page_name__get_200_response result = apiInstance.boxPagesPageNameGet(pageName, viewMode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#boxPagesPageNameGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String pageName = new String(); // String | Box page name.
final String viewMode = new String(); // String | Retreive boxes data in the box page as they appear in the specified view mode. If the parameter is not included, the "box" view mode will be used. (list view mode is not yet implemented)

try {
    final result = await api_instance.boxPagesPageNameGet(pageName, viewMode);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->boxPagesPageNameGet: $e\n');
}

import org.openapitools.client.api.OverviewPagesApi;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        String pageName = company; // String | Box page name.
        String viewMode = viewMode_example; // String | Retreive boxes data in the box page as they appear in the specified view mode. If the parameter is not included, the "box" view mode will be used. (list view mode is not yet implemented)

        try {
            _box_pages__page_name__get_200_response result = apiInstance.boxPagesPageNameGet(pageName, viewMode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#boxPagesPageNameGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
OverviewPagesApi *apiInstance = [[OverviewPagesApi alloc] init];
String *pageName = company; // Box page name. (default to null)
String *viewMode = viewMode_example; // Retreive boxes data in the box page as they appear in the specified view mode. If the parameter is not included, the "box" view mode will be used. (list view mode is not yet implemented) (optional) (default to null)

// Get a box page content.
[apiInstance boxPagesPageNameGetWith:pageName
    viewMode:viewMode
              completionHandler: ^(_box_pages__page_name__get_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.OverviewPagesApi()
var pageName = company; // {String} Box page name.
var opts = {
  'viewMode': viewMode_example // {String} Retreive boxes data in the box page as they appear in the specified view mode. If the parameter is not included, the "box" view mode will be used. (list view mode is not yet implemented)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.boxPagesPageNameGet(pageName, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class boxPagesPageNameGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OverviewPagesApi();
            var pageName = company;  // String | Box page name. (default to null)
            var viewMode = viewMode_example;  // String | Retreive boxes data in the box page as they appear in the specified view mode. If the parameter is not included, the "box" view mode will be used. (list view mode is not yet implemented) (optional)  (default to null)

            try {
                // Get a box page content.
                _box_pages__page_name__get_200_response result = apiInstance.boxPagesPageNameGet(pageName, viewMode);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OverviewPagesApi.boxPagesPageNameGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OverviewPagesApi();
$pageName = company; // String | Box page name.
$viewMode = viewMode_example; // String | Retreive boxes data in the box page as they appear in the specified view mode. If the parameter is not included, the "box" view mode will be used. (list view mode is not yet implemented)

try {
    $result = $api_instance->boxPagesPageNameGet($pageName, $viewMode);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OverviewPagesApi->boxPagesPageNameGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OverviewPagesApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OverviewPagesApi->new();
my $pageName = company; # String | Box page name.
my $viewMode = viewMode_example; # String | Retreive boxes data in the box page as they appear in the specified view mode. If the parameter is not included, the "box" view mode will be used. (list view mode is not yet implemented)

eval {
    my $result = $api_instance->boxPagesPageNameGet(pageName => $pageName, viewMode => $viewMode);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OverviewPagesApi->boxPagesPageNameGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OverviewPagesApi()
pageName = company # String | Box page name. (default to null)
viewMode = viewMode_example # String | Retreive boxes data in the box page as they appear in the specified view mode. If the parameter is not included, the "box" view mode will be used. (list view mode is not yet implemented) (optional) (default to null)

try:
    # Get a box page content.
    api_response = api_instance.box_pages_page_name_get(pageName, viewMode=viewMode)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OverviewPagesApi->boxPagesPageNameGet: %s\n" % e)
extern crate OverviewPagesApi;

pub fn main() {
    let pageName = company; // String
    let viewMode = viewMode_example; // String

    let mut context = OverviewPagesApi::Context::default();
    let result = client.boxPagesPageNameGet(pageName, viewMode, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
page_name*
String
Box page name.
Required
Query parameters
Name Description
view_mode
String
Retreive boxes data in the box page as they appear in the specified view mode. If the parameter is not included, the "box" view mode will be used. (list view mode is not yet implemented)

Responses


documentSearchGet

Document Search site content.


/document_search

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/document_search?search_api_fulltext=neocosmo&sort_by=search_api_relevance&page=0&f=f[0]=type:user"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OverviewPagesApi;

import java.io.File;
import java.util.*;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        String searchApiFulltext = neocosmo; // String | The search term. If an empty string is provided or the query parameter is not added to the request, the whole website content will be seen as valid search results.
        String sortBy = search_api_relevance; // String | Sort search results by relevance or publishing date.
        Integer page = 0; // Integer | Pager for search results.
        String f = f[0]=type:user; // String | Facets filters. When facets should be used to filter the search results, they have to be added as array items of this query parameter: a facet will filter should have the form **f[INDEX]=FACET_ID:VALUE** where **INDEX** is an index number for the filters array (starting from zero). For example, to search users that live in Berlin (ID = 45), the facets "type" and "location" have to be added to the array in the following manner: **/search?f[0]=type:user&f[1]=location:45**. The order of filters in the array has no effect.

        try {
            DocumentSearch result = apiInstance.documentSearchGet(searchApiFulltext, sortBy, page, f);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#documentSearchGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String searchApiFulltext = new String(); // String | The search term. If an empty string is provided or the query parameter is not added to the request, the whole website content will be seen as valid search results.
final String sortBy = new String(); // String | Sort search results by relevance or publishing date.
final Integer page = new Integer(); // Integer | Pager for search results.
final String f = new String(); // String | Facets filters. When facets should be used to filter the search results, they have to be added as array items of this query parameter: a facet will filter should have the form **f[INDEX]=FACET_ID:VALUE** where **INDEX** is an index number for the filters array (starting from zero). For example, to search users that live in Berlin (ID = 45), the facets "type" and "location" have to be added to the array in the following manner: **/search?f[0]=type:user&f[1]=location:45**. The order of filters in the array has no effect.

try {
    final result = await api_instance.documentSearchGet(searchApiFulltext, sortBy, page, f);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->documentSearchGet: $e\n');
}

import org.openapitools.client.api.OverviewPagesApi;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        String searchApiFulltext = neocosmo; // String | The search term. If an empty string is provided or the query parameter is not added to the request, the whole website content will be seen as valid search results.
        String sortBy = search_api_relevance; // String | Sort search results by relevance or publishing date.
        Integer page = 0; // Integer | Pager for search results.
        String f = f[0]=type:user; // String | Facets filters. When facets should be used to filter the search results, they have to be added as array items of this query parameter: a facet will filter should have the form **f[INDEX]=FACET_ID:VALUE** where **INDEX** is an index number for the filters array (starting from zero). For example, to search users that live in Berlin (ID = 45), the facets "type" and "location" have to be added to the array in the following manner: **/search?f[0]=type:user&f[1]=location:45**. The order of filters in the array has no effect.

        try {
            DocumentSearch result = apiInstance.documentSearchGet(searchApiFulltext, sortBy, page, f);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#documentSearchGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
OverviewPagesApi *apiInstance = [[OverviewPagesApi alloc] init];
String *searchApiFulltext = neocosmo; // The search term. If an empty string is provided or the query parameter is not added to the request, the whole website content will be seen as valid search results. (optional) (default to null)
String *sortBy = search_api_relevance; // Sort search results by relevance or publishing date. (optional) (default to null)
Integer *page = 0; // Pager for search results. (optional) (default to null)
String *f = f[0]=type:user; // Facets filters. When facets should be used to filter the search results, they have to be added as array items of this query parameter: a facet will filter should have the form **f[INDEX]=FACET_ID:VALUE** where **INDEX** is an index number for the filters array (starting from zero). For example, to search users that live in Berlin (ID = 45), the facets "type" and "location" have to be added to the array in the following manner: **/search?f[0]=type:user&f[1]=location:45**. The order of filters in the array has no effect. (optional) (default to null)

// Document Search site content.
[apiInstance documentSearchGetWith:searchApiFulltext
    sortBy:sortBy
    page:page
    f:f
              completionHandler: ^(DocumentSearch output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.OverviewPagesApi()
var opts = {
  'searchApiFulltext': neocosmo, // {String} The search term. If an empty string is provided or the query parameter is not added to the request, the whole website content will be seen as valid search results.
  'sortBy': search_api_relevance, // {String} Sort search results by relevance or publishing date.
  'page': 0, // {Integer} Pager for search results.
  'f': f[0]=type:user // {String} Facets filters. When facets should be used to filter the search results, they have to be added as array items of this query parameter: a facet will filter should have the form **f[INDEX]=FACET_ID:VALUE** where **INDEX** is an index number for the filters array (starting from zero). For example, to search users that live in Berlin (ID = 45), the facets "type" and "location" have to be added to the array in the following manner: **/search?f[0]=type:user&f[1]=location:45**. The order of filters in the array has no effect.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.documentSearchGet(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class documentSearchGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OverviewPagesApi();
            var searchApiFulltext = neocosmo;  // String | The search term. If an empty string is provided or the query parameter is not added to the request, the whole website content will be seen as valid search results. (optional)  (default to null)
            var sortBy = search_api_relevance;  // String | Sort search results by relevance or publishing date. (optional)  (default to null)
            var page = 0;  // Integer | Pager for search results. (optional)  (default to null)
            var f = f[0]=type:user;  // String | Facets filters. When facets should be used to filter the search results, they have to be added as array items of this query parameter: a facet will filter should have the form **f[INDEX]=FACET_ID:VALUE** where **INDEX** is an index number for the filters array (starting from zero). For example, to search users that live in Berlin (ID = 45), the facets "type" and "location" have to be added to the array in the following manner: **/search?f[0]=type:user&f[1]=location:45**. The order of filters in the array has no effect. (optional)  (default to null)

            try {
                // Document Search site content.
                DocumentSearch result = apiInstance.documentSearchGet(searchApiFulltext, sortBy, page, f);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OverviewPagesApi.documentSearchGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OverviewPagesApi();
$searchApiFulltext = neocosmo; // String | The search term. If an empty string is provided or the query parameter is not added to the request, the whole website content will be seen as valid search results.
$sortBy = search_api_relevance; // String | Sort search results by relevance or publishing date.
$page = 0; // Integer | Pager for search results.
$f = f[0]=type:user; // String | Facets filters. When facets should be used to filter the search results, they have to be added as array items of this query parameter: a facet will filter should have the form **f[INDEX]=FACET_ID:VALUE** where **INDEX** is an index number for the filters array (starting from zero). For example, to search users that live in Berlin (ID = 45), the facets "type" and "location" have to be added to the array in the following manner: **/search?f[0]=type:user&f[1]=location:45**. The order of filters in the array has no effect.

try {
    $result = $api_instance->documentSearchGet($searchApiFulltext, $sortBy, $page, $f);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OverviewPagesApi->documentSearchGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OverviewPagesApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OverviewPagesApi->new();
my $searchApiFulltext = neocosmo; # String | The search term. If an empty string is provided or the query parameter is not added to the request, the whole website content will be seen as valid search results.
my $sortBy = search_api_relevance; # String | Sort search results by relevance or publishing date.
my $page = 0; # Integer | Pager for search results.
my $f = f[0]=type:user; # String | Facets filters. When facets should be used to filter the search results, they have to be added as array items of this query parameter: a facet will filter should have the form **f[INDEX]=FACET_ID:VALUE** where **INDEX** is an index number for the filters array (starting from zero). For example, to search users that live in Berlin (ID = 45), the facets "type" and "location" have to be added to the array in the following manner: **/search?f[0]=type:user&f[1]=location:45**. The order of filters in the array has no effect.

eval {
    my $result = $api_instance->documentSearchGet(searchApiFulltext => $searchApiFulltext, sortBy => $sortBy, page => $page, f => $f);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OverviewPagesApi->documentSearchGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OverviewPagesApi()
searchApiFulltext = neocosmo # String | The search term. If an empty string is provided or the query parameter is not added to the request, the whole website content will be seen as valid search results. (optional) (default to null)
sortBy = search_api_relevance # String | Sort search results by relevance or publishing date. (optional) (default to null)
page = 0 # Integer | Pager for search results. (optional) (default to null)
f = f[0]=type:user # String | Facets filters. When facets should be used to filter the search results, they have to be added as array items of this query parameter: a facet will filter should have the form **f[INDEX]=FACET_ID:VALUE** where **INDEX** is an index number for the filters array (starting from zero). For example, to search users that live in Berlin (ID = 45), the facets "type" and "location" have to be added to the array in the following manner: **/search?f[0]=type:user&f[1]=location:45**. The order of filters in the array has no effect. (optional) (default to null)

try:
    # Document Search site content.
    api_response = api_instance.document_search_get(searchApiFulltext=searchApiFulltext, sortBy=sortBy, page=page, f=f)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OverviewPagesApi->documentSearchGet: %s\n" % e)
extern crate OverviewPagesApi;

pub fn main() {
    let searchApiFulltext = neocosmo; // String
    let sortBy = search_api_relevance; // String
    let page = 0; // Integer
    let f = f[0]=type:user; // String

    let mut context = OverviewPagesApi::Context::default();
    let result = client.documentSearchGet(searchApiFulltext, sortBy, page, f, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
search_api_fulltext
String
The search term. If an empty string is provided or the query parameter is not added to the request, the whole website content will be seen as valid search results.
sort_by
String
Sort search results by relevance or publishing date.
page
Integer
Pager for search results.
f
String
Facets filters. When facets should be used to filter the search results, they have to be added as array items of this query parameter&#58; a facet will filter should have the form **f[INDEX]=FACET_ID:VALUE** where **INDEX** is an index number for the filters array (starting from zero). For example, to search users that live in Berlin (ID = 45), the facets "type" and "location" have to be added to the array in the following manner&#58; **/search?f[0]=type:user&f[1]=location:45**. The order of filters in the array has no effect.

Responses


employeeDirectoryEmployeesGet

Get the employees.


/employee_directory/employees

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/employee_directory/employees?page=56&search=search_example&fetch_mode=fetchMode_example&hierarchical_sort=hierarchicalSort_example&sort_by=sortBy_example&sort_dir=sortDir_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OverviewPagesApi;

import java.io.File;
import java.util.*;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        Integer page = 56; // Integer | The page.
        String search = search_example; // String | Seach term.
        String fetchMode = fetchMode_example; // String | Possible are 'favorites' or 'all'.
        String hierarchicalSort = hierarchicalSort_example; // String | Sort priorized by field name.
        String sortBy = sortBy_example; // String | Sort order, possible values are 'firstname', 'lastname' and 'hierarchy'.
        String sortDir = sortDir_example; // String | ASC or DESC.

        try {
            array[Employees] result = apiInstance.employeeDirectoryEmployeesGet(page, search, fetchMode, hierarchicalSort, sortBy, sortDir);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#employeeDirectoryEmployeesGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer page = new Integer(); // Integer | The page.
final String search = new String(); // String | Seach term.
final String fetchMode = new String(); // String | Possible are 'favorites' or 'all'.
final String hierarchicalSort = new String(); // String | Sort priorized by field name.
final String sortBy = new String(); // String | Sort order, possible values are 'firstname', 'lastname' and 'hierarchy'.
final String sortDir = new String(); // String | ASC or DESC.

try {
    final result = await api_instance.employeeDirectoryEmployeesGet(page, search, fetchMode, hierarchicalSort, sortBy, sortDir);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->employeeDirectoryEmployeesGet: $e\n');
}

import org.openapitools.client.api.OverviewPagesApi;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        Integer page = 56; // Integer | The page.
        String search = search_example; // String | Seach term.
        String fetchMode = fetchMode_example; // String | Possible are 'favorites' or 'all'.
        String hierarchicalSort = hierarchicalSort_example; // String | Sort priorized by field name.
        String sortBy = sortBy_example; // String | Sort order, possible values are 'firstname', 'lastname' and 'hierarchy'.
        String sortDir = sortDir_example; // String | ASC or DESC.

        try {
            array[Employees] result = apiInstance.employeeDirectoryEmployeesGet(page, search, fetchMode, hierarchicalSort, sortBy, sortDir);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#employeeDirectoryEmployeesGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
OverviewPagesApi *apiInstance = [[OverviewPagesApi alloc] init];
Integer *page = 56; // The page. (optional) (default to null)
String *search = search_example; // Seach term. (optional) (default to null)
String *fetchMode = fetchMode_example; // Possible are 'favorites' or 'all'. (optional) (default to null)
String *hierarchicalSort = hierarchicalSort_example; // Sort priorized by field name. (optional) (default to null)
String *sortBy = sortBy_example; // Sort order, possible values are 'firstname', 'lastname' and 'hierarchy'. (optional) (default to null)
String *sortDir = sortDir_example; // ASC or DESC. (optional) (default to null)

// Get the employees.
[apiInstance employeeDirectoryEmployeesGetWith:page
    search:search
    fetchMode:fetchMode
    hierarchicalSort:hierarchicalSort
    sortBy:sortBy
    sortDir:sortDir
              completionHandler: ^(array[Employees] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.OverviewPagesApi()
var opts = {
  'page': 56, // {Integer} The page.
  'search': search_example, // {String} Seach term.
  'fetchMode': fetchMode_example, // {String} Possible are 'favorites' or 'all'.
  'hierarchicalSort': hierarchicalSort_example, // {String} Sort priorized by field name.
  'sortBy': sortBy_example, // {String} Sort order, possible values are 'firstname', 'lastname' and 'hierarchy'.
  'sortDir': sortDir_example // {String} ASC or DESC.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.employeeDirectoryEmployeesGet(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class employeeDirectoryEmployeesGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OverviewPagesApi();
            var page = 56;  // Integer | The page. (optional)  (default to null)
            var search = search_example;  // String | Seach term. (optional)  (default to null)
            var fetchMode = fetchMode_example;  // String | Possible are 'favorites' or 'all'. (optional)  (default to null)
            var hierarchicalSort = hierarchicalSort_example;  // String | Sort priorized by field name. (optional)  (default to null)
            var sortBy = sortBy_example;  // String | Sort order, possible values are 'firstname', 'lastname' and 'hierarchy'. (optional)  (default to null)
            var sortDir = sortDir_example;  // String | ASC or DESC. (optional)  (default to null)

            try {
                // Get the employees.
                array[Employees] result = apiInstance.employeeDirectoryEmployeesGet(page, search, fetchMode, hierarchicalSort, sortBy, sortDir);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OverviewPagesApi.employeeDirectoryEmployeesGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OverviewPagesApi();
$page = 56; // Integer | The page.
$search = search_example; // String | Seach term.
$fetchMode = fetchMode_example; // String | Possible are 'favorites' or 'all'.
$hierarchicalSort = hierarchicalSort_example; // String | Sort priorized by field name.
$sortBy = sortBy_example; // String | Sort order, possible values are 'firstname', 'lastname' and 'hierarchy'.
$sortDir = sortDir_example; // String | ASC or DESC.

try {
    $result = $api_instance->employeeDirectoryEmployeesGet($page, $search, $fetchMode, $hierarchicalSort, $sortBy, $sortDir);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OverviewPagesApi->employeeDirectoryEmployeesGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OverviewPagesApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OverviewPagesApi->new();
my $page = 56; # Integer | The page.
my $search = search_example; # String | Seach term.
my $fetchMode = fetchMode_example; # String | Possible are 'favorites' or 'all'.
my $hierarchicalSort = hierarchicalSort_example; # String | Sort priorized by field name.
my $sortBy = sortBy_example; # String | Sort order, possible values are 'firstname', 'lastname' and 'hierarchy'.
my $sortDir = sortDir_example; # String | ASC or DESC.

eval {
    my $result = $api_instance->employeeDirectoryEmployeesGet(page => $page, search => $search, fetchMode => $fetchMode, hierarchicalSort => $hierarchicalSort, sortBy => $sortBy, sortDir => $sortDir);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OverviewPagesApi->employeeDirectoryEmployeesGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OverviewPagesApi()
page = 56 # Integer | The page. (optional) (default to null)
search = search_example # String | Seach term. (optional) (default to null)
fetchMode = fetchMode_example # String | Possible are 'favorites' or 'all'. (optional) (default to null)
hierarchicalSort = hierarchicalSort_example # String | Sort priorized by field name. (optional) (default to null)
sortBy = sortBy_example # String | Sort order, possible values are 'firstname', 'lastname' and 'hierarchy'. (optional) (default to null)
sortDir = sortDir_example # String | ASC or DESC. (optional) (default to null)

try:
    # Get the employees.
    api_response = api_instance.employee_directory_employees_get(page=page, search=search, fetchMode=fetchMode, hierarchicalSort=hierarchicalSort, sortBy=sortBy, sortDir=sortDir)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OverviewPagesApi->employeeDirectoryEmployeesGet: %s\n" % e)
extern crate OverviewPagesApi;

pub fn main() {
    let page = 56; // Integer
    let search = search_example; // String
    let fetchMode = fetchMode_example; // String
    let hierarchicalSort = hierarchicalSort_example; // String
    let sortBy = sortBy_example; // String
    let sortDir = sortDir_example; // String

    let mut context = OverviewPagesApi::Context::default();
    let result = client.employeeDirectoryEmployeesGet(page, search, fetchMode, hierarchicalSort, sortBy, sortDir, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
page
Integer
The page.
search
fetch_mode
String
Possible are 'favorites' or 'all'.
hierarchical_sort
String
Sort priorized by field name.
sort_by
String
Sort order, possible values are 'firstname', 'lastname' and 'hierarchy'.
sort_dir
String
ASC or DESC.

Responses


employeeJubileesGet

Get employee jubilees overview page content.

Get a list of current employee jubilees.


/employee_jubilees

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/employee_jubilees?page=56&organizational_unit=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OverviewPagesApi;

import java.io.File;
import java.util.*;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        Integer page = 56; // Integer | Pager for the content.
        Integer organizationalUnit = 56; // Integer | The person's organizational unit.

        try {
            _employee_jubilees_get_200_response result = apiInstance.employeeJubileesGet(page, organizationalUnit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#employeeJubileesGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer page = new Integer(); // Integer | Pager for the content.
final Integer organizationalUnit = new Integer(); // Integer | The person's organizational unit.

try {
    final result = await api_instance.employeeJubileesGet(page, organizationalUnit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->employeeJubileesGet: $e\n');
}

import org.openapitools.client.api.OverviewPagesApi;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        Integer page = 56; // Integer | Pager for the content.
        Integer organizationalUnit = 56; // Integer | The person's organizational unit.

        try {
            _employee_jubilees_get_200_response result = apiInstance.employeeJubileesGet(page, organizationalUnit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#employeeJubileesGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
OverviewPagesApi *apiInstance = [[OverviewPagesApi alloc] init];
Integer *page = 56; // Pager for the content. (optional) (default to null)
Integer *organizationalUnit = 56; // The person's organizational unit. (optional) (default to null)

// Get employee jubilees overview page content.
[apiInstance employeeJubileesGetWith:page
    organizationalUnit:organizationalUnit
              completionHandler: ^(_employee_jubilees_get_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.OverviewPagesApi()
var opts = {
  'page': 56, // {Integer} Pager for the content.
  'organizationalUnit': 56 // {Integer} The person's organizational unit.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.employeeJubileesGet(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class employeeJubileesGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OverviewPagesApi();
            var page = 56;  // Integer | Pager for the content. (optional)  (default to null)
            var organizationalUnit = 56;  // Integer | The person's organizational unit. (optional)  (default to null)

            try {
                // Get employee jubilees overview page content.
                _employee_jubilees_get_200_response result = apiInstance.employeeJubileesGet(page, organizationalUnit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OverviewPagesApi.employeeJubileesGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OverviewPagesApi();
$page = 56; // Integer | Pager for the content.
$organizationalUnit = 56; // Integer | The person's organizational unit.

try {
    $result = $api_instance->employeeJubileesGet($page, $organizationalUnit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OverviewPagesApi->employeeJubileesGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OverviewPagesApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OverviewPagesApi->new();
my $page = 56; # Integer | Pager for the content.
my $organizationalUnit = 56; # Integer | The person's organizational unit.

eval {
    my $result = $api_instance->employeeJubileesGet(page => $page, organizationalUnit => $organizationalUnit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OverviewPagesApi->employeeJubileesGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OverviewPagesApi()
page = 56 # Integer | Pager for the content. (optional) (default to null)
organizationalUnit = 56 # Integer | The person's organizational unit. (optional) (default to null)

try:
    # Get employee jubilees overview page content.
    api_response = api_instance.employee_jubilees_get(page=page, organizationalUnit=organizationalUnit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OverviewPagesApi->employeeJubileesGet: %s\n" % e)
extern crate OverviewPagesApi;

pub fn main() {
    let page = 56; // Integer
    let organizationalUnit = 56; // Integer

    let mut context = OverviewPagesApi::Context::default();
    let result = client.employeeJubileesGet(page, organizationalUnit, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
page
Integer
Pager for the content.
organizational_unit
Integer
The person's organizational unit.

Responses


eventBookmarkPost

Toggle bookmark state for an event.

Adds or removes a bookmark for the authenticated user on the specified event.


/event/bookmark

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://nextworkplace.staging/api/v1/event/bookmark" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OverviewPagesApi;

import java.io.File;
import java.util.*;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        EventBookmarkRequest eventBookmarkRequest = ; // EventBookmarkRequest | 

        try {
            Event-Bookmark-Response result = apiInstance.eventBookmarkPost(eventBookmarkRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#eventBookmarkPost");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final EventBookmarkRequest eventBookmarkRequest = new EventBookmarkRequest(); // EventBookmarkRequest | 

try {
    final result = await api_instance.eventBookmarkPost(eventBookmarkRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->eventBookmarkPost: $e\n');
}

import org.openapitools.client.api.OverviewPagesApi;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        EventBookmarkRequest eventBookmarkRequest = ; // EventBookmarkRequest | 

        try {
            Event-Bookmark-Response result = apiInstance.eventBookmarkPost(eventBookmarkRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#eventBookmarkPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
OverviewPagesApi *apiInstance = [[OverviewPagesApi alloc] init];
EventBookmarkRequest *eventBookmarkRequest = ; // 

// Toggle bookmark state for an event.
[apiInstance eventBookmarkPostWith:eventBookmarkRequest
              completionHandler: ^(Event-Bookmark-Response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.OverviewPagesApi()
var eventBookmarkRequest = ; // {EventBookmarkRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.eventBookmarkPost(eventBookmarkRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class eventBookmarkPostExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OverviewPagesApi();
            var eventBookmarkRequest = new EventBookmarkRequest(); // EventBookmarkRequest | 

            try {
                // Toggle bookmark state for an event.
                Event-Bookmark-Response result = apiInstance.eventBookmarkPost(eventBookmarkRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OverviewPagesApi.eventBookmarkPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OverviewPagesApi();
$eventBookmarkRequest = ; // EventBookmarkRequest | 

try {
    $result = $api_instance->eventBookmarkPost($eventBookmarkRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OverviewPagesApi->eventBookmarkPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OverviewPagesApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OverviewPagesApi->new();
my $eventBookmarkRequest = WWW::OPenAPIClient::Object::EventBookmarkRequest->new(); # EventBookmarkRequest | 

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OverviewPagesApi()
eventBookmarkRequest =  # EventBookmarkRequest | 

try:
    # Toggle bookmark state for an event.
    api_response = api_instance.event_bookmark_post(eventBookmarkRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OverviewPagesApi->eventBookmarkPost: %s\n" % e)
extern crate OverviewPagesApi;

pub fn main() {
    let eventBookmarkRequest = ; // EventBookmarkRequest

    let mut context = OverviewPagesApi::Context::default();
    let result = client.eventBookmarkPost(eventBookmarkRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
eventBookmarkRequest *

Responses


eventNidRegistrationsDelete

Delete a registration for a user.

Removes a registration for the specified user on an event. A user can remove their own registration; elevated permissions allow removing other users.


/event/{nid}/registrations

Usage and SDK Samples

curl -X DELETE \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/event/{nid}/registrations?uid=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OverviewPagesApi;

import java.io.File;
import java.util.*;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        Integer nid = 56; // Integer | Event node ID.
        Integer uid = 56; // Integer | User ID whose registration should be removed.

        try {
            Event-Registration-Delete-Response result = apiInstance.eventNidRegistrationsDelete(nid, uid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#eventNidRegistrationsDelete");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer nid = new Integer(); // Integer | Event node ID.
final Integer uid = new Integer(); // Integer | User ID whose registration should be removed.

try {
    final result = await api_instance.eventNidRegistrationsDelete(nid, uid);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->eventNidRegistrationsDelete: $e\n');
}

import org.openapitools.client.api.OverviewPagesApi;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        Integer nid = 56; // Integer | Event node ID.
        Integer uid = 56; // Integer | User ID whose registration should be removed.

        try {
            Event-Registration-Delete-Response result = apiInstance.eventNidRegistrationsDelete(nid, uid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#eventNidRegistrationsDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
OverviewPagesApi *apiInstance = [[OverviewPagesApi alloc] init];
Integer *nid = 56; // Event node ID. (default to null)
Integer *uid = 56; // User ID whose registration should be removed. (default to null)

// Delete a registration for a user.
[apiInstance eventNidRegistrationsDeleteWith:nid
    uid:uid
              completionHandler: ^(Event-Registration-Delete-Response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.OverviewPagesApi()
var nid = 56; // {Integer} Event node ID.
var uid = 56; // {Integer} User ID whose registration should be removed.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.eventNidRegistrationsDelete(nid, uid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class eventNidRegistrationsDeleteExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OverviewPagesApi();
            var nid = 56;  // Integer | Event node ID. (default to null)
            var uid = 56;  // Integer | User ID whose registration should be removed. (default to null)

            try {
                // Delete a registration for a user.
                Event-Registration-Delete-Response result = apiInstance.eventNidRegistrationsDelete(nid, uid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OverviewPagesApi.eventNidRegistrationsDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OverviewPagesApi();
$nid = 56; // Integer | Event node ID.
$uid = 56; // Integer | User ID whose registration should be removed.

try {
    $result = $api_instance->eventNidRegistrationsDelete($nid, $uid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OverviewPagesApi->eventNidRegistrationsDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OverviewPagesApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OverviewPagesApi->new();
my $nid = 56; # Integer | Event node ID.
my $uid = 56; # Integer | User ID whose registration should be removed.

eval {
    my $result = $api_instance->eventNidRegistrationsDelete(nid => $nid, uid => $uid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OverviewPagesApi->eventNidRegistrationsDelete: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OverviewPagesApi()
nid = 56 # Integer | Event node ID. (default to null)
uid = 56 # Integer | User ID whose registration should be removed. (default to null)

try:
    # Delete a registration for a user.
    api_response = api_instance.event_nid_registrations_delete(nid, uid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OverviewPagesApi->eventNidRegistrationsDelete: %s\n" % e)
extern crate OverviewPagesApi;

pub fn main() {
    let nid = 56; // Integer
    let uid = 56; // Integer

    let mut context = OverviewPagesApi::Context::default();
    let result = client.eventNidRegistrationsDelete(nid, uid, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
nid*
Integer
Event node ID.
Required
Query parameters
Name Description
uid*
Integer
User ID whose registration should be removed.
Required

Responses


eventNidRegistrationsDownloadGet

Download event registrations as CSV.

Exports participant registrations for an event as a CSV file.


/event/{nid}/registrations/download

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: text/csv" \
 "https://nextworkplace.staging/api/v1/event/{nid}/registrations/download"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OverviewPagesApi;

import java.io.File;
import java.util.*;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        Integer nid = 56; // Integer | Event node ID.

        try {
            File result = apiInstance.eventNidRegistrationsDownloadGet(nid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#eventNidRegistrationsDownloadGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer nid = new Integer(); // Integer | Event node ID.

try {
    final result = await api_instance.eventNidRegistrationsDownloadGet(nid);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->eventNidRegistrationsDownloadGet: $e\n');
}

import org.openapitools.client.api.OverviewPagesApi;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        Integer nid = 56; // Integer | Event node ID.

        try {
            File result = apiInstance.eventNidRegistrationsDownloadGet(nid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#eventNidRegistrationsDownloadGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
OverviewPagesApi *apiInstance = [[OverviewPagesApi alloc] init];
Integer *nid = 56; // Event node ID. (default to null)

// Download event registrations as CSV.
[apiInstance eventNidRegistrationsDownloadGetWith:nid
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.OverviewPagesApi()
var nid = 56; // {Integer} Event node ID.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.eventNidRegistrationsDownloadGet(nid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class eventNidRegistrationsDownloadGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OverviewPagesApi();
            var nid = 56;  // Integer | Event node ID. (default to null)

            try {
                // Download event registrations as CSV.
                File result = apiInstance.eventNidRegistrationsDownloadGet(nid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OverviewPagesApi.eventNidRegistrationsDownloadGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OverviewPagesApi();
$nid = 56; // Integer | Event node ID.

try {
    $result = $api_instance->eventNidRegistrationsDownloadGet($nid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OverviewPagesApi->eventNidRegistrationsDownloadGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OverviewPagesApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OverviewPagesApi->new();
my $nid = 56; # Integer | Event node ID.

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OverviewPagesApi()
nid = 56 # Integer | Event node ID. (default to null)

try:
    # Download event registrations as CSV.
    api_response = api_instance.event_nid_registrations_download_get(nid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OverviewPagesApi->eventNidRegistrationsDownloadGet: %s\n" % e)
extern crate OverviewPagesApi;

pub fn main() {
    let nid = 56; // Integer

    let mut context = OverviewPagesApi::Context::default();
    let result = client.eventNidRegistrationsDownloadGet(nid, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
nid*
Integer
Event node ID.
Required

Responses


eventNidRegistrationsGet

Get registrations for an event.

Returns participant registrations for a specific event, including requester capabilities for download and deletion.


/event/{nid}/registrations

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/event/{nid}/registrations"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OverviewPagesApi;

import java.io.File;
import java.util.*;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        Integer nid = 56; // Integer | Event node ID.

        try {
            Event-Registrations-Response result = apiInstance.eventNidRegistrationsGet(nid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#eventNidRegistrationsGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer nid = new Integer(); // Integer | Event node ID.

try {
    final result = await api_instance.eventNidRegistrationsGet(nid);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->eventNidRegistrationsGet: $e\n');
}

import org.openapitools.client.api.OverviewPagesApi;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        Integer nid = 56; // Integer | Event node ID.

        try {
            Event-Registrations-Response result = apiInstance.eventNidRegistrationsGet(nid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#eventNidRegistrationsGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
OverviewPagesApi *apiInstance = [[OverviewPagesApi alloc] init];
Integer *nid = 56; // Event node ID. (default to null)

// Get registrations for an event.
[apiInstance eventNidRegistrationsGetWith:nid
              completionHandler: ^(Event-Registrations-Response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.OverviewPagesApi()
var nid = 56; // {Integer} Event node ID.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.eventNidRegistrationsGet(nid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class eventNidRegistrationsGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OverviewPagesApi();
            var nid = 56;  // Integer | Event node ID. (default to null)

            try {
                // Get registrations for an event.
                Event-Registrations-Response result = apiInstance.eventNidRegistrationsGet(nid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OverviewPagesApi.eventNidRegistrationsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OverviewPagesApi();
$nid = 56; // Integer | Event node ID.

try {
    $result = $api_instance->eventNidRegistrationsGet($nid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OverviewPagesApi->eventNidRegistrationsGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OverviewPagesApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OverviewPagesApi->new();
my $nid = 56; # Integer | Event node ID.

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OverviewPagesApi()
nid = 56 # Integer | Event node ID. (default to null)

try:
    # Get registrations for an event.
    api_response = api_instance.event_nid_registrations_get(nid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OverviewPagesApi->eventNidRegistrationsGet: %s\n" % e)
extern crate OverviewPagesApi;

pub fn main() {
    let nid = 56; // Integer

    let mut context = OverviewPagesApi::Context::default();
    let result = client.eventNidRegistrationsGet(nid, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
nid*
Integer
Event node ID.
Required

Responses


eventNidRegistrationsPost

Register current user for an event.

Creates a registration for the authenticated user, optionally including a note.


/event/{nid}/registrations

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://nextworkplace.staging/api/v1/event/{nid}/registrations" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OverviewPagesApi;

import java.io.File;
import java.util.*;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        Integer nid = 56; // Integer | Event node ID.
        EventRegistrationCreateRequest eventRegistrationCreateRequest = ; // EventRegistrationCreateRequest | 

        try {
            Event-Registration-Upsert-Response result = apiInstance.eventNidRegistrationsPost(nid, eventRegistrationCreateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#eventNidRegistrationsPost");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer nid = new Integer(); // Integer | Event node ID.
final EventRegistrationCreateRequest eventRegistrationCreateRequest = new EventRegistrationCreateRequest(); // EventRegistrationCreateRequest | 

try {
    final result = await api_instance.eventNidRegistrationsPost(nid, eventRegistrationCreateRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->eventNidRegistrationsPost: $e\n');
}

import org.openapitools.client.api.OverviewPagesApi;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        Integer nid = 56; // Integer | Event node ID.
        EventRegistrationCreateRequest eventRegistrationCreateRequest = ; // EventRegistrationCreateRequest | 

        try {
            Event-Registration-Upsert-Response result = apiInstance.eventNidRegistrationsPost(nid, eventRegistrationCreateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#eventNidRegistrationsPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
OverviewPagesApi *apiInstance = [[OverviewPagesApi alloc] init];
Integer *nid = 56; // Event node ID. (default to null)
EventRegistrationCreateRequest *eventRegistrationCreateRequest = ; //  (optional)

// Register current user for an event.
[apiInstance eventNidRegistrationsPostWith:nid
    eventRegistrationCreateRequest:eventRegistrationCreateRequest
              completionHandler: ^(Event-Registration-Upsert-Response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.OverviewPagesApi()
var nid = 56; // {Integer} Event node ID.
var opts = {
  'eventRegistrationCreateRequest':  // {EventRegistrationCreateRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.eventNidRegistrationsPost(nid, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class eventNidRegistrationsPostExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OverviewPagesApi();
            var nid = 56;  // Integer | Event node ID. (default to null)
            var eventRegistrationCreateRequest = new EventRegistrationCreateRequest(); // EventRegistrationCreateRequest |  (optional) 

            try {
                // Register current user for an event.
                Event-Registration-Upsert-Response result = apiInstance.eventNidRegistrationsPost(nid, eventRegistrationCreateRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OverviewPagesApi.eventNidRegistrationsPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OverviewPagesApi();
$nid = 56; // Integer | Event node ID.
$eventRegistrationCreateRequest = ; // EventRegistrationCreateRequest | 

try {
    $result = $api_instance->eventNidRegistrationsPost($nid, $eventRegistrationCreateRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OverviewPagesApi->eventNidRegistrationsPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OverviewPagesApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OverviewPagesApi->new();
my $nid = 56; # Integer | Event node ID.
my $eventRegistrationCreateRequest = WWW::OPenAPIClient::Object::EventRegistrationCreateRequest->new(); # EventRegistrationCreateRequest | 

eval {
    my $result = $api_instance->eventNidRegistrationsPost(nid => $nid, eventRegistrationCreateRequest => $eventRegistrationCreateRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OverviewPagesApi->eventNidRegistrationsPost: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OverviewPagesApi()
nid = 56 # Integer | Event node ID. (default to null)
eventRegistrationCreateRequest =  # EventRegistrationCreateRequest |  (optional)

try:
    # Register current user for an event.
    api_response = api_instance.event_nid_registrations_post(nid, eventRegistrationCreateRequest=eventRegistrationCreateRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OverviewPagesApi->eventNidRegistrationsPost: %s\n" % e)
extern crate OverviewPagesApi;

pub fn main() {
    let nid = 56; // Integer
    let eventRegistrationCreateRequest = ; // EventRegistrationCreateRequest

    let mut context = OverviewPagesApi::Context::default();
    let result = client.eventNidRegistrationsPost(nid, eventRegistrationCreateRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
nid*
Integer
Event node ID.
Required
Body parameters
Name Description
eventRegistrationCreateRequest

Responses


eventTypeGet

Get event data by type.

Returns event data based on the `type` path parameter. Supports retrieving events (all or user-specific), event types, event categories, event settings, and calendar events. - **all**: Returns all events grouped by filter (overview, ongoing, upcoming, past). - **my**: Returns events the current user is registered for, grouped by filter. - **event-types**: Returns available event type taxonomy terms. - **event-categories**: Returns available event category taxonomy terms. - **settings**: Returns event module settings including title, description, display configuration, and category colors. - **calendar**: Returns events for a specific month, suitable for a calendar view.


/event/{type}

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/event/{type}?filter=filter_example&event_type=&event_category=&ongoing_offset=56&upcoming_offset=56&past_offset=56&year=56&month=56&bookmarked_only=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OverviewPagesApi;

import java.io.File;
import java.util.*;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        String type = type_example; // String | The type of event data to retrieve.
        String filter = filter_example; // String | Filter events by status. Only applies to `all` and `my` types.
        EventTypeGetEventTypeParameter eventType = ; // EventTypeGetEventTypeParameter | Filter by event type term ID. Pass `all` or omit for no filter. Applies to `all`, `my`, and `calendar` types.
        EventTypeGetEventTypeParameter eventCategory = ; // EventTypeGetEventTypeParameter | Filter by event category term ID. Pass `all` or omit for no filter. Applies to `all`, `my`, and `calendar` types.
        Integer ongoingOffset = 56; // Integer | Pagination offset for ongoing events. Only applies to `all` and `my` types.
        Integer upcomingOffset = 56; // Integer | Pagination offset for upcoming events. Only applies to `all` and `my` types.
        Integer pastOffset = 56; // Integer | Pagination offset for past events. Only applies to `all` and `my` types.
        Integer year = 56; // Integer | The year for calendar view. Required when type is `calendar`. Must be between 2025 and 2100.
        Integer month = 56; // Integer | The month for calendar view. Required when type is `calendar`. Must be between 1 and 12.
        Boolean bookmarkedOnly = true; // Boolean | When `true`, only returns bookmarked events for the current user. Only applies to `calendar` type.

        try {
            _event__type__get_200_response result = apiInstance.eventTypeGet(type, filter, eventType, eventCategory, ongoingOffset, upcomingOffset, pastOffset, year, month, bookmarkedOnly);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#eventTypeGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String type = new String(); // String | The type of event data to retrieve.
final String filter = new String(); // String | Filter events by status. Only applies to `all` and `my` types.
final EventTypeGetEventTypeParameter eventType = new EventTypeGetEventTypeParameter(); // EventTypeGetEventTypeParameter | Filter by event type term ID. Pass `all` or omit for no filter. Applies to `all`, `my`, and `calendar` types.
final EventTypeGetEventTypeParameter eventCategory = new EventTypeGetEventTypeParameter(); // EventTypeGetEventTypeParameter | Filter by event category term ID. Pass `all` or omit for no filter. Applies to `all`, `my`, and `calendar` types.
final Integer ongoingOffset = new Integer(); // Integer | Pagination offset for ongoing events. Only applies to `all` and `my` types.
final Integer upcomingOffset = new Integer(); // Integer | Pagination offset for upcoming events. Only applies to `all` and `my` types.
final Integer pastOffset = new Integer(); // Integer | Pagination offset for past events. Only applies to `all` and `my` types.
final Integer year = new Integer(); // Integer | The year for calendar view. Required when type is `calendar`. Must be between 2025 and 2100.
final Integer month = new Integer(); // Integer | The month for calendar view. Required when type is `calendar`. Must be between 1 and 12.
final Boolean bookmarkedOnly = new Boolean(); // Boolean | When `true`, only returns bookmarked events for the current user. Only applies to `calendar` type.

try {
    final result = await api_instance.eventTypeGet(type, filter, eventType, eventCategory, ongoingOffset, upcomingOffset, pastOffset, year, month, bookmarkedOnly);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->eventTypeGet: $e\n');
}

import org.openapitools.client.api.OverviewPagesApi;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        String type = type_example; // String | The type of event data to retrieve.
        String filter = filter_example; // String | Filter events by status. Only applies to `all` and `my` types.
        EventTypeGetEventTypeParameter eventType = ; // EventTypeGetEventTypeParameter | Filter by event type term ID. Pass `all` or omit for no filter. Applies to `all`, `my`, and `calendar` types.
        EventTypeGetEventTypeParameter eventCategory = ; // EventTypeGetEventTypeParameter | Filter by event category term ID. Pass `all` or omit for no filter. Applies to `all`, `my`, and `calendar` types.
        Integer ongoingOffset = 56; // Integer | Pagination offset for ongoing events. Only applies to `all` and `my` types.
        Integer upcomingOffset = 56; // Integer | Pagination offset for upcoming events. Only applies to `all` and `my` types.
        Integer pastOffset = 56; // Integer | Pagination offset for past events. Only applies to `all` and `my` types.
        Integer year = 56; // Integer | The year for calendar view. Required when type is `calendar`. Must be between 2025 and 2100.
        Integer month = 56; // Integer | The month for calendar view. Required when type is `calendar`. Must be between 1 and 12.
        Boolean bookmarkedOnly = true; // Boolean | When `true`, only returns bookmarked events for the current user. Only applies to `calendar` type.

        try {
            _event__type__get_200_response result = apiInstance.eventTypeGet(type, filter, eventType, eventCategory, ongoingOffset, upcomingOffset, pastOffset, year, month, bookmarkedOnly);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#eventTypeGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
OverviewPagesApi *apiInstance = [[OverviewPagesApi alloc] init];
String *type = type_example; // The type of event data to retrieve. (default to null)
String *filter = filter_example; // Filter events by status. Only applies to `all` and `my` types. (optional) (default to overview)
EventTypeGetEventTypeParameter *eventType = ; // Filter by event type term ID. Pass `all` or omit for no filter. Applies to `all`, `my`, and `calendar` types. (optional) (default to null)
EventTypeGetEventTypeParameter *eventCategory = ; // Filter by event category term ID. Pass `all` or omit for no filter. Applies to `all`, `my`, and `calendar` types. (optional) (default to null)
Integer *ongoingOffset = 56; // Pagination offset for ongoing events. Only applies to `all` and `my` types. (optional) (default to 0)
Integer *upcomingOffset = 56; // Pagination offset for upcoming events. Only applies to `all` and `my` types. (optional) (default to 0)
Integer *pastOffset = 56; // Pagination offset for past events. Only applies to `all` and `my` types. (optional) (default to 0)
Integer *year = 56; // The year for calendar view. Required when type is `calendar`. Must be between 2025 and 2100. (optional) (default to null)
Integer *month = 56; // The month for calendar view. Required when type is `calendar`. Must be between 1 and 12. (optional) (default to null)
Boolean *bookmarkedOnly = true; // When `true`, only returns bookmarked events for the current user. Only applies to `calendar` type. (optional) (default to false)

// Get event data by type.
[apiInstance eventTypeGetWith:type
    filter:filter
    eventType:eventType
    eventCategory:eventCategory
    ongoingOffset:ongoingOffset
    upcomingOffset:upcomingOffset
    pastOffset:pastOffset
    year:year
    month:month
    bookmarkedOnly:bookmarkedOnly
              completionHandler: ^(_event__type__get_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.OverviewPagesApi()
var type = type_example; // {String} The type of event data to retrieve.
var opts = {
  'filter': filter_example, // {String} Filter events by status. Only applies to `all` and `my` types.
  'eventType': , // {EventTypeGetEventTypeParameter} Filter by event type term ID. Pass `all` or omit for no filter. Applies to `all`, `my`, and `calendar` types.
  'eventCategory': , // {EventTypeGetEventTypeParameter} Filter by event category term ID. Pass `all` or omit for no filter. Applies to `all`, `my`, and `calendar` types.
  'ongoingOffset': 56, // {Integer} Pagination offset for ongoing events. Only applies to `all` and `my` types.
  'upcomingOffset': 56, // {Integer} Pagination offset for upcoming events. Only applies to `all` and `my` types.
  'pastOffset': 56, // {Integer} Pagination offset for past events. Only applies to `all` and `my` types.
  'year': 56, // {Integer} The year for calendar view. Required when type is `calendar`. Must be between 2025 and 2100.
  'month': 56, // {Integer} The month for calendar view. Required when type is `calendar`. Must be between 1 and 12.
  'bookmarkedOnly': true // {Boolean} When `true`, only returns bookmarked events for the current user. Only applies to `calendar` type.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.eventTypeGet(type, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class eventTypeGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OverviewPagesApi();
            var type = type_example;  // String | The type of event data to retrieve. (default to null)
            var filter = filter_example;  // String | Filter events by status. Only applies to `all` and `my` types. (optional)  (default to overview)
            var eventType = new EventTypeGetEventTypeParameter(); // EventTypeGetEventTypeParameter | Filter by event type term ID. Pass `all` or omit for no filter. Applies to `all`, `my`, and `calendar` types. (optional)  (default to null)
            var eventCategory = new EventTypeGetEventTypeParameter(); // EventTypeGetEventTypeParameter | Filter by event category term ID. Pass `all` or omit for no filter. Applies to `all`, `my`, and `calendar` types. (optional)  (default to null)
            var ongoingOffset = 56;  // Integer | Pagination offset for ongoing events. Only applies to `all` and `my` types. (optional)  (default to 0)
            var upcomingOffset = 56;  // Integer | Pagination offset for upcoming events. Only applies to `all` and `my` types. (optional)  (default to 0)
            var pastOffset = 56;  // Integer | Pagination offset for past events. Only applies to `all` and `my` types. (optional)  (default to 0)
            var year = 56;  // Integer | The year for calendar view. Required when type is `calendar`. Must be between 2025 and 2100. (optional)  (default to null)
            var month = 56;  // Integer | The month for calendar view. Required when type is `calendar`. Must be between 1 and 12. (optional)  (default to null)
            var bookmarkedOnly = true;  // Boolean | When `true`, only returns bookmarked events for the current user. Only applies to `calendar` type. (optional)  (default to false)

            try {
                // Get event data by type.
                _event__type__get_200_response result = apiInstance.eventTypeGet(type, filter, eventType, eventCategory, ongoingOffset, upcomingOffset, pastOffset, year, month, bookmarkedOnly);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OverviewPagesApi.eventTypeGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OverviewPagesApi();
$type = type_example; // String | The type of event data to retrieve.
$filter = filter_example; // String | Filter events by status. Only applies to `all` and `my` types.
$eventType = ; // EventTypeGetEventTypeParameter | Filter by event type term ID. Pass `all` or omit for no filter. Applies to `all`, `my`, and `calendar` types.
$eventCategory = ; // EventTypeGetEventTypeParameter | Filter by event category term ID. Pass `all` or omit for no filter. Applies to `all`, `my`, and `calendar` types.
$ongoingOffset = 56; // Integer | Pagination offset for ongoing events. Only applies to `all` and `my` types.
$upcomingOffset = 56; // Integer | Pagination offset for upcoming events. Only applies to `all` and `my` types.
$pastOffset = 56; // Integer | Pagination offset for past events. Only applies to `all` and `my` types.
$year = 56; // Integer | The year for calendar view. Required when type is `calendar`. Must be between 2025 and 2100.
$month = 56; // Integer | The month for calendar view. Required when type is `calendar`. Must be between 1 and 12.
$bookmarkedOnly = true; // Boolean | When `true`, only returns bookmarked events for the current user. Only applies to `calendar` type.

try {
    $result = $api_instance->eventTypeGet($type, $filter, $eventType, $eventCategory, $ongoingOffset, $upcomingOffset, $pastOffset, $year, $month, $bookmarkedOnly);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OverviewPagesApi->eventTypeGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OverviewPagesApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OverviewPagesApi->new();
my $type = type_example; # String | The type of event data to retrieve.
my $filter = filter_example; # String | Filter events by status. Only applies to `all` and `my` types.
my $eventType = ; # EventTypeGetEventTypeParameter | Filter by event type term ID. Pass `all` or omit for no filter. Applies to `all`, `my`, and `calendar` types.
my $eventCategory = ; # EventTypeGetEventTypeParameter | Filter by event category term ID. Pass `all` or omit for no filter. Applies to `all`, `my`, and `calendar` types.
my $ongoingOffset = 56; # Integer | Pagination offset for ongoing events. Only applies to `all` and `my` types.
my $upcomingOffset = 56; # Integer | Pagination offset for upcoming events. Only applies to `all` and `my` types.
my $pastOffset = 56; # Integer | Pagination offset for past events. Only applies to `all` and `my` types.
my $year = 56; # Integer | The year for calendar view. Required when type is `calendar`. Must be between 2025 and 2100.
my $month = 56; # Integer | The month for calendar view. Required when type is `calendar`. Must be between 1 and 12.
my $bookmarkedOnly = true; # Boolean | When `true`, only returns bookmarked events for the current user. Only applies to `calendar` type.

eval {
    my $result = $api_instance->eventTypeGet(type => $type, filter => $filter, eventType => $eventType, eventCategory => $eventCategory, ongoingOffset => $ongoingOffset, upcomingOffset => $upcomingOffset, pastOffset => $pastOffset, year => $year, month => $month, bookmarkedOnly => $bookmarkedOnly);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OverviewPagesApi->eventTypeGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OverviewPagesApi()
type = type_example # String | The type of event data to retrieve. (default to null)
filter = filter_example # String | Filter events by status. Only applies to `all` and `my` types. (optional) (default to overview)
eventType =  # EventTypeGetEventTypeParameter | Filter by event type term ID. Pass `all` or omit for no filter. Applies to `all`, `my`, and `calendar` types. (optional) (default to null)
eventCategory =  # EventTypeGetEventTypeParameter | Filter by event category term ID. Pass `all` or omit for no filter. Applies to `all`, `my`, and `calendar` types. (optional) (default to null)
ongoingOffset = 56 # Integer | Pagination offset for ongoing events. Only applies to `all` and `my` types. (optional) (default to 0)
upcomingOffset = 56 # Integer | Pagination offset for upcoming events. Only applies to `all` and `my` types. (optional) (default to 0)
pastOffset = 56 # Integer | Pagination offset for past events. Only applies to `all` and `my` types. (optional) (default to 0)
year = 56 # Integer | The year for calendar view. Required when type is `calendar`. Must be between 2025 and 2100. (optional) (default to null)
month = 56 # Integer | The month for calendar view. Required when type is `calendar`. Must be between 1 and 12. (optional) (default to null)
bookmarkedOnly = true # Boolean | When `true`, only returns bookmarked events for the current user. Only applies to `calendar` type. (optional) (default to false)

try:
    # Get event data by type.
    api_response = api_instance.event_type_get(type, filter=filter, eventType=eventType, eventCategory=eventCategory, ongoingOffset=ongoingOffset, upcomingOffset=upcomingOffset, pastOffset=pastOffset, year=year, month=month, bookmarkedOnly=bookmarkedOnly)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OverviewPagesApi->eventTypeGet: %s\n" % e)
extern crate OverviewPagesApi;

pub fn main() {
    let type = type_example; // String
    let filter = filter_example; // String
    let eventType = ; // EventTypeGetEventTypeParameter
    let eventCategory = ; // EventTypeGetEventTypeParameter
    let ongoingOffset = 56; // Integer
    let upcomingOffset = 56; // Integer
    let pastOffset = 56; // Integer
    let year = 56; // Integer
    let month = 56; // Integer
    let bookmarkedOnly = true; // Boolean

    let mut context = OverviewPagesApi::Context::default();
    let result = client.eventTypeGet(type, filter, eventType, eventCategory, ongoingOffset, upcomingOffset, pastOffset, year, month, bookmarkedOnly, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
type*
String
The type of event data to retrieve.
Required
Query parameters
Name Description
filter
String
Filter events by status. Only applies to `all` and `my` types.
event_type
EventTypeGetEventTypeParameter
Filter by event type term ID. Pass `all` or omit for no filter. Applies to `all`, `my`, and `calendar` types.
event_category
EventTypeGetEventTypeParameter
Filter by event category term ID. Pass `all` or omit for no filter. Applies to `all`, `my`, and `calendar` types.
ongoing_offset
Integer
Pagination offset for ongoing events. Only applies to `all` and `my` types.
upcoming_offset
Integer
Pagination offset for upcoming events. Only applies to `all` and `my` types.
past_offset
Integer
Pagination offset for past events. Only applies to `all` and `my` types.
year
Integer
The year for calendar view. Required when type is `calendar`. Must be between 2025 and 2100.
month
Integer
The month for calendar view. Required when type is `calendar`. Must be between 1 and 12.
bookmarked_only
Boolean
When `true`, only returns bookmarked events for the current user. Only applies to `calendar` type.

Responses


eventsGet

Get a events page content.

Sends current and upcoming events.


/events

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/events?page=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OverviewPagesApi;

import java.io.File;
import java.util.*;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        Integer page = 56; // Integer | News page name.

        try {
            Events-Page result = apiInstance.eventsGet(page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#eventsGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer page = new Integer(); // Integer | News page name.

try {
    final result = await api_instance.eventsGet(page);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->eventsGet: $e\n');
}

import org.openapitools.client.api.OverviewPagesApi;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        Integer page = 56; // Integer | News page name.

        try {
            Events-Page result = apiInstance.eventsGet(page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#eventsGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
OverviewPagesApi *apiInstance = [[OverviewPagesApi alloc] init];
Integer *page = 56; // News page name. (optional) (default to null)

// Get a events page content.
[apiInstance eventsGetWith:page
              completionHandler: ^(Events-Page output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.OverviewPagesApi()
var opts = {
  'page': 56 // {Integer} News page name.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.eventsGet(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class eventsGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OverviewPagesApi();
            var page = 56;  // Integer | News page name. (optional)  (default to null)

            try {
                // Get a events page content.
                Events-Page result = apiInstance.eventsGet(page);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OverviewPagesApi.eventsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OverviewPagesApi();
$page = 56; // Integer | News page name.

try {
    $result = $api_instance->eventsGet($page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OverviewPagesApi->eventsGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OverviewPagesApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OverviewPagesApi->new();
my $page = 56; # Integer | News page name.

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OverviewPagesApi()
page = 56 # Integer | News page name. (optional) (default to null)

try:
    # Get a events page content.
    api_response = api_instance.events_get(page=page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OverviewPagesApi->eventsGet: %s\n" % e)
extern crate OverviewPagesApi;

pub fn main() {
    let page = 56; // Integer

    let mut context = OverviewPagesApi::Context::default();
    let result = client.eventsGet(page, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
page
Integer
News page name.

Responses


magazineTopicTopicGet

Get a topic overview page content.

Displays a list of content that are related to one of the magazine topics.


/magazine_topic/{topic}

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/magazine_topic/{topic}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OverviewPagesApi;

import java.io.File;
import java.util.*;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        String topic = topic_1; // String | Topic name.

        try {
            _magazine_topic__topic__get_200_response result = apiInstance.magazineTopicTopicGet(topic);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#magazineTopicTopicGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String topic = new String(); // String | Topic name.

try {
    final result = await api_instance.magazineTopicTopicGet(topic);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->magazineTopicTopicGet: $e\n');
}

import org.openapitools.client.api.OverviewPagesApi;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        String topic = topic_1; // String | Topic name.

        try {
            _magazine_topic__topic__get_200_response result = apiInstance.magazineTopicTopicGet(topic);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#magazineTopicTopicGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
OverviewPagesApi *apiInstance = [[OverviewPagesApi alloc] init];
String *topic = topic_1; // Topic name. (default to null)

// Get a topic overview page content.
[apiInstance magazineTopicTopicGetWith:topic
              completionHandler: ^(_magazine_topic__topic__get_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.OverviewPagesApi()
var topic = topic_1; // {String} Topic name.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.magazineTopicTopicGet(topic, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class magazineTopicTopicGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OverviewPagesApi();
            var topic = topic_1;  // String | Topic name. (default to null)

            try {
                // Get a topic overview page content.
                _magazine_topic__topic__get_200_response result = apiInstance.magazineTopicTopicGet(topic);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OverviewPagesApi.magazineTopicTopicGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OverviewPagesApi();
$topic = topic_1; // String | Topic name.

try {
    $result = $api_instance->magazineTopicTopicGet($topic);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OverviewPagesApi->magazineTopicTopicGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OverviewPagesApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OverviewPagesApi->new();
my $topic = topic_1; # String | Topic name.

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OverviewPagesApi()
topic = topic_1 # String | Topic name. (default to null)

try:
    # Get a topic overview page content.
    api_response = api_instance.magazine_topic_topic_get(topic)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OverviewPagesApi->magazineTopicTopicGet: %s\n" % e)
extern crate OverviewPagesApi;

pub fn main() {
    let topic = topic_1; // String

    let mut context = OverviewPagesApi::Context::default();
    let result = client.magazineTopicTopicGet(topic, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
topic*
String
Topic name.
Required

Responses


newColleaguesGet

Get new colleagues overview page content.

Get a list of new colleagues.


/new_colleagues

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/new_colleagues?page=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OverviewPagesApi;

import java.io.File;
import java.util.*;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        Integer page = 56; // Integer | Pager for the content.

        try {
            _new_colleagues_get_200_response result = apiInstance.newColleaguesGet(page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#newColleaguesGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer page = new Integer(); // Integer | Pager for the content.

try {
    final result = await api_instance.newColleaguesGet(page);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->newColleaguesGet: $e\n');
}

import org.openapitools.client.api.OverviewPagesApi;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        Integer page = 56; // Integer | Pager for the content.

        try {
            _new_colleagues_get_200_response result = apiInstance.newColleaguesGet(page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#newColleaguesGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
OverviewPagesApi *apiInstance = [[OverviewPagesApi alloc] init];
Integer *page = 56; // Pager for the content. (optional) (default to null)

// Get new colleagues overview page content.
[apiInstance newColleaguesGetWith:page
              completionHandler: ^(_new_colleagues_get_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.OverviewPagesApi()
var opts = {
  'page': 56 // {Integer} Pager for the content.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.newColleaguesGet(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class newColleaguesGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OverviewPagesApi();
            var page = 56;  // Integer | Pager for the content. (optional)  (default to null)

            try {
                // Get new colleagues overview page content.
                _new_colleagues_get_200_response result = apiInstance.newColleaguesGet(page);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OverviewPagesApi.newColleaguesGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OverviewPagesApi();
$page = 56; // Integer | Pager for the content.

try {
    $result = $api_instance->newColleaguesGet($page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OverviewPagesApi->newColleaguesGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OverviewPagesApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OverviewPagesApi->new();
my $page = 56; # Integer | Pager for the content.

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OverviewPagesApi()
page = 56 # Integer | Pager for the content. (optional) (default to null)

try:
    # Get new colleagues overview page content.
    api_response = api_instance.new_colleagues_get(page=page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OverviewPagesApi->newColleaguesGet: %s\n" % e)
extern crate OverviewPagesApi;

pub fn main() {
    let page = 56; // Integer

    let mut context = OverviewPagesApi::Context::default();
    let result = client.newColleaguesGet(page, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
page
Integer
Pager for the content.

Responses


newsMenuGet

Get news menu.

There are 4 standard news pages&#58; [news, corporate_news, my_news, mandatory_news].


/news_menu

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/news_menu"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OverviewPagesApi;

import java.io.File;
import java.util.*;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        OverviewPagesApi apiInstance = new OverviewPagesApi();

        try {
            array[News-Menu-Item] result = apiInstance.newsMenuGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#newsMenuGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.newsMenuGet();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->newsMenuGet: $e\n');
}

import org.openapitools.client.api.OverviewPagesApi;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        OverviewPagesApi apiInstance = new OverviewPagesApi();

        try {
            array[News-Menu-Item] result = apiInstance.newsMenuGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#newsMenuGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
OverviewPagesApi *apiInstance = [[OverviewPagesApi alloc] init];

// Get news menu.
[apiInstance newsMenuGetWithCompletionHandler: 
              ^(array[News-Menu-Item] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.OverviewPagesApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.newsMenuGet(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class newsMenuGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OverviewPagesApi();

            try {
                // Get news menu.
                array[News-Menu-Item] result = apiInstance.newsMenuGet();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OverviewPagesApi.newsMenuGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OverviewPagesApi();

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OverviewPagesApi->new();

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OverviewPagesApi()

try:
    # Get news menu.
    api_response = api_instance.news_menu_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OverviewPagesApi->newsMenuGet: %s\n" % e)
extern crate OverviewPagesApi;

pub fn main() {

    let mut context = OverviewPagesApi::Context::default();
    let result = client.newsMenuGet(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


newsNewsPageGet

Get a news page content.

There are 4 standard news pages&#58; [news, corporate_news, my_news, mandatory_news].


/news/{news_page}

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/news/{news_page}?news_channel=56&page=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OverviewPagesApi;

import java.io.File;
import java.util.*;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        String newsPage = corporate_news; // String | News page name.
        Integer newsChannel = 56; // Integer | Filter the news channel based on the news channel identifier.
        Integer page = 56; // Integer | Pager for the content.

        try {
            News-Page result = apiInstance.newsNewsPageGet(newsPage, newsChannel, page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#newsNewsPageGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String newsPage = new String(); // String | News page name.
final Integer newsChannel = new Integer(); // Integer | Filter the news channel based on the news channel identifier.
final Integer page = new Integer(); // Integer | Pager for the content.

try {
    final result = await api_instance.newsNewsPageGet(newsPage, newsChannel, page);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->newsNewsPageGet: $e\n');
}

import org.openapitools.client.api.OverviewPagesApi;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        String newsPage = corporate_news; // String | News page name.
        Integer newsChannel = 56; // Integer | Filter the news channel based on the news channel identifier.
        Integer page = 56; // Integer | Pager for the content.

        try {
            News-Page result = apiInstance.newsNewsPageGet(newsPage, newsChannel, page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#newsNewsPageGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
OverviewPagesApi *apiInstance = [[OverviewPagesApi alloc] init];
String *newsPage = corporate_news; // News page name. (default to null)
Integer *newsChannel = 56; // Filter the news channel based on the news channel identifier. (optional) (default to null)
Integer *page = 56; // Pager for the content. (optional) (default to null)

// Get a news page content.
[apiInstance newsNewsPageGetWith:newsPage
    newsChannel:newsChannel
    page:page
              completionHandler: ^(News-Page output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.OverviewPagesApi()
var newsPage = corporate_news; // {String} News page name.
var opts = {
  'newsChannel': 56, // {Integer} Filter the news channel based on the news channel identifier.
  'page': 56 // {Integer} Pager for the content.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.newsNewsPageGet(newsPage, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class newsNewsPageGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OverviewPagesApi();
            var newsPage = corporate_news;  // String | News page name. (default to null)
            var newsChannel = 56;  // Integer | Filter the news channel based on the news channel identifier. (optional)  (default to null)
            var page = 56;  // Integer | Pager for the content. (optional)  (default to null)

            try {
                // Get a news page content.
                News-Page result = apiInstance.newsNewsPageGet(newsPage, newsChannel, page);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OverviewPagesApi.newsNewsPageGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OverviewPagesApi();
$newsPage = corporate_news; // String | News page name.
$newsChannel = 56; // Integer | Filter the news channel based on the news channel identifier.
$page = 56; // Integer | Pager for the content.

try {
    $result = $api_instance->newsNewsPageGet($newsPage, $newsChannel, $page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OverviewPagesApi->newsNewsPageGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OverviewPagesApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OverviewPagesApi->new();
my $newsPage = corporate_news; # String | News page name.
my $newsChannel = 56; # Integer | Filter the news channel based on the news channel identifier.
my $page = 56; # Integer | Pager for the content.

eval {
    my $result = $api_instance->newsNewsPageGet(newsPage => $newsPage, newsChannel => $newsChannel, page => $page);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OverviewPagesApi->newsNewsPageGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OverviewPagesApi()
newsPage = corporate_news # String | News page name. (default to null)
newsChannel = 56 # Integer | Filter the news channel based on the news channel identifier. (optional) (default to null)
page = 56 # Integer | Pager for the content. (optional) (default to null)

try:
    # Get a news page content.
    api_response = api_instance.news_news_page_get(newsPage, newsChannel=newsChannel, page=page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OverviewPagesApi->newsNewsPageGet: %s\n" % e)
extern crate OverviewPagesApi;

pub fn main() {
    let newsPage = corporate_news; // String
    let newsChannel = 56; // Integer
    let page = 56; // Integer

    let mut context = OverviewPagesApi::Context::default();
    let result = client.newsNewsPageGet(newsPage, newsChannel, page, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
news_page*
String
News page name.
Required
Query parameters
Name Description
news_channel
Integer
Filter the news channel based on the news channel identifier.
page
Integer
Pager for the content.

Responses


piipePictureGalleryGet

Get picture gallery posts

Returns a paginated list of picture gallery posts.


/piipe_picture_gallery

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/piipe_picture_gallery?page=0&filters[tags]=496,498&filters[author]=1&sort_by=created&sort_dir=DESC"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OverviewPagesApi;

import java.io.File;
import java.util.*;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        Integer page = 0; // Integer | The page number for pagination (0-based).
        String filtersLeft_Square_BrackettagsRight_Square_Bracket = 496,498; // String | Filter posts by tag IDs (comma-separated).
        Integer filtersLeft_Square_BracketauthorRight_Square_Bracket = 1; // Integer | Filter posts by author user ID.
        String sortBy = created; // String | Sort posts by field. Allowed values: created, popularity.
        String sortDir = DESC; // String | Sort direction. Allowed values: ASC, DESC.

        try {
            array[Picture-Gallery-Post] result = apiInstance.piipePictureGalleryGet(page, filtersLeft_Square_BrackettagsRight_Square_Bracket, filtersLeft_Square_BracketauthorRight_Square_Bracket, sortBy, sortDir);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#piipePictureGalleryGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer page = new Integer(); // Integer | The page number for pagination (0-based).
final String filtersLeft_Square_BrackettagsRight_Square_Bracket = new String(); // String | Filter posts by tag IDs (comma-separated).
final Integer filtersLeft_Square_BracketauthorRight_Square_Bracket = new Integer(); // Integer | Filter posts by author user ID.
final String sortBy = new String(); // String | Sort posts by field. Allowed values: created, popularity.
final String sortDir = new String(); // String | Sort direction. Allowed values: ASC, DESC.

try {
    final result = await api_instance.piipePictureGalleryGet(page, filtersLeft_Square_BrackettagsRight_Square_Bracket, filtersLeft_Square_BracketauthorRight_Square_Bracket, sortBy, sortDir);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->piipePictureGalleryGet: $e\n');
}

import org.openapitools.client.api.OverviewPagesApi;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        Integer page = 0; // Integer | The page number for pagination (0-based).
        String filtersLeft_Square_BrackettagsRight_Square_Bracket = 496,498; // String | Filter posts by tag IDs (comma-separated).
        Integer filtersLeft_Square_BracketauthorRight_Square_Bracket = 1; // Integer | Filter posts by author user ID.
        String sortBy = created; // String | Sort posts by field. Allowed values: created, popularity.
        String sortDir = DESC; // String | Sort direction. Allowed values: ASC, DESC.

        try {
            array[Picture-Gallery-Post] result = apiInstance.piipePictureGalleryGet(page, filtersLeft_Square_BrackettagsRight_Square_Bracket, filtersLeft_Square_BracketauthorRight_Square_Bracket, sortBy, sortDir);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#piipePictureGalleryGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
OverviewPagesApi *apiInstance = [[OverviewPagesApi alloc] init];
Integer *page = 0; // The page number for pagination (0-based). (optional) (default to null)
String *filtersLeft_Square_BrackettagsRight_Square_Bracket = 496,498; // Filter posts by tag IDs (comma-separated). (optional) (default to null)
Integer *filtersLeft_Square_BracketauthorRight_Square_Bracket = 1; // Filter posts by author user ID. (optional) (default to null)
String *sortBy = created; // Sort posts by field. Allowed values: created, popularity. (optional) (default to null)
String *sortDir = DESC; // Sort direction. Allowed values: ASC, DESC. (optional) (default to null)

// Get picture gallery posts
[apiInstance piipePictureGalleryGetWith:page
    filtersLeft_Square_BrackettagsRight_Square_Bracket:filtersLeft_Square_BrackettagsRight_Square_Bracket
    filtersLeft_Square_BracketauthorRight_Square_Bracket:filtersLeft_Square_BracketauthorRight_Square_Bracket
    sortBy:sortBy
    sortDir:sortDir
              completionHandler: ^(array[Picture-Gallery-Post] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.OverviewPagesApi()
var opts = {
  'page': 0, // {Integer} The page number for pagination (0-based).
  'filtersLeft_Square_BrackettagsRight_Square_Bracket': 496,498, // {String} Filter posts by tag IDs (comma-separated).
  'filtersLeft_Square_BracketauthorRight_Square_Bracket': 1, // {Integer} Filter posts by author user ID.
  'sortBy': created, // {String} Sort posts by field. Allowed values: created, popularity.
  'sortDir': DESC // {String} Sort direction. Allowed values: ASC, DESC.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.piipePictureGalleryGet(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class piipePictureGalleryGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OverviewPagesApi();
            var page = 0;  // Integer | The page number for pagination (0-based). (optional)  (default to null)
            var filtersLeft_Square_BrackettagsRight_Square_Bracket = 496,498;  // String | Filter posts by tag IDs (comma-separated). (optional)  (default to null)
            var filtersLeft_Square_BracketauthorRight_Square_Bracket = 1;  // Integer | Filter posts by author user ID. (optional)  (default to null)
            var sortBy = created;  // String | Sort posts by field. Allowed values: created, popularity. (optional)  (default to null)
            var sortDir = DESC;  // String | Sort direction. Allowed values: ASC, DESC. (optional)  (default to null)

            try {
                // Get picture gallery posts
                array[Picture-Gallery-Post] result = apiInstance.piipePictureGalleryGet(page, filtersLeft_Square_BrackettagsRight_Square_Bracket, filtersLeft_Square_BracketauthorRight_Square_Bracket, sortBy, sortDir);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OverviewPagesApi.piipePictureGalleryGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OverviewPagesApi();
$page = 0; // Integer | The page number for pagination (0-based).
$filtersLeft_Square_BrackettagsRight_Square_Bracket = 496,498; // String | Filter posts by tag IDs (comma-separated).
$filtersLeft_Square_BracketauthorRight_Square_Bracket = 1; // Integer | Filter posts by author user ID.
$sortBy = created; // String | Sort posts by field. Allowed values: created, popularity.
$sortDir = DESC; // String | Sort direction. Allowed values: ASC, DESC.

try {
    $result = $api_instance->piipePictureGalleryGet($page, $filtersLeft_Square_BrackettagsRight_Square_Bracket, $filtersLeft_Square_BracketauthorRight_Square_Bracket, $sortBy, $sortDir);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OverviewPagesApi->piipePictureGalleryGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OverviewPagesApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OverviewPagesApi->new();
my $page = 0; # Integer | The page number for pagination (0-based).
my $filtersLeft_Square_BrackettagsRight_Square_Bracket = 496,498; # String | Filter posts by tag IDs (comma-separated).
my $filtersLeft_Square_BracketauthorRight_Square_Bracket = 1; # Integer | Filter posts by author user ID.
my $sortBy = created; # String | Sort posts by field. Allowed values: created, popularity.
my $sortDir = DESC; # String | Sort direction. Allowed values: ASC, DESC.

eval {
    my $result = $api_instance->piipePictureGalleryGet(page => $page, filtersLeft_Square_BrackettagsRight_Square_Bracket => $filtersLeft_Square_BrackettagsRight_Square_Bracket, filtersLeft_Square_BracketauthorRight_Square_Bracket => $filtersLeft_Square_BracketauthorRight_Square_Bracket, sortBy => $sortBy, sortDir => $sortDir);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OverviewPagesApi->piipePictureGalleryGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OverviewPagesApi()
page = 0 # Integer | The page number for pagination (0-based). (optional) (default to null)
filtersLeft_Square_BrackettagsRight_Square_Bracket = 496,498 # String | Filter posts by tag IDs (comma-separated). (optional) (default to null)
filtersLeft_Square_BracketauthorRight_Square_Bracket = 1 # Integer | Filter posts by author user ID. (optional) (default to null)
sortBy = created # String | Sort posts by field. Allowed values: created, popularity. (optional) (default to null)
sortDir = DESC # String | Sort direction. Allowed values: ASC, DESC. (optional) (default to null)

try:
    # Get picture gallery posts
    api_response = api_instance.piipe_picture_gallery_get(page=page, filtersLeft_Square_BrackettagsRight_Square_Bracket=filtersLeft_Square_BrackettagsRight_Square_Bracket, filtersLeft_Square_BracketauthorRight_Square_Bracket=filtersLeft_Square_BracketauthorRight_Square_Bracket, sortBy=sortBy, sortDir=sortDir)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OverviewPagesApi->piipePictureGalleryGet: %s\n" % e)
extern crate OverviewPagesApi;

pub fn main() {
    let page = 0; // Integer
    let filtersLeft_Square_BrackettagsRight_Square_Bracket = 496,498; // String
    let filtersLeft_Square_BracketauthorRight_Square_Bracket = 1; // Integer
    let sortBy = created; // String
    let sortDir = DESC; // String

    let mut context = OverviewPagesApi::Context::default();
    let result = client.piipePictureGalleryGet(page, filtersLeft_Square_BrackettagsRight_Square_Bracket, filtersLeft_Square_BracketauthorRight_Square_Bracket, sortBy, sortDir, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
page
Integer
The page number for pagination (0-based).
filters[tags]
String
Filter posts by tag IDs (comma-separated).
filters[author]
Integer
Filter posts by author user ID.
sort_by
String
Sort posts by field. Allowed values: created, popularity.
sort_dir
String
Sort direction. Allowed values: ASC, DESC.

Responses


piipePictureGalleryPatch

Edit or delete a gallery post

To flag a gallery post, make a POST request to ```/piipe_flags/flag``` and pass the following parameters to the body: ```json { "flag_id": "gallery_post_FLAG", "entity_type": "gallery_post", "entity_id": "ID", "action": "flag" } ``` where ```FLAG``` is one of [like, rock, heart] and ```ID``` is the gallery post ID.


/piipe_picture_gallery

Usage and SDK Samples

curl -X PATCH \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://nextworkplace.staging/api/v1/piipe_picture_gallery" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OverviewPagesApi;

import java.io.File;
import java.util.*;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        PiipePictureGalleryPatchRequest piipePictureGalleryPatchRequest = ; // PiipePictureGalleryPatchRequest | 

        try {
            _piipe_picture_gallery_patch_200_response result = apiInstance.piipePictureGalleryPatch(piipePictureGalleryPatchRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#piipePictureGalleryPatch");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final PiipePictureGalleryPatchRequest piipePictureGalleryPatchRequest = new PiipePictureGalleryPatchRequest(); // PiipePictureGalleryPatchRequest | 

try {
    final result = await api_instance.piipePictureGalleryPatch(piipePictureGalleryPatchRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->piipePictureGalleryPatch: $e\n');
}

import org.openapitools.client.api.OverviewPagesApi;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        PiipePictureGalleryPatchRequest piipePictureGalleryPatchRequest = ; // PiipePictureGalleryPatchRequest | 

        try {
            _piipe_picture_gallery_patch_200_response result = apiInstance.piipePictureGalleryPatch(piipePictureGalleryPatchRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#piipePictureGalleryPatch");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
OverviewPagesApi *apiInstance = [[OverviewPagesApi alloc] init];
PiipePictureGalleryPatchRequest *piipePictureGalleryPatchRequest = ; // 

// Edit or delete a gallery post
[apiInstance piipePictureGalleryPatchWith:piipePictureGalleryPatchRequest
              completionHandler: ^(_piipe_picture_gallery_patch_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.OverviewPagesApi()
var piipePictureGalleryPatchRequest = ; // {PiipePictureGalleryPatchRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.piipePictureGalleryPatch(piipePictureGalleryPatchRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class piipePictureGalleryPatchExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OverviewPagesApi();
            var piipePictureGalleryPatchRequest = new PiipePictureGalleryPatchRequest(); // PiipePictureGalleryPatchRequest | 

            try {
                // Edit or delete a gallery post
                _piipe_picture_gallery_patch_200_response result = apiInstance.piipePictureGalleryPatch(piipePictureGalleryPatchRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OverviewPagesApi.piipePictureGalleryPatch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OverviewPagesApi();
$piipePictureGalleryPatchRequest = ; // PiipePictureGalleryPatchRequest | 

try {
    $result = $api_instance->piipePictureGalleryPatch($piipePictureGalleryPatchRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OverviewPagesApi->piipePictureGalleryPatch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OverviewPagesApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OverviewPagesApi->new();
my $piipePictureGalleryPatchRequest = WWW::OPenAPIClient::Object::PiipePictureGalleryPatchRequest->new(); # PiipePictureGalleryPatchRequest | 

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OverviewPagesApi()
piipePictureGalleryPatchRequest =  # PiipePictureGalleryPatchRequest | 

try:
    # Edit or delete a gallery post
    api_response = api_instance.piipe_picture_gallery_patch(piipePictureGalleryPatchRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OverviewPagesApi->piipePictureGalleryPatch: %s\n" % e)
extern crate OverviewPagesApi;

pub fn main() {
    let piipePictureGalleryPatchRequest = ; // PiipePictureGalleryPatchRequest

    let mut context = OverviewPagesApi::Context::default();
    let result = client.piipePictureGalleryPatch(piipePictureGalleryPatchRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
piipePictureGalleryPatchRequest *

Responses


roomSearchGet

Room Search site content.


/room_search

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/room_search?search_api_fulltext=neocosmo&f=f[0]=type:user"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OverviewPagesApi;

import java.io.File;
import java.util.*;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        String searchApiFulltext = neocosmo; // String | The search term. If an empty string is provided or the query parameter is not added to the request, the whole website content will be seen as valid search results.
        String f = f[0]=type:user; // String | Facets filters. When facets should be used to filter the search results, they have to be added as array items of this query parameter: a facet will filter should have the form **f[INDEX]=FACET_ID:VALUE** where **INDEX** is an index number for the filters array (starting from zero). For example, to search users that live in Berlin (ID = 45), the facets "type" and "location" have to be added to the array in the following manner: **/search?f[0]=type:user&f[1]=location:45**. The order of filters in the array has no effect.

        try {
            RoomSearch result = apiInstance.roomSearchGet(searchApiFulltext, f);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#roomSearchGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String searchApiFulltext = new String(); // String | The search term. If an empty string is provided or the query parameter is not added to the request, the whole website content will be seen as valid search results.
final String f = new String(); // String | Facets filters. When facets should be used to filter the search results, they have to be added as array items of this query parameter: a facet will filter should have the form **f[INDEX]=FACET_ID:VALUE** where **INDEX** is an index number for the filters array (starting from zero). For example, to search users that live in Berlin (ID = 45), the facets "type" and "location" have to be added to the array in the following manner: **/search?f[0]=type:user&f[1]=location:45**. The order of filters in the array has no effect.

try {
    final result = await api_instance.roomSearchGet(searchApiFulltext, f);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->roomSearchGet: $e\n');
}

import org.openapitools.client.api.OverviewPagesApi;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        String searchApiFulltext = neocosmo; // String | The search term. If an empty string is provided or the query parameter is not added to the request, the whole website content will be seen as valid search results.
        String f = f[0]=type:user; // String | Facets filters. When facets should be used to filter the search results, they have to be added as array items of this query parameter: a facet will filter should have the form **f[INDEX]=FACET_ID:VALUE** where **INDEX** is an index number for the filters array (starting from zero). For example, to search users that live in Berlin (ID = 45), the facets "type" and "location" have to be added to the array in the following manner: **/search?f[0]=type:user&f[1]=location:45**. The order of filters in the array has no effect.

        try {
            RoomSearch result = apiInstance.roomSearchGet(searchApiFulltext, f);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#roomSearchGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
OverviewPagesApi *apiInstance = [[OverviewPagesApi alloc] init];
String *searchApiFulltext = neocosmo; // The search term. If an empty string is provided or the query parameter is not added to the request, the whole website content will be seen as valid search results. (optional) (default to null)
String *f = f[0]=type:user; // Facets filters. When facets should be used to filter the search results, they have to be added as array items of this query parameter: a facet will filter should have the form **f[INDEX]=FACET_ID:VALUE** where **INDEX** is an index number for the filters array (starting from zero). For example, to search users that live in Berlin (ID = 45), the facets "type" and "location" have to be added to the array in the following manner: **/search?f[0]=type:user&f[1]=location:45**. The order of filters in the array has no effect. (optional) (default to null)

// Room Search site content.
[apiInstance roomSearchGetWith:searchApiFulltext
    f:f
              completionHandler: ^(RoomSearch output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.OverviewPagesApi()
var opts = {
  'searchApiFulltext': neocosmo, // {String} The search term. If an empty string is provided or the query parameter is not added to the request, the whole website content will be seen as valid search results.
  'f': f[0]=type:user // {String} Facets filters. When facets should be used to filter the search results, they have to be added as array items of this query parameter: a facet will filter should have the form **f[INDEX]=FACET_ID:VALUE** where **INDEX** is an index number for the filters array (starting from zero). For example, to search users that live in Berlin (ID = 45), the facets "type" and "location" have to be added to the array in the following manner: **/search?f[0]=type:user&f[1]=location:45**. The order of filters in the array has no effect.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.roomSearchGet(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class roomSearchGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OverviewPagesApi();
            var searchApiFulltext = neocosmo;  // String | The search term. If an empty string is provided or the query parameter is not added to the request, the whole website content will be seen as valid search results. (optional)  (default to null)
            var f = f[0]=type:user;  // String | Facets filters. When facets should be used to filter the search results, they have to be added as array items of this query parameter: a facet will filter should have the form **f[INDEX]=FACET_ID:VALUE** where **INDEX** is an index number for the filters array (starting from zero). For example, to search users that live in Berlin (ID = 45), the facets "type" and "location" have to be added to the array in the following manner: **/search?f[0]=type:user&f[1]=location:45**. The order of filters in the array has no effect. (optional)  (default to null)

            try {
                // Room Search site content.
                RoomSearch result = apiInstance.roomSearchGet(searchApiFulltext, f);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OverviewPagesApi.roomSearchGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OverviewPagesApi();
$searchApiFulltext = neocosmo; // String | The search term. If an empty string is provided or the query parameter is not added to the request, the whole website content will be seen as valid search results.
$f = f[0]=type:user; // String | Facets filters. When facets should be used to filter the search results, they have to be added as array items of this query parameter: a facet will filter should have the form **f[INDEX]=FACET_ID:VALUE** where **INDEX** is an index number for the filters array (starting from zero). For example, to search users that live in Berlin (ID = 45), the facets "type" and "location" have to be added to the array in the following manner: **/search?f[0]=type:user&f[1]=location:45**. The order of filters in the array has no effect.

try {
    $result = $api_instance->roomSearchGet($searchApiFulltext, $f);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OverviewPagesApi->roomSearchGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OverviewPagesApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OverviewPagesApi->new();
my $searchApiFulltext = neocosmo; # String | The search term. If an empty string is provided or the query parameter is not added to the request, the whole website content will be seen as valid search results.
my $f = f[0]=type:user; # String | Facets filters. When facets should be used to filter the search results, they have to be added as array items of this query parameter: a facet will filter should have the form **f[INDEX]=FACET_ID:VALUE** where **INDEX** is an index number for the filters array (starting from zero). For example, to search users that live in Berlin (ID = 45), the facets "type" and "location" have to be added to the array in the following manner: **/search?f[0]=type:user&f[1]=location:45**. The order of filters in the array has no effect.

eval {
    my $result = $api_instance->roomSearchGet(searchApiFulltext => $searchApiFulltext, f => $f);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OverviewPagesApi->roomSearchGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OverviewPagesApi()
searchApiFulltext = neocosmo # String | The search term. If an empty string is provided or the query parameter is not added to the request, the whole website content will be seen as valid search results. (optional) (default to null)
f = f[0]=type:user # String | Facets filters. When facets should be used to filter the search results, they have to be added as array items of this query parameter: a facet will filter should have the form **f[INDEX]=FACET_ID:VALUE** where **INDEX** is an index number for the filters array (starting from zero). For example, to search users that live in Berlin (ID = 45), the facets "type" and "location" have to be added to the array in the following manner: **/search?f[0]=type:user&f[1]=location:45**. The order of filters in the array has no effect. (optional) (default to null)

try:
    # Room Search site content.
    api_response = api_instance.room_search_get(searchApiFulltext=searchApiFulltext, f=f)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OverviewPagesApi->roomSearchGet: %s\n" % e)
extern crate OverviewPagesApi;

pub fn main() {
    let searchApiFulltext = neocosmo; // String
    let f = f[0]=type:user; // String

    let mut context = OverviewPagesApi::Context::default();
    let result = client.roomSearchGet(searchApiFulltext, f, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
search_api_fulltext
String
The search term. If an empty string is provided or the query parameter is not added to the request, the whole website content will be seen as valid search results.
f
String
Facets filters. When facets should be used to filter the search results, they have to be added as array items of this query parameter&#58; a facet will filter should have the form **f[INDEX]=FACET_ID:VALUE** where **INDEX** is an index number for the filters array (starting from zero). For example, to search users that live in Berlin (ID = 45), the facets "type" and "location" have to be added to the array in the following manner&#58; **/search?f[0]=type:user&f[1]=location:45**. The order of filters in the array has no effect.

Responses


searchGet

Search site content.

Search for content that contains a specific term, and filter and sort the search results. The query parameters defined in this endpoint are exactly the same as the ones used in the search page on the web (/search/content), so if you make a search on the web and copy the all query parameters and use them in this endpoint, you should get the exact same search results.


/search

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/search?keys=Neocosmo&field_archive=1&sort_by=search_api_relevance&page=0&f=f[0]=type:user"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OverviewPagesApi;

import java.io.File;
import java.util.*;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        String keys = Neocosmo; // String | The search term. If an empty string is provided or the query parameter is not added to the request, the whole website content will be seen as valid search results.
        Integer fieldArchive = 1; // Integer | Filter archived content. [1 for normal content, 2 for archived content]
        String sortBy = search_api_relevance; // String | Sort search results by relevance or publishing date.
        Integer page = 0; // Integer | Pager for search results.
        String f = f[0]=type:user; // String | Facets filters. When facets should be used to filter the search results, they have to be added as array items of this query parameter: a facet will filter should have the form **f[INDEX]=FACET_ID:VALUE** where **INDEX** is an index number for the filters array (starting from zero). For example, to search users that live in Berlin (ID = 45), the facets "type" and "location" have to be added to the array in the following manner: **/search?f[0]=type:user&f[1]=location:45**. The order of filters in the array has no effect.

        try {
            Search result = apiInstance.searchGet(keys, fieldArchive, sortBy, page, f);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#searchGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String keys = new String(); // String | The search term. If an empty string is provided or the query parameter is not added to the request, the whole website content will be seen as valid search results.
final Integer fieldArchive = new Integer(); // Integer | Filter archived content. [1 for normal content, 2 for archived content]
final String sortBy = new String(); // String | Sort search results by relevance or publishing date.
final Integer page = new Integer(); // Integer | Pager for search results.
final String f = new String(); // String | Facets filters. When facets should be used to filter the search results, they have to be added as array items of this query parameter: a facet will filter should have the form **f[INDEX]=FACET_ID:VALUE** where **INDEX** is an index number for the filters array (starting from zero). For example, to search users that live in Berlin (ID = 45), the facets "type" and "location" have to be added to the array in the following manner: **/search?f[0]=type:user&f[1]=location:45**. The order of filters in the array has no effect.

try {
    final result = await api_instance.searchGet(keys, fieldArchive, sortBy, page, f);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->searchGet: $e\n');
}

import org.openapitools.client.api.OverviewPagesApi;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        String keys = Neocosmo; // String | The search term. If an empty string is provided or the query parameter is not added to the request, the whole website content will be seen as valid search results.
        Integer fieldArchive = 1; // Integer | Filter archived content. [1 for normal content, 2 for archived content]
        String sortBy = search_api_relevance; // String | Sort search results by relevance or publishing date.
        Integer page = 0; // Integer | Pager for search results.
        String f = f[0]=type:user; // String | Facets filters. When facets should be used to filter the search results, they have to be added as array items of this query parameter: a facet will filter should have the form **f[INDEX]=FACET_ID:VALUE** where **INDEX** is an index number for the filters array (starting from zero). For example, to search users that live in Berlin (ID = 45), the facets "type" and "location" have to be added to the array in the following manner: **/search?f[0]=type:user&f[1]=location:45**. The order of filters in the array has no effect.

        try {
            Search result = apiInstance.searchGet(keys, fieldArchive, sortBy, page, f);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#searchGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
OverviewPagesApi *apiInstance = [[OverviewPagesApi alloc] init];
String *keys = Neocosmo; // The search term. If an empty string is provided or the query parameter is not added to the request, the whole website content will be seen as valid search results. (optional) (default to null)
Integer *fieldArchive = 1; // Filter archived content. [1 for normal content, 2 for archived content] (optional) (default to null)
String *sortBy = search_api_relevance; // Sort search results by relevance or publishing date. (optional) (default to null)
Integer *page = 0; // Pager for search results. (optional) (default to null)
String *f = f[0]=type:user; // Facets filters. When facets should be used to filter the search results, they have to be added as array items of this query parameter: a facet will filter should have the form **f[INDEX]=FACET_ID:VALUE** where **INDEX** is an index number for the filters array (starting from zero). For example, to search users that live in Berlin (ID = 45), the facets "type" and "location" have to be added to the array in the following manner: **/search?f[0]=type:user&f[1]=location:45**. The order of filters in the array has no effect. (optional) (default to null)

// Search site content.
[apiInstance searchGetWith:keys
    fieldArchive:fieldArchive
    sortBy:sortBy
    page:page
    f:f
              completionHandler: ^(Search output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.OverviewPagesApi()
var opts = {
  'keys': Neocosmo, // {String} The search term. If an empty string is provided or the query parameter is not added to the request, the whole website content will be seen as valid search results.
  'fieldArchive': 1, // {Integer} Filter archived content. [1 for normal content, 2 for archived content]
  'sortBy': search_api_relevance, // {String} Sort search results by relevance or publishing date.
  'page': 0, // {Integer} Pager for search results.
  'f': f[0]=type:user // {String} Facets filters. When facets should be used to filter the search results, they have to be added as array items of this query parameter: a facet will filter should have the form **f[INDEX]=FACET_ID:VALUE** where **INDEX** is an index number for the filters array (starting from zero). For example, to search users that live in Berlin (ID = 45), the facets "type" and "location" have to be added to the array in the following manner: **/search?f[0]=type:user&f[1]=location:45**. The order of filters in the array has no effect.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchGet(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class searchGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OverviewPagesApi();
            var keys = Neocosmo;  // String | The search term. If an empty string is provided or the query parameter is not added to the request, the whole website content will be seen as valid search results. (optional)  (default to null)
            var fieldArchive = 1;  // Integer | Filter archived content. [1 for normal content, 2 for archived content] (optional)  (default to null)
            var sortBy = search_api_relevance;  // String | Sort search results by relevance or publishing date. (optional)  (default to null)
            var page = 0;  // Integer | Pager for search results. (optional)  (default to null)
            var f = f[0]=type:user;  // String | Facets filters. When facets should be used to filter the search results, they have to be added as array items of this query parameter: a facet will filter should have the form **f[INDEX]=FACET_ID:VALUE** where **INDEX** is an index number for the filters array (starting from zero). For example, to search users that live in Berlin (ID = 45), the facets "type" and "location" have to be added to the array in the following manner: **/search?f[0]=type:user&f[1]=location:45**. The order of filters in the array has no effect. (optional)  (default to null)

            try {
                // Search site content.
                Search result = apiInstance.searchGet(keys, fieldArchive, sortBy, page, f);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OverviewPagesApi.searchGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OverviewPagesApi();
$keys = Neocosmo; // String | The search term. If an empty string is provided or the query parameter is not added to the request, the whole website content will be seen as valid search results.
$fieldArchive = 1; // Integer | Filter archived content. [1 for normal content, 2 for archived content]
$sortBy = search_api_relevance; // String | Sort search results by relevance or publishing date.
$page = 0; // Integer | Pager for search results.
$f = f[0]=type:user; // String | Facets filters. When facets should be used to filter the search results, they have to be added as array items of this query parameter: a facet will filter should have the form **f[INDEX]=FACET_ID:VALUE** where **INDEX** is an index number for the filters array (starting from zero). For example, to search users that live in Berlin (ID = 45), the facets "type" and "location" have to be added to the array in the following manner: **/search?f[0]=type:user&f[1]=location:45**. The order of filters in the array has no effect.

try {
    $result = $api_instance->searchGet($keys, $fieldArchive, $sortBy, $page, $f);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OverviewPagesApi->searchGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OverviewPagesApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OverviewPagesApi->new();
my $keys = Neocosmo; # String | The search term. If an empty string is provided or the query parameter is not added to the request, the whole website content will be seen as valid search results.
my $fieldArchive = 1; # Integer | Filter archived content. [1 for normal content, 2 for archived content]
my $sortBy = search_api_relevance; # String | Sort search results by relevance or publishing date.
my $page = 0; # Integer | Pager for search results.
my $f = f[0]=type:user; # String | Facets filters. When facets should be used to filter the search results, they have to be added as array items of this query parameter: a facet will filter should have the form **f[INDEX]=FACET_ID:VALUE** where **INDEX** is an index number for the filters array (starting from zero). For example, to search users that live in Berlin (ID = 45), the facets "type" and "location" have to be added to the array in the following manner: **/search?f[0]=type:user&f[1]=location:45**. The order of filters in the array has no effect.

eval {
    my $result = $api_instance->searchGet(keys => $keys, fieldArchive => $fieldArchive, sortBy => $sortBy, page => $page, f => $f);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OverviewPagesApi->searchGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OverviewPagesApi()
keys = Neocosmo # String | The search term. If an empty string is provided or the query parameter is not added to the request, the whole website content will be seen as valid search results. (optional) (default to null)
fieldArchive = 1 # Integer | Filter archived content. [1 for normal content, 2 for archived content] (optional) (default to null)
sortBy = search_api_relevance # String | Sort search results by relevance or publishing date. (optional) (default to null)
page = 0 # Integer | Pager for search results. (optional) (default to null)
f = f[0]=type:user # String | Facets filters. When facets should be used to filter the search results, they have to be added as array items of this query parameter: a facet will filter should have the form **f[INDEX]=FACET_ID:VALUE** where **INDEX** is an index number for the filters array (starting from zero). For example, to search users that live in Berlin (ID = 45), the facets "type" and "location" have to be added to the array in the following manner: **/search?f[0]=type:user&f[1]=location:45**. The order of filters in the array has no effect. (optional) (default to null)

try:
    # Search site content.
    api_response = api_instance.search_get(keys=keys, fieldArchive=fieldArchive, sortBy=sortBy, page=page, f=f)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OverviewPagesApi->searchGet: %s\n" % e)
extern crate OverviewPagesApi;

pub fn main() {
    let keys = Neocosmo; // String
    let fieldArchive = 1; // Integer
    let sortBy = search_api_relevance; // String
    let page = 0; // Integer
    let f = f[0]=type:user; // String

    let mut context = OverviewPagesApi::Context::default();
    let result = client.searchGet(keys, fieldArchive, sortBy, page, f, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
keys
String
The search term. If an empty string is provided or the query parameter is not added to the request, the whole website content will be seen as valid search results.
field_archive
Integer
Filter archived content. [1 for normal content, 2 for archived content]
sort_by
String
Sort search results by relevance or publishing date.
page
Integer
Pager for search results.
f
String
Facets filters. When facets should be used to filter the search results, they have to be added as array items of this query parameter&#58; a facet will filter should have the form **f[INDEX]=FACET_ID:VALUE** where **INDEX** is an index number for the filters array (starting from zero). For example, to search users that live in Berlin (ID = 45), the facets "type" and "location" have to be added to the array in the following manner&#58; **/search?f[0]=type:user&f[1]=location:45**. The order of filters in the array has no effect.

Responses


tagsPageGet

Tags page content.


/tags/{page}

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/tags/{page}?search_api_fulltext=neocosmo&search_api_fulltext_1=search_api_relevance"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OverviewPagesApi;

import java.io.File;
import java.util.*;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        String page = all_tags; // String | The requested overview page.
        String searchApiFulltext = neocosmo; // String | The search term. If an empty string is provided or the query parameter is not added to the request, all tags will be seen as valid search results.
        String searchApiFulltext1 = search_api_relevance; // String | Sort search results. [1: Most Used Tags, 2: Recent Tags, 3: Alphabetically Sorted]


        try {
            _tags__page__get_200_response result = apiInstance.tagsPageGet(page, searchApiFulltext, searchApiFulltext1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#tagsPageGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String page = new String(); // String | The requested overview page.
final String searchApiFulltext = new String(); // String | The search term. If an empty string is provided or the query parameter is not added to the request, all tags will be seen as valid search results.
final String searchApiFulltext1 = new String(); // String | Sort search results. [1: Most Used Tags, 2: Recent Tags, 3: Alphabetically Sorted]


try {
    final result = await api_instance.tagsPageGet(page, searchApiFulltext, searchApiFulltext1);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->tagsPageGet: $e\n');
}

import org.openapitools.client.api.OverviewPagesApi;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        String page = all_tags; // String | The requested overview page.
        String searchApiFulltext = neocosmo; // String | The search term. If an empty string is provided or the query parameter is not added to the request, all tags will be seen as valid search results.
        String searchApiFulltext1 = search_api_relevance; // String | Sort search results. [1: Most Used Tags, 2: Recent Tags, 3: Alphabetically Sorted]


        try {
            _tags__page__get_200_response result = apiInstance.tagsPageGet(page, searchApiFulltext, searchApiFulltext1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#tagsPageGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
OverviewPagesApi *apiInstance = [[OverviewPagesApi alloc] init];
String *page = all_tags; // The requested overview page. (default to null)
String *searchApiFulltext = neocosmo; // The search term. If an empty string is provided or the query parameter is not added to the request, all tags will be seen as valid search results. (optional) (default to null)
String *searchApiFulltext1 = search_api_relevance; // Sort search results. [1: Most Used Tags, 2: Recent Tags, 3: Alphabetically Sorted]
 (optional) (default to null)

// Tags page content.
[apiInstance tagsPageGetWith:page
    searchApiFulltext:searchApiFulltext
    searchApiFulltext1:searchApiFulltext1
              completionHandler: ^(_tags__page__get_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.OverviewPagesApi()
var page = all_tags; // {String} The requested overview page.
var opts = {
  'searchApiFulltext': neocosmo, // {String} The search term. If an empty string is provided or the query parameter is not added to the request, all tags will be seen as valid search results.
  'searchApiFulltext1': search_api_relevance // {String} Sort search results. [1: Most Used Tags, 2: Recent Tags, 3: Alphabetically Sorted]

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.tagsPageGet(page, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class tagsPageGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OverviewPagesApi();
            var page = all_tags;  // String | The requested overview page. (default to null)
            var searchApiFulltext = neocosmo;  // String | The search term. If an empty string is provided or the query parameter is not added to the request, all tags will be seen as valid search results. (optional)  (default to null)
            var searchApiFulltext1 = search_api_relevance;  // String | Sort search results. [1: Most Used Tags, 2: Recent Tags, 3: Alphabetically Sorted]
 (optional)  (default to null)

            try {
                // Tags page content.
                _tags__page__get_200_response result = apiInstance.tagsPageGet(page, searchApiFulltext, searchApiFulltext1);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OverviewPagesApi.tagsPageGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OverviewPagesApi();
$page = all_tags; // String | The requested overview page.
$searchApiFulltext = neocosmo; // String | The search term. If an empty string is provided or the query parameter is not added to the request, all tags will be seen as valid search results.
$searchApiFulltext1 = search_api_relevance; // String | Sort search results. [1: Most Used Tags, 2: Recent Tags, 3: Alphabetically Sorted]


try {
    $result = $api_instance->tagsPageGet($page, $searchApiFulltext, $searchApiFulltext1);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OverviewPagesApi->tagsPageGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OverviewPagesApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OverviewPagesApi->new();
my $page = all_tags; # String | The requested overview page.
my $searchApiFulltext = neocosmo; # String | The search term. If an empty string is provided or the query parameter is not added to the request, all tags will be seen as valid search results.
my $searchApiFulltext1 = search_api_relevance; # String | Sort search results. [1: Most Used Tags, 2: Recent Tags, 3: Alphabetically Sorted]


eval {
    my $result = $api_instance->tagsPageGet(page => $page, searchApiFulltext => $searchApiFulltext, searchApiFulltext1 => $searchApiFulltext1);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OverviewPagesApi->tagsPageGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OverviewPagesApi()
page = all_tags # String | The requested overview page. (default to null)
searchApiFulltext = neocosmo # String | The search term. If an empty string is provided or the query parameter is not added to the request, all tags will be seen as valid search results. (optional) (default to null)
searchApiFulltext1 = search_api_relevance # String | Sort search results. [1: Most Used Tags, 2: Recent Tags, 3: Alphabetically Sorted]
 (optional) (default to null)

try:
    # Tags page content.
    api_response = api_instance.tags_page_get(page, searchApiFulltext=searchApiFulltext, searchApiFulltext1=searchApiFulltext1)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OverviewPagesApi->tagsPageGet: %s\n" % e)
extern crate OverviewPagesApi;

pub fn main() {
    let page = all_tags; // String
    let searchApiFulltext = neocosmo; // String
    let searchApiFulltext1 = search_api_relevance; // String

    let mut context = OverviewPagesApi::Context::default();
    let result = client.tagsPageGet(page, searchApiFulltext, searchApiFulltext1, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
page*
String
The requested overview page.
Required
Query parameters
Name Description
search_api_fulltext
String
The search term. If an empty string is provided or the query parameter is not added to the request, all tags will be seen as valid search results.
search_api_fulltext_1
String
Sort search results. [1: Most Used Tags, 2: Recent Tags, 3: Alphabetically Sorted]

Responses


taxonomyPageTidGet

Get taxonomy page content.

Get content related to a taxonomy term.


/taxonomy_page/{tid}

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/taxonomy_page/{tid}?page=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OverviewPagesApi;

import java.io.File;
import java.util.*;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        Integer tid = 56; // Integer | The taxonomy term id.
        Integer page = 56; // Integer | Pager for the content.

        try {
            _taxonomy_page__tid__get_200_response result = apiInstance.taxonomyPageTidGet(tid, page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#taxonomyPageTidGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer tid = new Integer(); // Integer | The taxonomy term id.
final Integer page = new Integer(); // Integer | Pager for the content.

try {
    final result = await api_instance.taxonomyPageTidGet(tid, page);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->taxonomyPageTidGet: $e\n');
}

import org.openapitools.client.api.OverviewPagesApi;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        Integer tid = 56; // Integer | The taxonomy term id.
        Integer page = 56; // Integer | Pager for the content.

        try {
            _taxonomy_page__tid__get_200_response result = apiInstance.taxonomyPageTidGet(tid, page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#taxonomyPageTidGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
OverviewPagesApi *apiInstance = [[OverviewPagesApi alloc] init];
Integer *tid = 56; // The taxonomy term id. (default to null)
Integer *page = 56; // Pager for the content. (optional) (default to null)

// Get taxonomy page content.
[apiInstance taxonomyPageTidGetWith:tid
    page:page
              completionHandler: ^(_taxonomy_page__tid__get_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.OverviewPagesApi()
var tid = 56; // {Integer} The taxonomy term id.
var opts = {
  'page': 56 // {Integer} Pager for the content.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.taxonomyPageTidGet(tid, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class taxonomyPageTidGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OverviewPagesApi();
            var tid = 56;  // Integer | The taxonomy term id. (default to null)
            var page = 56;  // Integer | Pager for the content. (optional)  (default to null)

            try {
                // Get taxonomy page content.
                _taxonomy_page__tid__get_200_response result = apiInstance.taxonomyPageTidGet(tid, page);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OverviewPagesApi.taxonomyPageTidGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OverviewPagesApi();
$tid = 56; // Integer | The taxonomy term id.
$page = 56; // Integer | Pager for the content.

try {
    $result = $api_instance->taxonomyPageTidGet($tid, $page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OverviewPagesApi->taxonomyPageTidGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OverviewPagesApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OverviewPagesApi->new();
my $tid = 56; # Integer | The taxonomy term id.
my $page = 56; # Integer | Pager for the content.

eval {
    my $result = $api_instance->taxonomyPageTidGet(tid => $tid, page => $page);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OverviewPagesApi->taxonomyPageTidGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OverviewPagesApi()
tid = 56 # Integer | The taxonomy term id. (default to null)
page = 56 # Integer | Pager for the content. (optional) (default to null)

try:
    # Get taxonomy page content.
    api_response = api_instance.taxonomy_page_tid_get(tid, page=page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OverviewPagesApi->taxonomyPageTidGet: %s\n" % e)
extern crate OverviewPagesApi;

pub fn main() {
    let tid = 56; // Integer
    let page = 56; // Integer

    let mut context = OverviewPagesApi::Context::default();
    let result = client.taxonomyPageTidGet(tid, page, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
tid*
Integer
The taxonomy term id.
Required
Query parameters
Name Description
page
Integer
Pager for the content.

Responses


vehicleSearchGet

Room Search site content.


/vehicle_search

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/vehicle_search?search_api_fulltext=neocosmo&f=f[0]=type:user"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OverviewPagesApi;

import java.io.File;
import java.util.*;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        String searchApiFulltext = neocosmo; // String | The search term. If an empty string is provided or the query parameter is not added to the request, the whole website content will be seen as valid search results.
        String f = f[0]=type:user; // String | Facets filters. When facets should be used to filter the search results, they have to be added as array items of this query parameter: a facet will filter should have the form **f[INDEX]=FACET_ID:VALUE** where **INDEX** is an index number for the filters array (starting from zero). For example, to search users that live in Berlin (ID = 45), the facets "type" and "location" have to be added to the array in the following manner: **/search?f[0]=type:user&f[1]=location:45**. The order of filters in the array has no effect.

        try {
            VehicleSearch result = apiInstance.vehicleSearchGet(searchApiFulltext, f);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#vehicleSearchGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String searchApiFulltext = new String(); // String | The search term. If an empty string is provided or the query parameter is not added to the request, the whole website content will be seen as valid search results.
final String f = new String(); // String | Facets filters. When facets should be used to filter the search results, they have to be added as array items of this query parameter: a facet will filter should have the form **f[INDEX]=FACET_ID:VALUE** where **INDEX** is an index number for the filters array (starting from zero). For example, to search users that live in Berlin (ID = 45), the facets "type" and "location" have to be added to the array in the following manner: **/search?f[0]=type:user&f[1]=location:45**. The order of filters in the array has no effect.

try {
    final result = await api_instance.vehicleSearchGet(searchApiFulltext, f);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->vehicleSearchGet: $e\n');
}

import org.openapitools.client.api.OverviewPagesApi;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        String searchApiFulltext = neocosmo; // String | The search term. If an empty string is provided or the query parameter is not added to the request, the whole website content will be seen as valid search results.
        String f = f[0]=type:user; // String | Facets filters. When facets should be used to filter the search results, they have to be added as array items of this query parameter: a facet will filter should have the form **f[INDEX]=FACET_ID:VALUE** where **INDEX** is an index number for the filters array (starting from zero). For example, to search users that live in Berlin (ID = 45), the facets "type" and "location" have to be added to the array in the following manner: **/search?f[0]=type:user&f[1]=location:45**. The order of filters in the array has no effect.

        try {
            VehicleSearch result = apiInstance.vehicleSearchGet(searchApiFulltext, f);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#vehicleSearchGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
OverviewPagesApi *apiInstance = [[OverviewPagesApi alloc] init];
String *searchApiFulltext = neocosmo; // The search term. If an empty string is provided or the query parameter is not added to the request, the whole website content will be seen as valid search results. (optional) (default to null)
String *f = f[0]=type:user; // Facets filters. When facets should be used to filter the search results, they have to be added as array items of this query parameter: a facet will filter should have the form **f[INDEX]=FACET_ID:VALUE** where **INDEX** is an index number for the filters array (starting from zero). For example, to search users that live in Berlin (ID = 45), the facets "type" and "location" have to be added to the array in the following manner: **/search?f[0]=type:user&f[1]=location:45**. The order of filters in the array has no effect. (optional) (default to null)

// Room Search site content.
[apiInstance vehicleSearchGetWith:searchApiFulltext
    f:f
              completionHandler: ^(VehicleSearch output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.OverviewPagesApi()
var opts = {
  'searchApiFulltext': neocosmo, // {String} The search term. If an empty string is provided or the query parameter is not added to the request, the whole website content will be seen as valid search results.
  'f': f[0]=type:user // {String} Facets filters. When facets should be used to filter the search results, they have to be added as array items of this query parameter: a facet will filter should have the form **f[INDEX]=FACET_ID:VALUE** where **INDEX** is an index number for the filters array (starting from zero). For example, to search users that live in Berlin (ID = 45), the facets "type" and "location" have to be added to the array in the following manner: **/search?f[0]=type:user&f[1]=location:45**. The order of filters in the array has no effect.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.vehicleSearchGet(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class vehicleSearchGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OverviewPagesApi();
            var searchApiFulltext = neocosmo;  // String | The search term. If an empty string is provided or the query parameter is not added to the request, the whole website content will be seen as valid search results. (optional)  (default to null)
            var f = f[0]=type:user;  // String | Facets filters. When facets should be used to filter the search results, they have to be added as array items of this query parameter: a facet will filter should have the form **f[INDEX]=FACET_ID:VALUE** where **INDEX** is an index number for the filters array (starting from zero). For example, to search users that live in Berlin (ID = 45), the facets "type" and "location" have to be added to the array in the following manner: **/search?f[0]=type:user&f[1]=location:45**. The order of filters in the array has no effect. (optional)  (default to null)

            try {
                // Room Search site content.
                VehicleSearch result = apiInstance.vehicleSearchGet(searchApiFulltext, f);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OverviewPagesApi.vehicleSearchGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OverviewPagesApi();
$searchApiFulltext = neocosmo; // String | The search term. If an empty string is provided or the query parameter is not added to the request, the whole website content will be seen as valid search results.
$f = f[0]=type:user; // String | Facets filters. When facets should be used to filter the search results, they have to be added as array items of this query parameter: a facet will filter should have the form **f[INDEX]=FACET_ID:VALUE** where **INDEX** is an index number for the filters array (starting from zero). For example, to search users that live in Berlin (ID = 45), the facets "type" and "location" have to be added to the array in the following manner: **/search?f[0]=type:user&f[1]=location:45**. The order of filters in the array has no effect.

try {
    $result = $api_instance->vehicleSearchGet($searchApiFulltext, $f);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OverviewPagesApi->vehicleSearchGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OverviewPagesApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OverviewPagesApi->new();
my $searchApiFulltext = neocosmo; # String | The search term. If an empty string is provided or the query parameter is not added to the request, the whole website content will be seen as valid search results.
my $f = f[0]=type:user; # String | Facets filters. When facets should be used to filter the search results, they have to be added as array items of this query parameter: a facet will filter should have the form **f[INDEX]=FACET_ID:VALUE** where **INDEX** is an index number for the filters array (starting from zero). For example, to search users that live in Berlin (ID = 45), the facets "type" and "location" have to be added to the array in the following manner: **/search?f[0]=type:user&f[1]=location:45**. The order of filters in the array has no effect.

eval {
    my $result = $api_instance->vehicleSearchGet(searchApiFulltext => $searchApiFulltext, f => $f);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OverviewPagesApi->vehicleSearchGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OverviewPagesApi()
searchApiFulltext = neocosmo # String | The search term. If an empty string is provided or the query parameter is not added to the request, the whole website content will be seen as valid search results. (optional) (default to null)
f = f[0]=type:user # String | Facets filters. When facets should be used to filter the search results, they have to be added as array items of this query parameter: a facet will filter should have the form **f[INDEX]=FACET_ID:VALUE** where **INDEX** is an index number for the filters array (starting from zero). For example, to search users that live in Berlin (ID = 45), the facets "type" and "location" have to be added to the array in the following manner: **/search?f[0]=type:user&f[1]=location:45**. The order of filters in the array has no effect. (optional) (default to null)

try:
    # Room Search site content.
    api_response = api_instance.vehicle_search_get(searchApiFulltext=searchApiFulltext, f=f)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OverviewPagesApi->vehicleSearchGet: %s\n" % e)
extern crate OverviewPagesApi;

pub fn main() {
    let searchApiFulltext = neocosmo; // String
    let f = f[0]=type:user; // String

    let mut context = OverviewPagesApi::Context::default();
    let result = client.vehicleSearchGet(searchApiFulltext, f, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
search_api_fulltext
String
The search term. If an empty string is provided or the query parameter is not added to the request, the whole website content will be seen as valid search results.
f
String
Facets filters. When facets should be used to filter the search results, they have to be added as array items of this query parameter&#58; a facet will filter should have the form **f[INDEX]=FACET_ID:VALUE** where **INDEX** is an index number for the filters array (starting from zero). For example, to search users that live in Berlin (ID = 45), the facets "type" and "location" have to be added to the array in the following manner&#58; **/search?f[0]=type:user&f[1]=location:45**. The order of filters in the array has no effect.

Responses


videosGet

Get a videos page content.


/videos

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/videos?page=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OverviewPagesApi;

import java.io.File;
import java.util.*;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        Integer page = 56; // Integer | The page number for pagination.

        try {
            _videos_get_200_response result = apiInstance.videosGet(page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#videosGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer page = new Integer(); // Integer | The page number for pagination.

try {
    final result = await api_instance.videosGet(page);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->videosGet: $e\n');
}

import org.openapitools.client.api.OverviewPagesApi;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        Integer page = 56; // Integer | The page number for pagination.

        try {
            _videos_get_200_response result = apiInstance.videosGet(page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#videosGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
OverviewPagesApi *apiInstance = [[OverviewPagesApi alloc] init];
Integer *page = 56; // The page number for pagination. (optional) (default to null)

// Get a videos page content.
[apiInstance videosGetWith:page
              completionHandler: ^(_videos_get_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.OverviewPagesApi()
var opts = {
  'page': 56 // {Integer} The page number for pagination.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.videosGet(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class videosGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OverviewPagesApi();
            var page = 56;  // Integer | The page number for pagination. (optional)  (default to null)

            try {
                // Get a videos page content.
                _videos_get_200_response result = apiInstance.videosGet(page);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OverviewPagesApi.videosGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OverviewPagesApi();
$page = 56; // Integer | The page number for pagination.

try {
    $result = $api_instance->videosGet($page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OverviewPagesApi->videosGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OverviewPagesApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OverviewPagesApi->new();
my $page = 56; # Integer | The page number for pagination.

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OverviewPagesApi()
page = 56 # Integer | The page number for pagination. (optional) (default to null)

try:
    # Get a videos page content.
    api_response = api_instance.videos_get(page=page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OverviewPagesApi->videosGet: %s\n" % e)
extern crate OverviewPagesApi;

pub fn main() {
    let page = 56; // Integer

    let mut context = OverviewPagesApi::Context::default();
    let result = client.videosGet(page, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
page
Integer
The page number for pagination.

Responses


wikiOverviewGet

Get wiki overview content.

Returns overview information (title, description) plus exported wiki category entities.


/wiki_overview

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/wiki_overview"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OverviewPagesApi;

import java.io.File;
import java.util.*;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        OverviewPagesApi apiInstance = new OverviewPagesApi();

        try {
            _wiki_overview_get_200_response result = apiInstance.wikiOverviewGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#wikiOverviewGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.wikiOverviewGet();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->wikiOverviewGet: $e\n');
}

import org.openapitools.client.api.OverviewPagesApi;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        OverviewPagesApi apiInstance = new OverviewPagesApi();

        try {
            _wiki_overview_get_200_response result = apiInstance.wikiOverviewGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#wikiOverviewGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
OverviewPagesApi *apiInstance = [[OverviewPagesApi alloc] init];

// Get wiki overview content.
[apiInstance wikiOverviewGetWithCompletionHandler: 
              ^(_wiki_overview_get_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.OverviewPagesApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.wikiOverviewGet(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class wikiOverviewGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OverviewPagesApi();

            try {
                // Get wiki overview content.
                _wiki_overview_get_200_response result = apiInstance.wikiOverviewGet();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OverviewPagesApi.wikiOverviewGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OverviewPagesApi();

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OverviewPagesApi->new();

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OverviewPagesApi()

try:
    # Get wiki overview content.
    api_response = api_instance.wiki_overview_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OverviewPagesApi->wikiOverviewGet: %s\n" % e)
extern crate OverviewPagesApi;

pub fn main() {

    let mut context = OverviewPagesApi::Context::default();
    let result = client.wikiOverviewGet(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


wikiTermOverviewTermIdGet

Get wiki term overview content.

Returns term overview information (title, description) plus exported wiki category entities.


/wiki_term_overview/{term_id}

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/wiki_term_overview/{term_id}?search_api_fulltext=searchApiFulltext_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OverviewPagesApi;

import java.io.File;
import java.util.*;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        Integer termId = 56; // Integer | Taxonomy term ID.
        String searchApiFulltext = searchApiFulltext_example; // String | Optional search keywords.

        try {
            _wiki_term_overview__term_id__get_200_response result = apiInstance.wikiTermOverviewTermIdGet(termId, searchApiFulltext);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#wikiTermOverviewTermIdGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer termId = new Integer(); // Integer | Taxonomy term ID.
final String searchApiFulltext = new String(); // String | Optional search keywords.

try {
    final result = await api_instance.wikiTermOverviewTermIdGet(termId, searchApiFulltext);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->wikiTermOverviewTermIdGet: $e\n');
}

import org.openapitools.client.api.OverviewPagesApi;

public class OverviewPagesApiExample {
    public static void main(String[] args) {
        OverviewPagesApi apiInstance = new OverviewPagesApi();
        Integer termId = 56; // Integer | Taxonomy term ID.
        String searchApiFulltext = searchApiFulltext_example; // String | Optional search keywords.

        try {
            _wiki_term_overview__term_id__get_200_response result = apiInstance.wikiTermOverviewTermIdGet(termId, searchApiFulltext);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OverviewPagesApi#wikiTermOverviewTermIdGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
OverviewPagesApi *apiInstance = [[OverviewPagesApi alloc] init];
Integer *termId = 56; // Taxonomy term ID. (default to null)
String *searchApiFulltext = searchApiFulltext_example; // Optional search keywords. (optional) (default to null)

// Get wiki term overview content.
[apiInstance wikiTermOverviewTermIdGetWith:termId
    searchApiFulltext:searchApiFulltext
              completionHandler: ^(_wiki_term_overview__term_id__get_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.OverviewPagesApi()
var termId = 56; // {Integer} Taxonomy term ID.
var opts = {
  'searchApiFulltext': searchApiFulltext_example // {String} Optional search keywords.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.wikiTermOverviewTermIdGet(termId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class wikiTermOverviewTermIdGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OverviewPagesApi();
            var termId = 56;  // Integer | Taxonomy term ID. (default to null)
            var searchApiFulltext = searchApiFulltext_example;  // String | Optional search keywords. (optional)  (default to null)

            try {
                // Get wiki term overview content.
                _wiki_term_overview__term_id__get_200_response result = apiInstance.wikiTermOverviewTermIdGet(termId, searchApiFulltext);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OverviewPagesApi.wikiTermOverviewTermIdGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OverviewPagesApi();
$termId = 56; // Integer | Taxonomy term ID.
$searchApiFulltext = searchApiFulltext_example; // String | Optional search keywords.

try {
    $result = $api_instance->wikiTermOverviewTermIdGet($termId, $searchApiFulltext);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OverviewPagesApi->wikiTermOverviewTermIdGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OverviewPagesApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OverviewPagesApi->new();
my $termId = 56; # Integer | Taxonomy term ID.
my $searchApiFulltext = searchApiFulltext_example; # String | Optional search keywords.

eval {
    my $result = $api_instance->wikiTermOverviewTermIdGet(termId => $termId, searchApiFulltext => $searchApiFulltext);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OverviewPagesApi->wikiTermOverviewTermIdGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OverviewPagesApi()
termId = 56 # Integer | Taxonomy term ID. (default to null)
searchApiFulltext = searchApiFulltext_example # String | Optional search keywords. (optional) (default to null)

try:
    # Get wiki term overview content.
    api_response = api_instance.wiki_term_overview_term_id_get(termId, searchApiFulltext=searchApiFulltext)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OverviewPagesApi->wikiTermOverviewTermIdGet: %s\n" % e)
extern crate OverviewPagesApi;

pub fn main() {
    let termId = 56; // Integer
    let searchApiFulltext = searchApiFulltext_example; // String

    let mut context = OverviewPagesApi::Context::default();
    let result = client.wikiTermOverviewTermIdGet(termId, searchApiFulltext, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
term_id*
Integer
Taxonomy term ID.
Required
Query parameters
Name Description
search_api_fulltext
String
Optional search keywords.

Responses


User

openidConnectLoginOidcClientNamePost

Authenticate/register a user through OpenID Connect.

Log in/create a user by exchanging an id token and access token recieved from a successful logging in to an OIDC Provider.


/openid_connect_login/{oidc_client_name}

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://nextworkplace.staging/api/v1/openid_connect_login/{oidc_client_name}" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        String oidcClientName = microsoft_azure; // String | The machine name of the configured OIDC client a user want to login through (a list of available clients can be found under the path "/admin/config/people/openid-connect").
        OpenidConnectLoginOidcClientNamePostRequest openidConnectLoginOidcClientNamePostRequest = ; // OpenidConnectLoginOidcClientNamePostRequest | 

        try {
            Login result = apiInstance.openidConnectLoginOidcClientNamePost(oidcClientName, openidConnectLoginOidcClientNamePostRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#openidConnectLoginOidcClientNamePost");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String oidcClientName = new String(); // String | The machine name of the configured OIDC client a user want to login through (a list of available clients can be found under the path "/admin/config/people/openid-connect").
final OpenidConnectLoginOidcClientNamePostRequest openidConnectLoginOidcClientNamePostRequest = new OpenidConnectLoginOidcClientNamePostRequest(); // OpenidConnectLoginOidcClientNamePostRequest | 

try {
    final result = await api_instance.openidConnectLoginOidcClientNamePost(oidcClientName, openidConnectLoginOidcClientNamePostRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->openidConnectLoginOidcClientNamePost: $e\n');
}

import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        String oidcClientName = microsoft_azure; // String | The machine name of the configured OIDC client a user want to login through (a list of available clients can be found under the path "/admin/config/people/openid-connect").
        OpenidConnectLoginOidcClientNamePostRequest openidConnectLoginOidcClientNamePostRequest = ; // OpenidConnectLoginOidcClientNamePostRequest | 

        try {
            Login result = apiInstance.openidConnectLoginOidcClientNamePost(oidcClientName, openidConnectLoginOidcClientNamePostRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#openidConnectLoginOidcClientNamePost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];
String *oidcClientName = microsoft_azure; // The machine name of the configured OIDC client a user want to login through (a list of available clients can be found under the path "/admin/config/people/openid-connect"). (default to null)
OpenidConnectLoginOidcClientNamePostRequest *openidConnectLoginOidcClientNamePostRequest = ; // 

// Authenticate/register a user through OpenID Connect.
[apiInstance openidConnectLoginOidcClientNamePostWith:oidcClientName
    openidConnectLoginOidcClientNamePostRequest:openidConnectLoginOidcClientNamePostRequest
              completionHandler: ^(Login output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.UserApi()
var oidcClientName = microsoft_azure; // {String} The machine name of the configured OIDC client a user want to login through (a list of available clients can be found under the path "/admin/config/people/openid-connect").
var openidConnectLoginOidcClientNamePostRequest = ; // {OpenidConnectLoginOidcClientNamePostRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.openidConnectLoginOidcClientNamePost(oidcClientName, openidConnectLoginOidcClientNamePostRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class openidConnectLoginOidcClientNamePostExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new UserApi();
            var oidcClientName = microsoft_azure;  // String | The machine name of the configured OIDC client a user want to login through (a list of available clients can be found under the path "/admin/config/people/openid-connect"). (default to null)
            var openidConnectLoginOidcClientNamePostRequest = new OpenidConnectLoginOidcClientNamePostRequest(); // OpenidConnectLoginOidcClientNamePostRequest | 

            try {
                // Authenticate/register a user through OpenID Connect.
                Login result = apiInstance.openidConnectLoginOidcClientNamePost(oidcClientName, openidConnectLoginOidcClientNamePostRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.openidConnectLoginOidcClientNamePost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();
$oidcClientName = microsoft_azure; // String | The machine name of the configured OIDC client a user want to login through (a list of available clients can be found under the path "/admin/config/people/openid-connect").
$openidConnectLoginOidcClientNamePostRequest = ; // OpenidConnectLoginOidcClientNamePostRequest | 

try {
    $result = $api_instance->openidConnectLoginOidcClientNamePost($oidcClientName, $openidConnectLoginOidcClientNamePostRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->openidConnectLoginOidcClientNamePost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();
my $oidcClientName = microsoft_azure; # String | The machine name of the configured OIDC client a user want to login through (a list of available clients can be found under the path "/admin/config/people/openid-connect").
my $openidConnectLoginOidcClientNamePostRequest = WWW::OPenAPIClient::Object::OpenidConnectLoginOidcClientNamePostRequest->new(); # OpenidConnectLoginOidcClientNamePostRequest | 

eval {
    my $result = $api_instance->openidConnectLoginOidcClientNamePost(oidcClientName => $oidcClientName, openidConnectLoginOidcClientNamePostRequest => $openidConnectLoginOidcClientNamePostRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->openidConnectLoginOidcClientNamePost: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.UserApi()
oidcClientName = microsoft_azure # String | The machine name of the configured OIDC client a user want to login through (a list of available clients can be found under the path "/admin/config/people/openid-connect"). (default to null)
openidConnectLoginOidcClientNamePostRequest =  # OpenidConnectLoginOidcClientNamePostRequest | 

try:
    # Authenticate/register a user through OpenID Connect.
    api_response = api_instance.openid_connect_login_oidc_client_name_post(oidcClientName, openidConnectLoginOidcClientNamePostRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->openidConnectLoginOidcClientNamePost: %s\n" % e)
extern crate UserApi;

pub fn main() {
    let oidcClientName = microsoft_azure; // String
    let openidConnectLoginOidcClientNamePostRequest = ; // OpenidConnectLoginOidcClientNamePostRequest

    let mut context = UserApi::Context::default();
    let result = client.openidConnectLoginOidcClientNamePost(oidcClientName, openidConnectLoginOidcClientNamePostRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
oidc_client_name*
String
The machine name of the configured OIDC client a user want to login through (a list of available clients can be found under the path "/admin/config/people/openid-connect").
Required
Body parameters
Name Description
openidConnectLoginOidcClientNamePostRequest *

The id and access tokens recieved after logging in to an OIDC provider.

Responses


refreshTokenGet

Generate a new access token using a refresh token.

When an access token has expired, use a refresh token to generate a new access token as well as a new refresh token. Note: The refresh token must be used in the the 'Authorization' header to authorize against this endpoint. Trying to use the refresh token to authorize against any other endpoint will fail. The same argument is valid for the access token the other way around.


/refresh_token

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/refresh_token"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        UUID security = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

        try {
            _refresh_token_get_200_response result = apiInstance.refreshTokenGet(security);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#refreshTokenGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID security = new UUID(); // UUID | 

try {
    final result = await api_instance.refreshTokenGet(security);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->refreshTokenGet: $e\n');
}

import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        UUID security = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

        try {
            _refresh_token_get_200_response result = apiInstance.refreshTokenGet(security);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#refreshTokenGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];
UUID *security = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)

// Generate a new access token using a refresh token.
[apiInstance refreshTokenGetWith:security
              completionHandler: ^(_refresh_token_get_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.UserApi()
var security = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.refreshTokenGet(security, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class refreshTokenGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new UserApi();
            var security = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)

            try {
                // Generate a new access token using a refresh token.
                _refresh_token_get_200_response result = apiInstance.refreshTokenGet(security);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.refreshTokenGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();
$security = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

try {
    $result = $api_instance->refreshTokenGet($security);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->refreshTokenGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();
my $security = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.UserApi()
security = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)

try:
    # Generate a new access token using a refresh token.
    api_response = api_instance.refresh_token_get(security)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->refreshTokenGet: %s\n" % e)
extern crate UserApi;

pub fn main() {
    let security = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = UserApi::Context::default();
    let result = client.refreshTokenGet(security, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Header parameters
Name Description
security*
UUID (uuid)
Required

Responses


userCodeRegisterPost

Register user with initial credentials.

The user is expected to be provided with a username and an initial password that can be reset. This API can be used to either only validate the credentials, or to set a new password and complete user registration.


/user/code_register

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://nextworkplace.staging/api/v1/user/code_register" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        UserCodeRegisterPostRequest userCodeRegisterPostRequest = ; // UserCodeRegisterPostRequest | 

        try {
            Login result = apiInstance.userCodeRegisterPost(userCodeRegisterPostRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#userCodeRegisterPost");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UserCodeRegisterPostRequest userCodeRegisterPostRequest = new UserCodeRegisterPostRequest(); // UserCodeRegisterPostRequest | 

try {
    final result = await api_instance.userCodeRegisterPost(userCodeRegisterPostRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->userCodeRegisterPost: $e\n');
}

import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        UserCodeRegisterPostRequest userCodeRegisterPostRequest = ; // UserCodeRegisterPostRequest | 

        try {
            Login result = apiInstance.userCodeRegisterPost(userCodeRegisterPostRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#userCodeRegisterPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];
UserCodeRegisterPostRequest *userCodeRegisterPostRequest = ; // 

// Register user with initial credentials.
[apiInstance userCodeRegisterPostWith:userCodeRegisterPostRequest
              completionHandler: ^(Login output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.UserApi()
var userCodeRegisterPostRequest = ; // {UserCodeRegisterPostRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.userCodeRegisterPost(userCodeRegisterPostRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class userCodeRegisterPostExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new UserApi();
            var userCodeRegisterPostRequest = new UserCodeRegisterPostRequest(); // UserCodeRegisterPostRequest | 

            try {
                // Register user with initial credentials.
                Login result = apiInstance.userCodeRegisterPost(userCodeRegisterPostRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.userCodeRegisterPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();
$userCodeRegisterPostRequest = ; // UserCodeRegisterPostRequest | 

try {
    $result = $api_instance->userCodeRegisterPost($userCodeRegisterPostRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->userCodeRegisterPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();
my $userCodeRegisterPostRequest = WWW::OPenAPIClient::Object::UserCodeRegisterPostRequest->new(); # UserCodeRegisterPostRequest | 

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.UserApi()
userCodeRegisterPostRequest =  # UserCodeRegisterPostRequest | 

try:
    # Register user with initial credentials.
    api_response = api_instance.user_code_register_post(userCodeRegisterPostRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->userCodeRegisterPost: %s\n" % e)
extern crate UserApi;

pub fn main() {
    let userCodeRegisterPostRequest = ; // UserCodeRegisterPostRequest

    let mut context = UserApi::Context::default();
    let result = client.userCodeRegisterPost(userCodeRegisterPostRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
userCodeRegisterPostRequest *

Responses


userLoginCheckGet

Get the login status of a user by the JWT token.

Returns an object with the status of the user. If logged run it returns the user object additionally


/user-login-check

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/user-login-check?_format=format_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        String format = format_example; // String | The format of the returend user login data.

        try {
            Login-Check result = apiInstance.userLoginCheckGet(format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#userLoginCheckGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String format = new String(); // String | The format of the returend user login data.

try {
    final result = await api_instance.userLoginCheckGet(format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->userLoginCheckGet: $e\n');
}

import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        String format = format_example; // String | The format of the returend user login data.

        try {
            Login-Check result = apiInstance.userLoginCheckGet(format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#userLoginCheckGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];
String *format = format_example; // The format of the returend user login data. (default to null)

// Get the login status of a user by the JWT token.
[apiInstance userLoginCheckGetWith:format
              completionHandler: ^(Login-Check output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.UserApi()
var format = format_example; // {String} The format of the returend user login data.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.userLoginCheckGet(format, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class userLoginCheckGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new UserApi();
            var format = format_example;  // String | The format of the returend user login data. (default to null)

            try {
                // Get the login status of a user by the JWT token.
                Login-Check result = apiInstance.userLoginCheckGet(format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.userLoginCheckGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();
$format = format_example; // String | The format of the returend user login data.

try {
    $result = $api_instance->userLoginCheckGet($format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->userLoginCheckGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();
my $format = format_example; # String | The format of the returend user login data.

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.UserApi()
format = format_example # String | The format of the returend user login data. (default to null)

try:
    # Get the login status of a user by the JWT token.
    api_response = api_instance.user_login_check_get(format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->userLoginCheckGet: %s\n" % e)
extern crate UserApi;

pub fn main() {
    let format = format_example; // String

    let mut context = UserApi::Context::default();
    let result = client.userLoginCheckGet(format, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
_format*
String
The format of the returend user login data.
Required

Responses


userLoginPost

Log in to the app.

Authenticate with username and password. Response flows: - TFA disabled (or not required for this user): 200 OK. Login is finalized and JWT tokens plus user object are returned. The property tfa_skips_allowed is not returned. - TFA enabled and user has not completed TFA setup, but skips are still allowed: 200 OK. Login is finalized and the property tfa_skips_allowed is returned with the number of skips left after this login. - TFA enabled and second-factor verification is required now: 202 Accepted. Submit the returned challenge_token together with a one-time code to /user-login/tfa to complete the login.


/user-login

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://nextworkplace.staging/api/v1/user-login?_format=format_example" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        String format = format_example; // String | The format of the returned user login data.
        UserLoginPostRequest userLoginPostRequest = ; // UserLoginPostRequest | 

        try {
            Login result = apiInstance.userLoginPost(format, userLoginPostRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#userLoginPost");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String format = new String(); // String | The format of the returned user login data.
final UserLoginPostRequest userLoginPostRequest = new UserLoginPostRequest(); // UserLoginPostRequest | 

try {
    final result = await api_instance.userLoginPost(format, userLoginPostRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->userLoginPost: $e\n');
}

import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        String format = format_example; // String | The format of the returned user login data.
        UserLoginPostRequest userLoginPostRequest = ; // UserLoginPostRequest | 

        try {
            Login result = apiInstance.userLoginPost(format, userLoginPostRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#userLoginPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];
String *format = format_example; // The format of the returned user login data. (default to null)
UserLoginPostRequest *userLoginPostRequest = ; // 

// Log in to the app.
[apiInstance userLoginPostWith:format
    userLoginPostRequest:userLoginPostRequest
              completionHandler: ^(Login output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.UserApi()
var format = format_example; // {String} The format of the returned user login data.
var userLoginPostRequest = ; // {UserLoginPostRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.userLoginPost(format, userLoginPostRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class userLoginPostExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new UserApi();
            var format = format_example;  // String | The format of the returned user login data. (default to null)
            var userLoginPostRequest = new UserLoginPostRequest(); // UserLoginPostRequest | 

            try {
                // Log in to the app.
                Login result = apiInstance.userLoginPost(format, userLoginPostRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.userLoginPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();
$format = format_example; // String | The format of the returned user login data.
$userLoginPostRequest = ; // UserLoginPostRequest | 

try {
    $result = $api_instance->userLoginPost($format, $userLoginPostRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->userLoginPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();
my $format = format_example; # String | The format of the returned user login data.
my $userLoginPostRequest = WWW::OPenAPIClient::Object::UserLoginPostRequest->new(); # UserLoginPostRequest | 

eval {
    my $result = $api_instance->userLoginPost(format => $format, userLoginPostRequest => $userLoginPostRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->userLoginPost: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.UserApi()
format = format_example # String | The format of the returned user login data. (default to null)
userLoginPostRequest =  # UserLoginPostRequest | 

try:
    # Log in to the app.
    api_response = api_instance.user_login_post(format, userLoginPostRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->userLoginPost: %s\n" % e)
extern crate UserApi;

pub fn main() {
    let format = format_example; // String
    let userLoginPostRequest = ; // UserLoginPostRequest

    let mut context = UserApi::Context::default();
    let result = client.userLoginPost(format, userLoginPostRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
userLoginPostRequest *

The users credentials.

Query parameters
Name Description
_format*
String
The format of the returned user login data.
Required

Responses


userLoginTfaPost

Complete two-factor authentication.

Submit a `challenge_token` (received from `POST /user-login`) together with the one-time `code` from the user's second-factor device. On success, the login is finalized and JWT tokens and user object are returned.


/user-login/tfa

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://nextworkplace.staging/api/v1/user-login/tfa?_format=format_example" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        String format = format_example; // String | 
        UserLoginTfaPostRequest userLoginTfaPostRequest = ; // UserLoginTfaPostRequest | 

        try {
            Login result = apiInstance.userLoginTfaPost(format, userLoginTfaPostRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#userLoginTfaPost");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String format = new String(); // String | 
final UserLoginTfaPostRequest userLoginTfaPostRequest = new UserLoginTfaPostRequest(); // UserLoginTfaPostRequest | 

try {
    final result = await api_instance.userLoginTfaPost(format, userLoginTfaPostRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->userLoginTfaPost: $e\n');
}

import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        String format = format_example; // String | 
        UserLoginTfaPostRequest userLoginTfaPostRequest = ; // UserLoginTfaPostRequest | 

        try {
            Login result = apiInstance.userLoginTfaPost(format, userLoginTfaPostRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#userLoginTfaPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];
String *format = format_example; //  (default to null)
UserLoginTfaPostRequest *userLoginTfaPostRequest = ; // 

// Complete two-factor authentication.
[apiInstance userLoginTfaPostWith:format
    userLoginTfaPostRequest:userLoginTfaPostRequest
              completionHandler: ^(Login output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.UserApi()
var format = format_example; // {String} 
var userLoginTfaPostRequest = ; // {UserLoginTfaPostRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.userLoginTfaPost(format, userLoginTfaPostRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class userLoginTfaPostExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new UserApi();
            var format = format_example;  // String |  (default to null)
            var userLoginTfaPostRequest = new UserLoginTfaPostRequest(); // UserLoginTfaPostRequest | 

            try {
                // Complete two-factor authentication.
                Login result = apiInstance.userLoginTfaPost(format, userLoginTfaPostRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.userLoginTfaPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();
$format = format_example; // String | 
$userLoginTfaPostRequest = ; // UserLoginTfaPostRequest | 

try {
    $result = $api_instance->userLoginTfaPost($format, $userLoginTfaPostRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->userLoginTfaPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();
my $format = format_example; # String | 
my $userLoginTfaPostRequest = WWW::OPenAPIClient::Object::UserLoginTfaPostRequest->new(); # UserLoginTfaPostRequest | 

eval {
    my $result = $api_instance->userLoginTfaPost(format => $format, userLoginTfaPostRequest => $userLoginTfaPostRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->userLoginTfaPost: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.UserApi()
format = format_example # String |  (default to null)
userLoginTfaPostRequest =  # UserLoginTfaPostRequest | 

try:
    # Complete two-factor authentication.
    api_response = api_instance.user_login_tfa_post(format, userLoginTfaPostRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->userLoginTfaPost: %s\n" % e)
extern crate UserApi;

pub fn main() {
    let format = format_example; // String
    let userLoginTfaPostRequest = ; // UserLoginTfaPostRequest

    let mut context = UserApi::Context::default();
    let result = client.userLoginTfaPost(format, userLoginTfaPostRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
userLoginTfaPostRequest *

Query parameters
Name Description
_format*
String
Required

Responses

Name Type Format Description
Retry-After Integer Number of seconds to wait before retrying.

userLogoutPost

Log out of the app.

Log out a user by sending the current access token and refresh token to invalidate them.


/user-logout

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://nextworkplace.staging/api/v1/user-logout" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        UserLogoutPostRequest userLogoutPostRequest = ; // UserLogoutPostRequest | 

        try {
            apiInstance.userLogoutPost(userLogoutPostRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#userLogoutPost");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UserLogoutPostRequest userLogoutPostRequest = new UserLogoutPostRequest(); // UserLogoutPostRequest | 

try {
    final result = await api_instance.userLogoutPost(userLogoutPostRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->userLogoutPost: $e\n');
}

import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        UserLogoutPostRequest userLogoutPostRequest = ; // UserLogoutPostRequest | 

        try {
            apiInstance.userLogoutPost(userLogoutPostRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#userLogoutPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];
UserLogoutPostRequest *userLogoutPostRequest = ; // 

// Log out of the app.
[apiInstance userLogoutPostWith:userLogoutPostRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.UserApi()
var userLogoutPostRequest = ; // {UserLogoutPostRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.userLogoutPost(userLogoutPostRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class userLogoutPostExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new UserApi();
            var userLogoutPostRequest = new UserLogoutPostRequest(); // UserLogoutPostRequest | 

            try {
                // Log out of the app.
                apiInstance.userLogoutPost(userLogoutPostRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.userLogoutPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();
$userLogoutPostRequest = ; // UserLogoutPostRequest | 

try {
    $api_instance->userLogoutPost($userLogoutPostRequest);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->userLogoutPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();
my $userLogoutPostRequest = WWW::OPenAPIClient::Object::UserLogoutPostRequest->new(); # UserLogoutPostRequest | 

eval {
    $api_instance->userLogoutPost(userLogoutPostRequest => $userLogoutPostRequest);
};
if ($@) {
    warn "Exception when calling UserApi->userLogoutPost: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.UserApi()
userLogoutPostRequest =  # UserLogoutPostRequest | 

try:
    # Log out of the app.
    api_instance.user_logout_post(userLogoutPostRequest)
except ApiException as e:
    print("Exception when calling UserApi->userLogoutPost: %s\n" % e)
extern crate UserApi;

pub fn main() {
    let userLogoutPostRequest = ; // UserLogoutPostRequest

    let mut context = UserApi::Context::default();
    let result = client.userLogoutPost(userLogoutPostRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
userLogoutPostRequest *

The tokens to invalidate.

Responses


userLogoutPost_1

Log out via session-based authentication.

Session-based logout endpoint. Invalidates the current session. Requires the per-session logout token supplied by /user_session endpoint. Pass `_format=json` to receive a JSON response instead of an HTML redirect.


/user/logout

Usage and SDK Samples

curl -X POST \
 "https://nextworkplace.staging/api/v1/user/logout?token=abcdefgh1234&_format=format_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        String token = abcdefgh1234; // String | The logout token issued for the current session.
        String format = format_example; // String | Response format.

        try {
            apiInstance.userLogoutPost_0(token, format);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#userLogoutPost_0");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String token = new String(); // String | The logout token issued for the current session.
final String format = new String(); // String | Response format.

try {
    final result = await api_instance.userLogoutPost_0(token, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->userLogoutPost_0: $e\n');
}

import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        String token = abcdefgh1234; // String | The logout token issued for the current session.
        String format = format_example; // String | Response format.

        try {
            apiInstance.userLogoutPost_0(token, format);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#userLogoutPost_0");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];
String *token = abcdefgh1234; // The logout token issued for the current session. (default to null)
String *format = format_example; // Response format. (optional) (default to null)

// Log out via session-based authentication.
[apiInstance userLogoutPost_1With:token
    format:format
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');

// Create an instance of the API class
var api = new PiipeApi.UserApi()
var token = abcdefgh1234; // {String} The logout token issued for the current session.
var opts = {
  'format': format_example // {String} Response format.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.userLogoutPost_0(token, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class userLogoutPost_0Example
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UserApi();
            var token = abcdefgh1234;  // String | The logout token issued for the current session. (default to null)
            var format = format_example;  // String | Response format. (optional)  (default to null)

            try {
                // Log out via session-based authentication.
                apiInstance.userLogoutPost_0(token, format);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.userLogoutPost_0: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();
$token = abcdefgh1234; // String | The logout token issued for the current session.
$format = format_example; // String | Response format.

try {
    $api_instance->userLogoutPost_0($token, $format);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->userLogoutPost_0: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();
my $token = abcdefgh1234; # String | The logout token issued for the current session.
my $format = format_example; # String | Response format.

eval {
    $api_instance->userLogoutPost_0(token => $token, format => $format);
};
if ($@) {
    warn "Exception when calling UserApi->userLogoutPost_0: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.UserApi()
token = abcdefgh1234 # String | The logout token issued for the current session. (default to null)
format = format_example # String | Response format. (optional) (default to null)

try:
    # Log out via session-based authentication.
    api_instance.user_logout_post_0(token, format=format)
except ApiException as e:
    print("Exception when calling UserApi->userLogoutPost_0: %s\n" % e)
extern crate UserApi;

pub fn main() {
    let token = abcdefgh1234; // String
    let format = format_example; // String

    let mut context = UserApi::Context::default();
    let result = client.userLogoutPost_0(token, format, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
token*
String
The logout token issued for the current session.
Required
_format
String
Response format.

Responses


userProfileEditUidGet

Get user profile edit form data.

Returns edit form data for a user profile. The response shape depends on the API version: - **v1** (`/api/v1/user_profile/edit/{uid}`) – sections and fields are returned as separate keyed objects under `profile`. Fields include edit-specific properties: `private`, `required`, `options`, and `placeholder`. - **v2** (`/api/v2/user_profile/edit/{uid}`) – sections are returned as an ordered array under `profile.sections`, each containing a nested `fields` array sorted by weight.


/user_profile/edit/{uid}

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/user_profile/edit/{uid}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        Integer uid = 56; // Integer | The user ID.

        try {
            _user_profile_edit__uid__get_200_response result = apiInstance.userProfileEditUidGet(uid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#userProfileEditUidGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer uid = new Integer(); // Integer | The user ID.

try {
    final result = await api_instance.userProfileEditUidGet(uid);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->userProfileEditUidGet: $e\n');
}

import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        Integer uid = 56; // Integer | The user ID.

        try {
            _user_profile_edit__uid__get_200_response result = apiInstance.userProfileEditUidGet(uid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#userProfileEditUidGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];
Integer *uid = 56; // The user ID. (default to null)

// Get user profile edit form data.
[apiInstance userProfileEditUidGetWith:uid
              completionHandler: ^(_user_profile_edit__uid__get_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.UserApi()
var uid = 56; // {Integer} The user ID.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.userProfileEditUidGet(uid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class userProfileEditUidGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new UserApi();
            var uid = 56;  // Integer | The user ID. (default to null)

            try {
                // Get user profile edit form data.
                _user_profile_edit__uid__get_200_response result = apiInstance.userProfileEditUidGet(uid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.userProfileEditUidGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();
$uid = 56; // Integer | The user ID.

try {
    $result = $api_instance->userProfileEditUidGet($uid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->userProfileEditUidGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();
my $uid = 56; # Integer | The user ID.

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.UserApi()
uid = 56 # Integer | The user ID. (default to null)

try:
    # Get user profile edit form data.
    api_response = api_instance.user_profile_edit_uid_get(uid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->userProfileEditUidGet: %s\n" % e)
extern crate UserApi;

pub fn main() {
    let uid = 56; // Integer

    let mut context = UserApi::Context::default();
    let result = client.userProfileEditUidGet(uid, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
uid*
Integer
The user ID.
Required

Responses


userProfileEditUidPatch

Edit user profile.

Updates a user's profile fields and/or profile image. The response depends on the API version: - **v1** (`/api/v1/user_profile/edit/{uid}`) - returns the updated profile - **v2** (`/api/v2/user_profile/edit/{uid}`) - returns the full updated user profile in the same structure as `GET /api/v2/user_profile/{uid}`


/user_profile/edit/{uid}

Usage and SDK Samples

curl -X PATCH \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://nextworkplace.staging/api/v1/user_profile/edit/{uid}" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        Integer uid = 56; // Integer | The user ID.
        UserProfileEditUidPatchRequest userProfileEditUidPatchRequest = ; // UserProfileEditUidPatchRequest | 

        try {
            _user_profile_edit__uid__patch_200_response result = apiInstance.userProfileEditUidPatch(uid, userProfileEditUidPatchRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#userProfileEditUidPatch");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer uid = new Integer(); // Integer | The user ID.
final UserProfileEditUidPatchRequest userProfileEditUidPatchRequest = new UserProfileEditUidPatchRequest(); // UserProfileEditUidPatchRequest | 

try {
    final result = await api_instance.userProfileEditUidPatch(uid, userProfileEditUidPatchRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->userProfileEditUidPatch: $e\n');
}

import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        Integer uid = 56; // Integer | The user ID.
        UserProfileEditUidPatchRequest userProfileEditUidPatchRequest = ; // UserProfileEditUidPatchRequest | 

        try {
            _user_profile_edit__uid__patch_200_response result = apiInstance.userProfileEditUidPatch(uid, userProfileEditUidPatchRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#userProfileEditUidPatch");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];
Integer *uid = 56; // The user ID. (default to null)
UserProfileEditUidPatchRequest *userProfileEditUidPatchRequest = ; // 

// Edit user profile.
[apiInstance userProfileEditUidPatchWith:uid
    userProfileEditUidPatchRequest:userProfileEditUidPatchRequest
              completionHandler: ^(_user_profile_edit__uid__patch_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.UserApi()
var uid = 56; // {Integer} The user ID.
var userProfileEditUidPatchRequest = ; // {UserProfileEditUidPatchRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.userProfileEditUidPatch(uid, userProfileEditUidPatchRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class userProfileEditUidPatchExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new UserApi();
            var uid = 56;  // Integer | The user ID. (default to null)
            var userProfileEditUidPatchRequest = new UserProfileEditUidPatchRequest(); // UserProfileEditUidPatchRequest | 

            try {
                // Edit user profile.
                _user_profile_edit__uid__patch_200_response result = apiInstance.userProfileEditUidPatch(uid, userProfileEditUidPatchRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.userProfileEditUidPatch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();
$uid = 56; // Integer | The user ID.
$userProfileEditUidPatchRequest = ; // UserProfileEditUidPatchRequest | 

try {
    $result = $api_instance->userProfileEditUidPatch($uid, $userProfileEditUidPatchRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->userProfileEditUidPatch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();
my $uid = 56; # Integer | The user ID.
my $userProfileEditUidPatchRequest = WWW::OPenAPIClient::Object::UserProfileEditUidPatchRequest->new(); # UserProfileEditUidPatchRequest | 

eval {
    my $result = $api_instance->userProfileEditUidPatch(uid => $uid, userProfileEditUidPatchRequest => $userProfileEditUidPatchRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->userProfileEditUidPatch: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.UserApi()
uid = 56 # Integer | The user ID. (default to null)
userProfileEditUidPatchRequest =  # UserProfileEditUidPatchRequest | 

try:
    # Edit user profile.
    api_response = api_instance.user_profile_edit_uid_patch(uid, userProfileEditUidPatchRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->userProfileEditUidPatch: %s\n" % e)
extern crate UserApi;

pub fn main() {
    let uid = 56; // Integer
    let userProfileEditUidPatchRequest = ; // UserProfileEditUidPatchRequest

    let mut context = UserApi::Context::default();
    let result = client.userProfileEditUidPatch(uid, userProfileEditUidPatchRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
uid*
Integer
The user ID.
Required
Body parameters
Name Description
userProfileEditUidPatchRequest *

Edit fields, profile image or both.

Responses


userProfileUidGet

Get user profile.

Returns the user profile for the given user ID. The response shape depends on the API version prefix used in the URL: - **v1** (`/api/v1/user_profile/{uid}`) – sections and fields are returned as separate keyed objects. Fields reference their parent section via the `parent` property. - **v2** (`/api/v2/user_profile/{uid}`) – sections are returned as an ordered array, each containing a nested `fields` array. Entity reference fields with `taxonomy_link` enabled include a `route_name` property.


/user_profile/{uid}

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/user_profile/{uid}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        Integer uid = 56; // Integer | The user ID.

        try {
            _user_profile__uid__get_200_response result = apiInstance.userProfileUidGet(uid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#userProfileUidGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer uid = new Integer(); // Integer | The user ID.

try {
    final result = await api_instance.userProfileUidGet(uid);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->userProfileUidGet: $e\n');
}

import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        Integer uid = 56; // Integer | The user ID.

        try {
            _user_profile__uid__get_200_response result = apiInstance.userProfileUidGet(uid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#userProfileUidGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];
Integer *uid = 56; // The user ID. (default to null)

// Get user profile.
[apiInstance userProfileUidGetWith:uid
              completionHandler: ^(_user_profile__uid__get_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.UserApi()
var uid = 56; // {Integer} The user ID.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.userProfileUidGet(uid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class userProfileUidGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new UserApi();
            var uid = 56;  // Integer | The user ID. (default to null)

            try {
                // Get user profile.
                _user_profile__uid__get_200_response result = apiInstance.userProfileUidGet(uid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.userProfileUidGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();
$uid = 56; // Integer | The user ID.

try {
    $result = $api_instance->userProfileUidGet($uid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->userProfileUidGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();
my $uid = 56; # Integer | The user ID.

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.UserApi()
uid = 56 # Integer | The user ID. (default to null)

try:
    # Get user profile.
    api_response = api_instance.user_profile_uid_get(uid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->userProfileUidGet: %s\n" % e)
extern crate UserApi;

pub fn main() {
    let uid = 56; // Integer

    let mut context = UserApi::Context::default();
    let result = client.userProfileUidGet(uid, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
uid*
Integer
The user ID.
Required

Responses


userRegisterPost

Register a new user (Note: this endpoint doesn't have the prefix /api/v1 in the base URL).

Create a new user account.


/user/register

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://nextworkplace.staging/api/v1/user/register?_format=format_example" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        String format = format_example; // String | The format of the returend user login data.
        UserRegisterPostRequest userRegisterPostRequest = ; // UserRegisterPostRequest | 

        try {
            apiInstance.userRegisterPost(format, userRegisterPostRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#userRegisterPost");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String format = new String(); // String | The format of the returend user login data.
final UserRegisterPostRequest userRegisterPostRequest = new UserRegisterPostRequest(); // UserRegisterPostRequest | 

try {
    final result = await api_instance.userRegisterPost(format, userRegisterPostRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->userRegisterPost: $e\n');
}

import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        String format = format_example; // String | The format of the returend user login data.
        UserRegisterPostRequest userRegisterPostRequest = ; // UserRegisterPostRequest | 

        try {
            apiInstance.userRegisterPost(format, userRegisterPostRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#userRegisterPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];
String *format = format_example; // The format of the returend user login data. (default to null)
UserRegisterPostRequest *userRegisterPostRequest = ; // 

// Register a new user (Note: this endpoint doesn't have the prefix /api/v1 in the base URL).
[apiInstance userRegisterPostWith:format
    userRegisterPostRequest:userRegisterPostRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.UserApi()
var format = format_example; // {String} The format of the returend user login data.
var userRegisterPostRequest = ; // {UserRegisterPostRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.userRegisterPost(format, userRegisterPostRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class userRegisterPostExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new UserApi();
            var format = format_example;  // String | The format of the returend user login data. (default to null)
            var userRegisterPostRequest = new UserRegisterPostRequest(); // UserRegisterPostRequest | 

            try {
                // Register a new user (Note: this endpoint doesn't have the prefix /api/v1 in the base URL).
                apiInstance.userRegisterPost(format, userRegisterPostRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.userRegisterPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();
$format = format_example; // String | The format of the returend user login data.
$userRegisterPostRequest = ; // UserRegisterPostRequest | 

try {
    $api_instance->userRegisterPost($format, $userRegisterPostRequest);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->userRegisterPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();
my $format = format_example; # String | The format of the returend user login data.
my $userRegisterPostRequest = WWW::OPenAPIClient::Object::UserRegisterPostRequest->new(); # UserRegisterPostRequest | 

eval {
    $api_instance->userRegisterPost(format => $format, userRegisterPostRequest => $userRegisterPostRequest);
};
if ($@) {
    warn "Exception when calling UserApi->userRegisterPost: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.UserApi()
format = format_example # String | The format of the returend user login data. (default to null)
userRegisterPostRequest =  # UserRegisterPostRequest | 

try:
    # Register a new user (Note: this endpoint doesn't have the prefix /api/v1 in the base URL).
    api_instance.user_register_post(format, userRegisterPostRequest)
except ApiException as e:
    print("Exception when calling UserApi->userRegisterPost: %s\n" % e)
extern crate UserApi;

pub fn main() {
    let format = format_example; // String
    let userRegisterPostRequest = ; // UserRegisterPostRequest

    let mut context = UserApi::Context::default();
    let result = client.userRegisterPost(format, userRegisterPostRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
userRegisterPostRequest *

The user required data for registration.

Query parameters
Name Description
_format*
String
The format of the returend user login data.
Required

Responses


userSessionGet

Create a Drupal session for the authenticated user.

Finalizes a Drupal web session for the currently authenticated user and returns CSRF and logout tokens required for cookie-based session actions.


/user_session

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/user_session"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        UserApi apiInstance = new UserApi();

        try {
            _user_session_get_200_response result = apiInstance.userSessionGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#userSessionGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.userSessionGet();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->userSessionGet: $e\n');
}

import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();

        try {
            _user_session_get_200_response result = apiInstance.userSessionGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#userSessionGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];

// Create a Drupal session for the authenticated user.
[apiInstance userSessionGetWithCompletionHandler: 
              ^(_user_session_get_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.UserApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.userSessionGet(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class userSessionGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new UserApi();

            try {
                // Create a Drupal session for the authenticated user.
                _user_session_get_200_response result = apiInstance.userSessionGet();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.userSessionGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.UserApi()

try:
    # Create a Drupal session for the authenticated user.
    api_response = api_instance.user_session_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->userSessionGet: %s\n" % e)
extern crate UserApi;

pub fn main() {

    let mut context = UserApi::Context::default();
    let result = client.userSessionGet(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
Set-Cookie String Contains the Drupal session cookie.


userSettingsGet

Get user settings.

Each setting has a unique identifier that has to be passed in the patch request.


/user_settings

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://nextworkplace.staging/api/v1/user_settings"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        UserApi apiInstance = new UserApi();

        try {
            array[User-Settings] result = apiInstance.userSettingsGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#userSettingsGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.userSettingsGet();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->userSettingsGet: $e\n');
}

import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();

        try {
            array[User-Settings] result = apiInstance.userSettingsGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#userSettingsGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];

// Get user settings.
[apiInstance userSettingsGetWithCompletionHandler: 
              ^(array[User-Settings] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.UserApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.userSettingsGet(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class userSettingsGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new UserApi();

            try {
                // Get user settings.
                array[User-Settings] result = apiInstance.userSettingsGet();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.userSettingsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();

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

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.UserApi()

try:
    # Get user settings.
    api_response = api_instance.user_settings_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->userSettingsGet: %s\n" % e)
extern crate UserApi;

pub fn main() {

    let mut context = UserApi::Context::default();
    let result = client.userSettingsGet(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


userSettingsPatch

Apply user setting.

Each setting have a certain request body structure.


/user_settings

Usage and SDK Samples

curl -X PATCH \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://nextworkplace.staging/api/v1/user_settings" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
        HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
        JWT-Bearer.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        UserSettingsPatchRequest userSettingsPatchRequest = ; // UserSettingsPatchRequest | 

        try {
            apiInstance.userSettingsPatch(userSettingsPatchRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#userSettingsPatch");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UserSettingsPatchRequest userSettingsPatchRequest = new UserSettingsPatchRequest(); // UserSettingsPatchRequest | 

try {
    final result = await api_instance.userSettingsPatch(userSettingsPatchRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->userSettingsPatch: $e\n');
}

import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        UserSettingsPatchRequest userSettingsPatchRequest = ; // UserSettingsPatchRequest | 

        try {
            apiInstance.userSettingsPatch(userSettingsPatchRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#userSettingsPatch");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];
UserSettingsPatchRequest *userSettingsPatchRequest = ; // 

// Apply user setting.
[apiInstance userSettingsPatchWith:userSettingsPatchRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new PiipeApi.UserApi()
var userSettingsPatchRequest = ; // {UserSettingsPatchRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.userSettingsPatch(userSettingsPatchRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class userSettingsPatchExample
    {
        public void main()
        {
            // Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new UserApi();
            var userSettingsPatchRequest = new UserSettingsPatchRequest(); // UserSettingsPatchRequest | 

            try {
                // Apply user setting.
                apiInstance.userSettingsPatch(userSettingsPatchRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.userSettingsPatch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();
$userSettingsPatchRequest = ; // UserSettingsPatchRequest | 

try {
    $api_instance->userSettingsPatch($userSettingsPatchRequest);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->userSettingsPatch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();
my $userSettingsPatchRequest = WWW::OPenAPIClient::Object::UserSettingsPatchRequest->new(); # UserSettingsPatchRequest | 

eval {
    $api_instance->userSettingsPatch(userSettingsPatchRequest => $userSettingsPatchRequest);
};
if ($@) {
    warn "Exception when calling UserApi->userSettingsPatch: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.UserApi()
userSettingsPatchRequest =  # UserSettingsPatchRequest | 

try:
    # Apply user setting.
    api_instance.user_settings_patch(userSettingsPatchRequest)
except ApiException as e:
    print("Exception when calling UserApi->userSettingsPatch: %s\n" % e)
extern crate UserApi;

pub fn main() {
    let userSettingsPatchRequest = ; // UserSettingsPatchRequest

    let mut context = UserApi::Context::default();
    let result = client.userSettingsPatch(userSettingsPatchRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
userSettingsPatchRequest *

The user setting to be applied.

Responses