Requests

List Requests

client.CloudforceOne.Requests.List(ctx, params) (*SinglePage[ListItem], error)

POST/accounts/{account_id}/cloudforce-one/requests

Get a Request

client.CloudforceOne.Requests.Get(ctx, requestID, query) (*Item, error)

GET/accounts/{account_id}/cloudforce-one/requests/{request_id}

Create a New Request.

client.CloudforceOne.Requests.New(ctx, params) (*Item, error)

POST/accounts/{account_id}/cloudforce-one/requests/new

Update a Request

client.CloudforceOne.Requests.Update(ctx, requestID, params) (*Item, error)

PUT/accounts/{account_id}/cloudforce-one/requests/{request_id}

Delete a Request

client.CloudforceOne.Requests.Delete(ctx, requestID, body) (*RequestDeleteResponse, error)

DELETE/accounts/{account_id}/cloudforce-one/requests/{request_id}

Get Request Quota

client.CloudforceOne.Requests.Quota(ctx, query) (*Quota, error)

GET/accounts/{account_id}/cloudforce-one/requests/quota

Get Request Types

client.CloudforceOne.Requests.Types(ctx, query) (*SinglePage[string], error)

GET/accounts/{account_id}/cloudforce-one/requests/types

Get Request Priority, Status, and TLP constants

client.CloudforceOne.Requests.Constants(ctx, query) (*RequestConstants, error)

GET/accounts/{account_id}/cloudforce-one/requests/constants

ModelsExpand Collapse

type Item struct{…}

ID string

UUID.

maxLength36

Content string

Request content.

Created Time

formatdate-time

Priority Time

formatdate-time

Request string

Requested information from request.

Summary string

Brief description of the request.

TLP ItemTLP

The CISA defined Traffic Light Protocol (TLP).

One of the following:

const ItemTLPClear ItemTLP = "clear"

const ItemTLPAmber ItemTLP = "amber"

const ItemTLPAmberStrict ItemTLP = "amber-strict"

const ItemTLPGreen ItemTLP = "green"

const ItemTLPRed ItemTLP = "red"

Updated Time

formatdate-time

Completed Timeoptional

formatdate-time

MessageTokens int64optional

Tokens for the request messages.

ReadableID stringoptional

Readable Request ID.

Status ItemStatusoptional

Request Status.

One of the following:

const ItemStatusOpen ItemStatus = "open"

const ItemStatusAccepted ItemStatus = "accepted"

const ItemStatusReported ItemStatus = "reported"

const ItemStatusApproved ItemStatus = "approved"

const ItemStatusCompleted ItemStatus = "completed"

const ItemStatusDeclined ItemStatus = "declined"

Tokens int64optional

Tokens for the request.

type ListItem struct{…}

ID string

UUID.

maxLength36

Created Time

Request creation time.

formatdate-time

Priority ListItemPriority

One of the following:

const ListItemPriorityRoutine ListItemPriority = "routine"

const ListItemPriorityHigh ListItemPriority = "high"

const ListItemPriorityUrgent ListItemPriority = "urgent"

Request string

Requested information from request.

Summary string

Brief description of the request.

TLP ListItemTLP

The CISA defined Traffic Light Protocol (TLP).

One of the following:

const ListItemTLPClear ListItemTLP = "clear"

const ListItemTLPAmber ListItemTLP = "amber"

const ListItemTLPAmberStrict ListItemTLP = "amber-strict"

const ListItemTLPGreen ListItemTLP = "green"

const ListItemTLPRed ListItemTLP = "red"

Updated Time

Request last updated time.

formatdate-time

Completed Timeoptional

Request completion time.

formatdate-time

MessageTokens int64optional

Tokens for the request messages.

ReadableID stringoptional

Readable Request ID.

Status ListItemStatusoptional

Request Status.

One of the following:

const ListItemStatusOpen ListItemStatus = "open"

const ListItemStatusAccepted ListItemStatus = "accepted"

const ListItemStatusReported ListItemStatus = "reported"

const ListItemStatusApproved ListItemStatus = "approved"

const ListItemStatusCompleted ListItemStatus = "completed"

const ListItemStatusDeclined ListItemStatus = "declined"

Tokens int64optional

Tokens for the request.

type Quota struct{…}

AnniversaryDate Timeoptional

Anniversary date is when annual quota limit is refreshed.

formatdate-time

QuarterAnniversaryDate Timeoptional

Quarter anniversary date is when quota limit is refreshed each quarter.

formatdate-time

Quota int64optional

Tokens for the quarter.

Remaining int64optional

Tokens remaining for the quarter.

type RequestConstants struct{…}

Priority []RequestConstantsPriorityoptional

One of the following:

const RequestConstantsPriorityRoutine RequestConstantsPriority = "routine"

const RequestConstantsPriorityHigh RequestConstantsPriority = "high"

const RequestConstantsPriorityUrgent RequestConstantsPriority = "urgent"

Status []RequestConstantsStatusoptional

One of the following:

const RequestConstantsStatusOpen RequestConstantsStatus = "open"

const RequestConstantsStatusAccepted RequestConstantsStatus = "accepted"

const RequestConstantsStatusReported RequestConstantsStatus = "reported"

const RequestConstantsStatusApproved RequestConstantsStatus = "approved"

const RequestConstantsStatusCompleted RequestConstantsStatus = "completed"

