条件ごとで利用中ユーザー検索できるAPIです.ログインユーザーを習得するのは不可能です。無効でないユーザーのみが取得されますが、クエリパラメータにinclude_deleted_user=trueを指定した場合は無効ユーザーも取得されます。
curl -X GET\
-H "Accept: application/json"\
"http://HOSTNAME/api/v1/view/user?page_number=&page_size=&first_name=&email_address=&search_text=&is_otp=&position=&department=&sort=&include_deleted_user="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.APIsApi;
import java.io.File;
import java.util.*;
public class APIsApiExample {
public static void main(String[] args) {
APIsApi apiInstance = new APIsApi();
String userType = userType_example; // String | ログインユーザーType
String userId = userId_example; // String | ログインユーザーID
String companyId = companyId_example; // String | ログインユーザーの会社ID
Integer pageNumber = 56; // Integer |
Integer pageSize = 56; // Integer |
String firstName = firstName_example; // String |
String emailAddress = emailAddress_example; // String |
String searchText = searchText_example; // String |
String isOtp = isOtp_example; // String | 2段階認証フラグ
String position = position_example; // String |
String department = department_example; // String |
array[String] sort = ; // array[String] |
Boolean includeDeletedUser = true; // Boolean | trueを指定した場合、削除済みユーザーも検索結果に含めます。true以外を指定する、もしくはinclude_deleted_user自体をクエリに含まない場合は、削除済みユーザーは検索結果に含みません。
try {
UserInitialInfoPaginationSwaggerResponseDto result = apiInstance.getUsers1(userType, userId, companyId, pageNumber, pageSize, firstName, emailAddress, searchText, isOtp, position, department, sort, includeDeletedUser);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling APIsApi#getUsers1");
e.printStackTrace();
}
}
}
import io.swagger.client.api.APIsApi;
public class APIsApiExample {
public static void main(String[] args) {
APIsApi apiInstance = new APIsApi();
String userType = userType_example; // String | ログインユーザーType
String userId = userId_example; // String | ログインユーザーID
String companyId = companyId_example; // String | ログインユーザーの会社ID
Integer pageNumber = 56; // Integer |
Integer pageSize = 56; // Integer |
String firstName = firstName_example; // String |
String emailAddress = emailAddress_example; // String |
String searchText = searchText_example; // String |
String isOtp = isOtp_example; // String | 2段階認証フラグ
String position = position_example; // String |
String department = department_example; // String |
array[String] sort = ; // array[String] |
Boolean includeDeletedUser = true; // Boolean | trueを指定した場合、削除済みユーザーも検索結果に含めます。true以外を指定する、もしくはinclude_deleted_user自体をクエリに含まない場合は、削除済みユーザーは検索結果に含みません。
try {
UserInitialInfoPaginationSwaggerResponseDto result = apiInstance.getUsers1(userType, userId, companyId, pageNumber, pageSize, firstName, emailAddress, searchText, isOtp, position, department, sort, includeDeletedUser);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling APIsApi#getUsers1");
e.printStackTrace();
}
}
}
String *userType = userType_example; // ログインユーザーType (optional)
String *userId = userId_example; // ログインユーザーID (optional)
String *companyId = companyId_example; // ログインユーザーの会社ID (optional)
Integer *pageNumber = 56; // (optional)
Integer *pageSize = 56; // (optional)
String *firstName = firstName_example; // (optional)
String *emailAddress = emailAddress_example; // (optional)
String *searchText = searchText_example; // (optional)
String *isOtp = isOtp_example; // 2段階認証フラグ (optional)
String *position = position_example; // (optional)
String *department = department_example; // (optional)
array[String] *sort = ; // (optional)
Boolean *includeDeletedUser = true; // trueを指定した場合、削除済みユーザーも検索結果に含めます。true以外を指定する、もしくはinclude_deleted_user自体をクエリに含まない場合は、削除済みユーザーは検索結果に含みません。 (optional)
APIsApi *apiInstance = [[APIsApi alloc] init];
// ユーザー検索
[apiInstance getUsers1With:userType
userId:userId
companyId:companyId
pageNumber:pageNumber
pageSize:pageSize
firstName:firstName
emailAddress:emailAddress
searchText:searchText
isOtp:isOtp
position:position
department:department
sort:sort
includeDeletedUser:includeDeletedUser
completionHandler: ^(UserInitialInfoPaginationSwaggerResponseDto output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var OnboardingService = require('onboarding_service');
var api = new OnboardingService.APIsApi()
var opts = {
'userType': userType_example, // {{String}} ログインユーザーType
'userId': userId_example, // {{String}} ログインユーザーID
'companyId': companyId_example, // {{String}} ログインユーザーの会社ID
'pageNumber': 56, // {{Integer}}
'pageSize': 56, // {{Integer}}
'firstName': firstName_example, // {{String}}
'emailAddress': emailAddress_example, // {{String}}
'searchText': searchText_example, // {{String}}
'isOtp': isOtp_example, // {{String}} 2段階認証フラグ
'position': position_example, // {{String}}
'department': department_example, // {{String}}
'sort': , // {{array[String]}}
'includeDeletedUser': true // {{Boolean}} trueを指定した場合、削除済みユーザーも検索結果に含めます。true以外を指定する、もしくはinclude_deleted_user自体をクエリに含まない場合は、削除済みユーザーは検索結果に含みません。
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getUsers1(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class getUsers1Example
{
public void main()
{
var apiInstance = new APIsApi();
var userType = userType_example; // String | ログインユーザーType (optional)
var userId = userId_example; // String | ログインユーザーID (optional)
var companyId = companyId_example; // String | ログインユーザーの会社ID (optional)
var pageNumber = 56; // Integer | (optional)
var pageSize = 56; // Integer | (optional)
var firstName = firstName_example; // String | (optional)
var emailAddress = emailAddress_example; // String | (optional)
var searchText = searchText_example; // String | (optional)
var isOtp = isOtp_example; // String | 2段階認証フラグ (optional)
var position = position_example; // String | (optional)
var department = department_example; // String | (optional)
var sort = new array[String](); // array[String] | (optional)
var includeDeletedUser = true; // Boolean | trueを指定した場合、削除済みユーザーも検索結果に含めます。true以外を指定する、もしくはinclude_deleted_user自体をクエリに含まない場合は、削除済みユーザーは検索結果に含みません。 (optional)
try
{
// ユーザー検索
UserInitialInfoPaginationSwaggerResponseDto result = apiInstance.getUsers1(userType, userId, companyId, pageNumber, pageSize, firstName, emailAddress, searchText, isOtp, position, department, sort, includeDeletedUser);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling APIsApi.getUsers1: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\ApiAPIsApi();
$userType = userType_example; // String | ログインユーザーType
$userId = userId_example; // String | ログインユーザーID
$companyId = companyId_example; // String | ログインユーザーの会社ID
$pageNumber = 56; // Integer |
$pageSize = 56; // Integer |
$firstName = firstName_example; // String |
$emailAddress = emailAddress_example; // String |
$searchText = searchText_example; // String |
$isOtp = isOtp_example; // String | 2段階認証フラグ
$position = position_example; // String |
$department = department_example; // String |
$sort = ; // array[String] |
$includeDeletedUser = true; // Boolean | trueを指定した場合、削除済みユーザーも検索結果に含めます。true以外を指定する、もしくはinclude_deleted_user自体をクエリに含まない場合は、削除済みユーザーは検索結果に含みません。
try {
$result = $api_instance->getUsers1($userType, $userId, $companyId, $pageNumber, $pageSize, $firstName, $emailAddress, $searchText, $isOtp, $position, $department, $sort, $includeDeletedUser);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling APIsApi->getUsers1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::APIsApi;
my $api_instance = WWW::SwaggerClient::APIsApi->new();
my $userType = userType_example; # String | ログインユーザーType
my $userId = userId_example; # String | ログインユーザーID
my $companyId = companyId_example; # String | ログインユーザーの会社ID
my $pageNumber = 56; # Integer |
my $pageSize = 56; # Integer |
my $firstName = firstName_example; # String |
my $emailAddress = emailAddress_example; # String |
my $searchText = searchText_example; # String |
my $isOtp = isOtp_example; # String | 2段階認証フラグ
my $position = position_example; # String |
my $department = department_example; # String |
my $sort = []; # array[String] |
my $includeDeletedUser = true; # Boolean | trueを指定した場合、削除済みユーザーも検索結果に含めます。true以外を指定する、もしくはinclude_deleted_user自体をクエリに含まない場合は、削除済みユーザーは検索結果に含みません。
eval {
my $result = $api_instance->getUsers1(userType => $userType, userId => $userId, companyId => $companyId, pageNumber => $pageNumber, pageSize => $pageSize, firstName => $firstName, emailAddress => $emailAddress, searchText => $searchText, isOtp => $isOtp, position => $position, department => $department, sort => $sort, includeDeletedUser => $includeDeletedUser);
print Dumper($result);
};
if ($@) {
warn "Exception when calling APIsApi->getUsers1: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.APIsApi()
userType = userType_example # String | ログインユーザーType (optional)
userId = userId_example # String | ログインユーザーID (optional)
companyId = companyId_example # String | ログインユーザーの会社ID (optional)
pageNumber = 56 # Integer | (optional)
pageSize = 56 # Integer | (optional)
firstName = firstName_example # String | (optional)
emailAddress = emailAddress_example # String | (optional)
searchText = searchText_example # String | (optional)
isOtp = isOtp_example # String | 2段階認証フラグ (optional)
position = position_example # String | (optional)
department = department_example # String | (optional)
sort = # array[String] | (optional)
includeDeletedUser = true # Boolean | trueを指定した場合、削除済みユーザーも検索結果に含めます。true以外を指定する、もしくはinclude_deleted_user自体をクエリに含まない場合は、削除済みユーザーは検索結果に含みません。 (optional)
try:
# ユーザー検索
api_response = api_instance.get_users1(userType=userType, userId=userId, companyId=companyId, pageNumber=pageNumber, pageSize=pageSize, firstName=firstName, emailAddress=emailAddress, searchText=searchText, isOtp=isOtp, position=position, department=department, sort=sort, includeDeletedUser=includeDeletedUser)
pprint(api_response)
except ApiException as e:
print("Exception when calling APIsApi->getUsers1: %s\n" % e)