Skip to content

README.md

Latest commit

 

History

History
150 lines (119 loc) · 15.7 KB

README.md

File metadata and controls

150 lines (119 loc) · 15.7 KB

Documents

Overview

Available Operations

ListApplicationCategories

List Application Document Categories

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 = "",
});

AtsListApplicationDocumentCategoriesRequest req = new AtsListApplicationDocumentCategoriesRequest() {
    XAccountId = "<id>",
    Fields = "id,remote_id,name,active,unified_custom_fields",
    Filter = new AtsListApplicationDocumentCategoriesFilter() {
        UpdatedAfter = System.DateTime.Parse("2020-01-01T00:00:00.000Z"),
    },
    Prefer = "heartbeat",
};

AtsListApplicationDocumentCategoriesResponse? res = await sdk.Documents.ListApplicationCategoriesAsync(req);

while(res != null)
{
    // handle items

    res = await res.Next!();
}

Parameters

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

Response

AtsListApplicationDocumentCategoriesResponse

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.PreconditionFailedResponseException 412 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 */*

UploadFile

Upload File

Example Usage

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

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

var res = await sdk.Documents.UploadFileAsync(
    xAccountId: "<id>",
    unifiedUploadRequestDto: new UnifiedUploadRequestDto() {
        Name = "weather-forecast",
        FileFormat = new UnifiedUploadRequestDtoFileFormat() {
            Value = UnifiedUploadRequestDtoFileFormatValue.Pdf,
            SourceValue = UnifiedUploadRequestDtoFileFormatSourceValueUnion.CreateStr(
                "application/pdf"
            ),
        },
        Content = "VGhpcyBpc24ndCByZWFsbHkgYSBzYW1wbGUgZmlsZSwgYnV0IG5vIG9uZSB3aWxsIGV2ZXIga25vdyE",
        CategoryId = "6530",
        Path = "/path/to/file",
        Category = new UnifiedUploadRequestDtoCategory() {
            Value = "reports, resumes",
            SourceValue = "550e8400-e29b-41d4-a716-446655440000, CUSTOM_CATEGORY_NAME",
        },
        Confidential = new UnifiedUploadRequestDtoConfidential() {
            Value = UnifiedUploadRequestDtoConfidentialValue.True,
            SourceValue = UnifiedUploadRequestDtoConfidentialSourceValueUnion.CreateStr(
                "public"
            ),
        },
    },
    prefer: "heartbeat"
);

// handle response

Parameters

Parameter Type Required Description Example
XAccountId string ✔️ The account identifier
UnifiedUploadRequestDto UnifiedUploadRequestDto ✔️ N/A
XStackoneApiSessionToken string ➖ The session token
Prefer string ➖ Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240) heartbeat

Response

DocumentsUploadFileResponse

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.PreconditionFailedResponseException 412 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 */*