Skip to content

README.md

Latest commit

 

History

History
279 lines (220 loc) · 21.9 KB

README.md

File metadata and controls

279 lines (220 loc) · 21.9 KB

RequestLogs

Overview

API requests and response logs.

Available Operations

ListSteps

List Step Logs

Example Usage

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;
using StackOneHQ.Client.Models.Requests;
using System;

var sdk = new StackOneHQClient(security: new Security() {
    Username = "",
    Password = "",
});

StackoneListStepLogsRequest req = new StackoneListStepLogsRequest() {
    OrderBy = StackoneListStepLogsOrderBy.EventDatetime,
    OrderDirection = StackoneListStepLogsOrderDirection.Asc,
    Filter = new StackoneListStepLogsFilter() {
        AccountIds = "45355976281015164504,45355976281015164505",
        StartDate = System.DateTime.Parse("2020-01-01T00:00:00.000Z"),
        EndDate = System.DateTime.Parse("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,
    },
};

var res = await sdk.RequestLogs.ListStepsAsync(req);

// handle response

Parameters

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

Response

StackoneListStepLogsResponse

Errors

Error Type Status Code Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException 400 application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException 401 application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException 403 application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException 404 application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException 408 application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException 409 application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException 422 application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException 429 application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse 500 application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException 501 application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException 502 application/json
StackOneHQ.Client.Models.Errors.APIException 4XX, 5XX */*

Get

Get Log

Example Usage

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;
using StackOneHQ.Client.Models.Requests;

var sdk = new StackOneHQClient(security: new Security() {
    Username = "",
    Password = "",
});

var res = await sdk.RequestLogs.GetAsync(
    id: "<id>",
    include: StackoneGetLogInclude.StepLogs
);

// handle response

Parameters

Parameter Type Required Description Example
Id string ✔️ N/A
Include StackoneGetLogInclude ➖ The include parameter allows you to include additional data in the response. step_logs

Response

StackoneGetLogResponse

Errors

Error Type Status Code Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException 400 application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException 401 application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException 403 application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException 404 application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException 408 application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException 409 application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException 422 application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException 429 application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse 500 application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException 501 application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException 502 application/json
StackOneHQ.Client.Models.Errors.APIException 4XX, 5XX */*

List

List Logs

Example Usage

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;
using StackOneHQ.Client.Models.Requests;
using System;

var sdk = new StackOneHQClient(security: new Security() {
    Username = "",
    Password = "",
});

StackoneListLogsRequest req = new StackoneListLogsRequest() {
    OrderBy = StackoneListLogsOrderBy.Duration,
    OrderDirection = StackoneListLogsOrderDirection.Asc,
    Include = StackoneListLogsInclude.StepLogs,
    Filter = new StackoneListLogsFilter() {
        AccountIds = "45355976281015164504,45355976281015164505",
        StartDate = System.DateTime.Parse("2020-01-01T00:00:00.000Z"),
        EndDate = System.DateTime.Parse("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 = StackoneListLogsFilterOrderBy.Duration,
        OrderDirection = StackoneListLogsFilterOrderDirection.Asc,
    },
};

var res = await sdk.RequestLogs.ListAsync(req);

// handle response

Parameters

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

Response

StackoneListLogsResponse

Errors

Error Type Status Code Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException 400 application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException 401 application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException 403 application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException 404 application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException 408 application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException 409 application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException 422 application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException 429 application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse 500 application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException 501 application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException 502 application/json
StackOneHQ.Client.Models.Errors.APIException 4XX, 5XX */*

ListPlatformLogs

List Platform Logs

Example Usage

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;
using StackOneHQ.Client.Models.Requests;
using System;

var sdk = new StackOneHQClient(security: new Security() {
    Username = "",
    Password = "",
});

StackoneListPlatformLogsRequest req = new StackoneListPlatformLogsRequest() {
    OrderBy = StackoneListPlatformLogsOrderBy.Duration,
    OrderDirection = StackoneListPlatformLogsOrderDirection.Asc,
    Filter = new StackoneListPlatformLogsFilter() {
        AccountIds = "45355976281015164504,45355976281015164505",
        StartDate = System.DateTime.Parse("2020-01-01T00:00:00.000Z"),
        EndDate = System.DateTime.Parse("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 = StackoneListPlatformLogsFilterOrderBy.EventDatetime,
        OrderDirection = StackoneListPlatformLogsFilterOrderDirection.Asc,
    },
};

var res = await sdk.RequestLogs.ListPlatformLogsAsync(req);

// handle response

Parameters

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

Response

StackoneListPlatformLogsResponse

Errors

Error Type Status Code Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException 400 application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException 401 application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException 403 application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException 404 application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException 408 application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException 409 application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException 422 application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException 429 application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse 500 application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException 501 application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException 502 application/json
StackOneHQ.Client.Models.Errors.APIException 4XX, 5XX */*