Skip to content

README.md

Latest commit

 

History

History
328 lines (258 loc) · 17.6 KB

README.md

File metadata and controls

328 lines (258 loc) · 17.6 KB

RequestLogs

Overview

API requests and response logs.

Available Operations

listStepLogs

List Step Logs

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use StackOne\client;
use StackOne\client\Models\Components;
use StackOne\client\Models\Operations;
use StackOne\client\Utils;

$sdk = client\StackOne::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();

$request = new Operations\StackoneListStepLogsRequest(
    orderBy: Operations\OrderBy::EventDatetime,
    orderDirection: Operations\OrderDirection::Asc,
    filter: new Operations\Filter(
        accountIds: '45355976281015164504,45355976281015164505',
        startDate: Utils\Utils::parseDateTime('2020-01-01T00:00:00.000Z'),
        endDate: Utils\Utils::parseDateTime('2020-01-01T00:00:00.000Z'),
        requestIds: 'adbf752f-6457-4ddd-89b3-98ae2252b83b,adbf752f-6457-4ddd-89b3-98ae2252b83c',
        httpMethods: 'GET,POST',
        providers: 'ashby,greenhouse',
        services: 'hris,ats',
        resources: 'employees,users',
        childResources: 'documents,time-off',
        subResources: 'documents,employees',
        actions: 'download,upload',
        statusCodes: '200,400',
        success: true,
    ),
);

$response = $sdk->requestLogs->listStepLogs(
    request: $request
);

if ($response->stepLogsPaginated !== null) {
    // handle response
}

Parameters

Parameter Type Required Description
$request Operations\StackoneListStepLogsRequest ✔️ The request object to use for the request.

Response

?Operations\StackoneListStepLogsResponse

Errors

Error Type Status Code Content Type
Errors\BadRequestResponse 400 application/json
Errors\UnauthorizedResponse 401 application/json
Errors\ForbiddenResponse 403 application/json
Errors\NotFoundResponse 404 application/json
Errors\RequestTimedOutResponse 408 application/json
Errors\ConflictResponse 409 application/json
Errors\UnprocessableEntityResponse 422 application/json
Errors\TooManyRequestsResponse 429 application/json
Errors\InternalServerErrorResponse 500 application/json
Errors\NotImplementedResponse 501 application/json
Errors\BadGatewayResponse 502 application/json
Errors\SDKException 4XX, 5XX */*

getLog

Get Log

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use StackOne\client;
use StackOne\client\Models\Components;
use StackOne\client\Models\Operations;

$sdk = client\StackOne::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();



$response = $sdk->requestLogs->getLog(
    id: '<id>',
    include: Operations\IncludeT::StepLogs

);

if ($response->unifiedLogResult !== null) {
    // handle response
}

Parameters

Parameter Type Required Description Example
id string ✔️ N/A
include ?Operations\IncludeT ➖ The include parameter allows you to include additional data in the response. step_logs

Response

?Operations\StackoneGetLogResponse

Errors

Error Type Status Code Content Type
Errors\BadRequestResponse 400 application/json
Errors\UnauthorizedResponse 401 application/json
Errors\ForbiddenResponse 403 application/json
Errors\NotFoundResponse 404 application/json
Errors\RequestTimedOutResponse 408 application/json
Errors\ConflictResponse 409 application/json
Errors\UnprocessableEntityResponse 422 application/json
Errors\TooManyRequestsResponse 429 application/json
Errors\InternalServerErrorResponse 500 application/json
Errors\NotImplementedResponse 501 application/json
Errors\BadGatewayResponse 502 application/json
Errors\SDKException 4XX, 5XX */*

listLogs

List Logs

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use StackOne\client;
use StackOne\client\Models\Components;
use StackOne\client\Models\Operations;
use StackOne\client\Utils;

$sdk = client\StackOne::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();