const RequestConstantsStatusDeclined RequestConstantsStatus = "declined"

TLP []RequestConstantsTLPoptional

One of the following:

const RequestConstantsTLPClear RequestConstantsTLP = "clear"

const RequestConstantsTLPAmber RequestConstantsTLP = "amber"

const RequestConstantsTLPAmberStrict RequestConstantsTLP = "amber-strict"

const RequestConstantsTLPGreen RequestConstantsTLP = "green"

const RequestConstantsTLPRed RequestConstantsTLP = "red"

type RequestTypes []string

RequestsMessage

List Request Messages

client.CloudforceOne.Requests.Message.Get(ctx, requestID, params) (*SinglePage[Message], error)

POST/accounts/{account_id}/cloudforce-one/requests/{request_id}/message

Create a New Request Message

client.CloudforceOne.Requests.Message.New(ctx, requestID, params) (*Message, error)

POST/accounts/{account_id}/cloudforce-one/requests/{request_id}/message/new

Update a Request Message

client.CloudforceOne.Requests.Message.Update(ctx, requestID, messageID, params) (*Message, error)

PUT/accounts/{account_id}/cloudforce-one/requests/{request_id}/message/{message_id}

Delete a Request Message

client.CloudforceOne.Requests.Message.Delete(ctx, requestID, messageID, body) (*RequestMessageDeleteResponse, error)

DELETE/accounts/{account_id}/cloudforce-one/requests/{request_id}/message/{message_id}

ModelsExpand Collapse

type Message struct{…}

ID int64

Message ID.

Author string

Author of message.

Content string

Content of message.

IsFollowOnRequest bool

Whether the message is a follow-on request.

Updated Time

Defines the message last updated time.

formatdate-time

Created Timeoptional

Defines the message creation time.

formatdate-time

RequestsPriority

Get a Priority Intelligence Requirement

client.CloudforceOne.Requests.Priority.Get(ctx, priorityID, query) (*Item, error)

GET/accounts/{account_id}/cloudforce-one/requests/priority/{priority_id}

Create a New Priority Intelligence Requirement

client.CloudforceOne.Requests.Priority.New(ctx, params) (*Priority, error)

POST/accounts/{account_id}/cloudforce-one/requests/priority/new

Update a Priority Intelligence Requirement

client.CloudforceOne.Requests.Priority.Update(ctx, priorityID, params) (*Item, error)

PUT/accounts/{account_id}/cloudforce-one/requests/priority/{priority_id}

Delete a Priority Intelligence Requirement

client.CloudforceOne.Requests.Priority.Delete(ctx, priorityID, body) (*RequestPriorityDeleteResponse, error)

DELETE/accounts/{account_id}/cloudforce-one/requests/priority/{priority_id}

Get Priority Intelligence Requirement Quota

client.CloudforceOne.Requests.Priority.Quota(ctx, query) (*Quota, error)

GET/accounts/{account_id}/cloudforce-one/requests/priority/quota

ModelsExpand Collapse

type Label string

type Priority struct{…}

ID string

UUID.

maxLength36

Created Time

Priority creation time.

formatdate-time

Labels []Label

List of labels.

Priority int64

Priority.

Requirement string

Requirement.

TLP PriorityTLP

The CISA defined Traffic Light Protocol (TLP).

One of the following:

const PriorityTLPClear PriorityTLP = "clear"

const PriorityTLPAmber PriorityTLP = "amber"

const PriorityTLPAmberStrict PriorityTLP = "amber-strict"

const PriorityTLPGreen PriorityTLP = "green"

const PriorityTLPRed PriorityTLP = "red"

Updated Time

Priority last updated time.

formatdate-time

type PriorityEdit struct{…}

Labels []Label

List of labels.

Priority int64

Priority.

Requirement string

Requirement.

TLP PriorityEditTLP

The CISA defined Traffic Light Protocol (TLP).

One of the following:

const PriorityEditTLPClear PriorityEditTLP = "clear"

const PriorityEditTLPAmber PriorityEditTLP = "amber"

const PriorityEditTLPAmberStrict PriorityEditTLP = "amber-strict"

const PriorityEditTLPGreen PriorityEditTLP = "green"

const PriorityEditTLPRed PriorityEditTLP = "red"

RequestsAssets

Get a Request Asset

client.CloudforceOne.Requests.Assets.Get(ctx, requestID, assetID, query) (*SinglePage[RequestAssetGetResponse], error)

GET/accounts/{account_id}/cloudforce-one/requests/{request_id}/asset/{asset_id}

List Request Assets

client.CloudforceOne.Requests.Assets.New(ctx, requestID, params) (*SinglePage[RequestAssetNewResponse], error)

POST/accounts/{account_id}/cloudforce-one/requests/{request_id}/asset

Update a Request Asset

client.CloudforceOne.Requests.Assets.Update(ctx, requestID, assetID, params) (*RequestAssetUpdateResponse, error)

PUT/accounts/{account_id}/cloudforce-one/requests/{request_id}/asset/{asset_id}

Delete a Request Asset

client.CloudforceOne.Requests.Assets.Delete(ctx, requestID, assetID, body) (*RequestAssetDeleteResponse, error)

DELETE/accounts/{account_id}/cloudforce-one/requests/{request_id}/asset/{asset_id}