$request = new Operations\StackoneListLogsRequest(
    orderBy: Operations\QueryParamOrderBy::Duration,
    orderDirection: Operations\QueryParamOrderDirection::Asc,
    include: Operations\QueryParamInclude::StepLogs,
    filter: new Operations\QueryParamFilter(
        accountIds: '45355976281015164504,45355976281015164505',
        startDate: Utils\Utils::parseDateTime('2020-01-01T00:00:00.000Z'),
        endDate: Utils\Utils::parseDateTime('2020-01-01T00:00:00.000Z'),
        requestIds: 'adbf752f-6457-4ddd-89b3-98ae2252b83b,adbf752f-6457-4ddd-89b3-98ae2252b83c',
        sourceTypes: 'DASHBOARD,SYNTHETIC_WEBHOOK',
        httpMethods: 'GET,POST',
        providers: 'ashby,greenhouse',
        services: 'hris,ats',
        resources: 'employees,users',
        childResources: 'documents,time-off',
        subResources: 'documents,employees',
        actions: 'download,upload',
        statusCodes: '200,400',
        success: true,
        orderBy: Operations\StackoneListLogsQueryParamOrderBy::Duration,
        orderDirection: Operations\StackoneListLogsQueryParamOrderDirection::Asc,
    ),
);

$response = $sdk->requestLogs->listLogs(
    request: $request
);

if ($response->unifiedLogsPaginated !== null) {
    // handle response
}

Parameters

Parameter Type Required Description
$request Operations\StackoneListLogsRequest ✔️ The request object to use for the request.

Response

?Operations\StackoneListLogsResponse

Errors

Error Type Status Code Content Type
Errors\BadRequestResponse 400 application/json
Errors\UnauthorizedResponse 401 application/json
Errors\ForbiddenResponse 403 application/json
Errors\NotFoundResponse 404 application/json
Errors\RequestTimedOutResponse 408 application/json
Errors\ConflictResponse 409 application/json
Errors\UnprocessableEntityResponse 422 application/json
Errors\TooManyRequestsResponse 429 application/json
Errors\InternalServerErrorResponse 500 application/json
Errors\NotImplementedResponse 501 application/json
Errors\BadGatewayResponse 502 application/json
Errors\SDKException 4XX, 5XX */*

listPlatformLogs

List Platform Logs

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use StackOne\client;
use StackOne\client\Models\Components;
use StackOne\client\Models\Operations;
use StackOne\client\Utils;

$sdk = client\StackOne::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();

$request = new Operations\StackoneListPlatformLogsRequest(
    orderBy: Operations\StackoneListPlatformLogsQueryParamOrderBy::Duration,
    orderDirection: Operations\StackoneListPlatformLogsQueryParamOrderDirection::Asc,
    filter: new Operations\StackoneListPlatformLogsQueryParamFilter(
        accountIds: '45355976281015164504,45355976281015164505',
        startDate: Utils\Utils::parseDateTime('2020-01-01T00:00:00.000Z'),
        endDate: Utils\Utils::parseDateTime('2020-01-01T00:00:00.000Z'),
        requestIds: 'adbf752f-6457-4ddd-89b3-98ae2252b83b,adbf752f-6457-4ddd-89b3-98ae2252b83c',
        sourceTypes: 'DASHBOARD,SYNTHETIC_WEBHOOK',
        httpMethods: 'GET,POST',
        categories: 'hris,ats',
        resources: 'employees,users',
        actions: 'download,upload',
        statusCodes: '200,400',
        success: true,
        orderBy: Operations\StackoneListPlatformLogsQueryParamRequestLogsOrderBy::EventDatetime,
        orderDirection: Operations\StackoneListPlatformLogsQueryParamRequestLogsOrderDirection::Asc,
    ),
);

$response = $sdk->requestLogs->listPlatformLogs(
    request: $request
);

if ($response->platformLogsPaginated !== null) {
    // handle response
}

Parameters

Parameter Type Required Description
$request Operations\StackoneListPlatformLogsRequest ✔️ The request object to use for the request.

Response

?Operations\StackoneListPlatformLogsResponse

Errors

Error Type Status Code Content Type
Errors\BadRequestResponse 400 application/json
Errors\UnauthorizedResponse 401 application/json
Errors\ForbiddenResponse 403 application/json
Errors\NotFoundResponse 404 application/json
Errors\RequestTimedOutResponse 408 application/json
Errors\ConflictResponse 409 application/json
Errors\UnprocessableEntityResponse 422 application/json
Errors\TooManyRequestsResponse 429 application/json
Errors\InternalServerErrorResponse 500 application/json
Errors\NotImplementedResponse 501 application/json
Errors\BadGatewayResponse 502 application/json
Errors\SDKException 4XX, 5XX */*