Ticketing

Overview

Available Operations

create_ticket - Create Ticket
download_ticketing_attachment - Download Attachment
get_attachment - Get Attachment
get_comment - Get Comment
get_project - Get Project
get_project_component - Get Project Component
get_ticket - Get Ticket
get_ticket_type - Get Ticket Type
get_user - Get User
list_attachments - List Attachments
list_comments - List Comments
list_project_components - List Project Components
list_project_ticket_types - List Project Ticket Types
list_projects - List Projects
list_ticket_statuses - List Ticket Statuses
list_ticket_types - List Ticket Types
list_tickets - List Tickets
list_users - List Users
update_ticket - Update Ticket

create_ticket

Create a new ticket record.

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)
res = s.ticketing.create_ticket(ticketing_ticket_create_request_dto: Models::Shared::TicketingTicketCreateRequestDto.new(
  assignees: [
    'user-001',
    'user-002',
  ],
  component_ids: '["component-001","component-002"]',
  content: [
    Models::Shared::TicketingContent.new(
      html: '<p>This is some content</p>',
      plain: 'This is some content'
    ),
  ],
  creator_id: 'user-001',
  organization_id: 'organization-001',
  parent_id: 'ticket-002',
  priority: Models::Shared::TicketingTicketCreateRequestDtoPriority.new(
    id: '001',
    source_value: 'Normal',
    value: Models::Shared::TicketingTicketCreateRequestDtoValue::MEDIUM
  ),
  project_id: 'project-001',
  reporters: [
    'user-001',
    'user-002',
  ],
  tags: [
    'tag-001',
    'tag-002',
  ],
  title: 'System outage in production environment',
  type: 'ticket-type-001',
  unified_custom_fields: {
    'my_project_custom_field_1' => 'REF-1236',
    'my_project_custom_field_2' => 'some other value',
  }
), x_account_id: '<id>', prefer: 'heartbeat')

unless res.create_result.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description	Example
`ticketing_ticket_create_request_dto`	Models::Shared::TicketingTicketCreateRequestDto	✔️	N/A
`x_account_id`	::String	✔️	The account identifier
`prefer`	T.nilable(::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

T.nilable(Models::Operations::TicketingCreateTicketResponse)

Errors

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

download_ticketing_attachment

Download the attachment file from a ticket.

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)

req = Models::Operations::TicketingDownloadTicketingAttachmentRequest.new(
  export_format: 'text/plain',
  format: 'base64',
  id: '<id>',
  sub_resource_id: '<id>',
  x_account_id: '<id>'
)
res = s.ticketing.download_ticketing_attachment(request: req)

unless res.body.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`request`	Models::Operations::TicketingDownloadTicketingAttachmentRequest	✔️	The request object to use for the request.

Response

T.nilable(Models::Operations::TicketingDownloadTicketingAttachmentResponse)

Errors

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

get_attachment

Retrieve the details of a single attachment for a ticket.

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)

req = Models::Operations::TicketingGetAttachmentRequest.new(
  prefer: 'heartbeat',
  fields_: 'id,remote_id,ticket_id,remote_ticket_id,user_id,remote_user_id,file_name,file_format,file_url,size,created_at,updated_at,unified_custom_fields',
  id: '<id>',
  sub_resource_id: '<id>',
  x_account_id: '<id>'
)
res = s.ticketing.get_attachment(request: req)

unless res.ticketing_attachment_result.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`request`	Models::Operations::TicketingGetAttachmentRequest	✔️	The request object to use for the request.

Response

T.nilable(Models::Operations::TicketingGetAttachmentResponse)

Errors

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

get_comment

Retrieve a single comment by its identifier for a ticket.

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)

req = Models::Operations::TicketingGetCommentRequest.new(
  prefer: 'heartbeat',
  fields_: 'id,remote_id,ticket_id,remote_ticket_id,content,user_id,remote_user_id,internal,created_at,updated_at,unified_custom_fields',
  id: '<id>',
  sub_resource_id: '<id>',
  x_account_id: '<id>'
)
res = s.ticketing.get_comment(request: req)

unless res.ticketing_comment_result.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`request`	Models::Operations::TicketingGetCommentRequest	✔️	The request object to use for the request.

Response

T.nilable(Models::Operations::TicketingGetCommentResponse)

Errors

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

get_project

Retrieve a single project by its identifier.

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)

req = Models::Operations::TicketingGetProjectRequest.new(
  prefer: 'heartbeat',
  fields_: 'id,remote_id,organization_id,remote_organization_id,name,description,created_at,updated_at,unified_custom_fields',
  id: '<id>',
  x_account_id: '<id>'
)
res = s.ticketing.get_project(request: req)

unless res.ticketing_project_result.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`request`	Models::Operations::TicketingGetProjectRequest	✔️	The request object to use for the request.

Response

T.nilable(Models::Operations::TicketingGetProjectResponse)

Errors

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

get_project_component

Retrieve a single project component by its identifier.

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)

req = Models::Operations::TicketingGetProjectComponentRequest.new(
  prefer: 'heartbeat',
  fields_: 'id,remote_id,organization_id,remote_organization_id,project_id,remote_project_id,name,description,created_at,updated_at,unified_custom_fields',
  id: '<id>',
  sub_resource_id: '<id>',
  x_account_id: '<id>'
)
res = s.ticketing.get_project_component(request: req)

unless res.ticketing_component_result.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`request`	Models::Operations::TicketingGetProjectComponentRequest	✔️	The request object to use for the request.

Response

T.nilable(Models::Operations::TicketingGetProjectComponentResponse)

Errors

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

get_ticket

Retrieve a single ticket by its identifier.

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)

req = Models::Operations::TicketingGetTicketRequest.new(
  prefer: 'heartbeat',
  fields_: 'id,remote_id,type,ticket_number,title,creator_id,remote_creator_id,reporters,assignees,content,parent_id,remote_parent_id,closed_at,ticket_url,status,priority,tags,projects,components,organization,created_at,updated_at,unified_custom_fields',
  id: '<id>',
  x_account_id: '<id>'
)
res = s.ticketing.get_ticket(request: req)

unless res.ticketing_ticket_result.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`request`	Models::Operations::TicketingGetTicketRequest	✔️	The request object to use for the request.

Response

T.nilable(Models::Operations::TicketingGetTicketResponse)

Errors

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

get_ticket_type

Retrieve a single ticket type by its identifier.

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)

req = Models::Operations::TicketingGetTicketTypeRequest.new(
  prefer: 'heartbeat',
  fields_: 'id,remote_id,name,project_id,remote_project_id,unified_custom_fields',
  id: '<id>',
  x_account_id: '<id>'
)
res = s.ticketing.get_ticket_type(request: req)

unless res.ticketing_ticket_type_result.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`request`	Models::Operations::TicketingGetTicketTypeRequest	✔️	The request object to use for the request.

Response

T.nilable(Models::Operations::TicketingGetTicketTypeResponse)

Errors

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

get_user

Retrieve a single user by their identifier.

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)

req = Models::Operations::TicketingGetUserRequest.new(
  prefer: 'heartbeat',
  fields_: 'id,remote_id,type,name,primary_email,primary_phone,username,active,first_name,last_name,customer_account_reference,created_at,updated_at,unified_custom_fields',
  id: '<id>',
  x_account_id: '<id>'
)
res = s.ticketing.get_user(request: req)

unless res.ticketing_user_result.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`request`	Models::Operations::TicketingGetUserRequest	✔️	The request object to use for the request.

Response

T.nilable(Models::Operations::TicketingGetUserResponse)

Errors

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

list_attachments

Retrieve a paginated list of attachment details for a ticket.

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)

req = Models::Operations::TicketingListAttachmentsRequest.new(
  prefer: 'heartbeat',
  fields_: 'id,remote_id,ticket_id,remote_ticket_id,user_id,remote_user_id,file_name,file_format,file_url,size,created_at,updated_at,unified_custom_fields',
  filter: Models::Operations::TicketingListAttachmentsQueryParamFilter.new(
    updated_after: DateTime.iso8601('2020-01-01T00:00:00.000Z')
  ),
  id: '<id>',
  x_account_id: '<id>'
)
res = s.ticketing.list_attachments(request: req)

unless res.ticketing_attachments_paginated.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`request`	Models::Operations::TicketingListAttachmentsRequest	✔️	The request object to use for the request.

Response

T.nilable(Models::Operations::TicketingListAttachmentsResponse)

Errors

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

list_comments

Retrieve a paginated list of comments for a ticket.

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)

req = Models::Operations::TicketingListCommentsRequest.new(
  prefer: 'heartbeat',
  fields_: 'id,remote_id,ticket_id,remote_ticket_id,content,user_id,remote_user_id,internal,created_at,updated_at,unified_custom_fields',
  filter: Models::Operations::TicketingListCommentsQueryParamFilter.new(
    updated_after: DateTime.iso8601('2020-01-01T00:00:00.000Z')
  ),
  id: '<id>',
  x_account_id: '<id>'
)
res = s.ticketing.list_comments(request: req)

unless res.ticketing_comments_paginated.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`request`	Models::Operations::TicketingListCommentsRequest	✔️	The request object to use for the request.

Response

T.nilable(Models::Operations::TicketingListCommentsResponse)

Errors

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

list_project_components

Retrieve a paginated list of project components.

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)

req = Models::Operations::TicketingListProjectComponentsRequest.new(
  prefer: 'heartbeat',
  fields_: 'id,remote_id,organization_id,remote_organization_id,project_id,remote_project_id,name,description,created_at,updated_at,unified_custom_fields',
  filter: nil,
  id: '<id>',
  x_account_id: '<id>'
)
res = s.ticketing.list_project_components(request: req)

unless res.ticketing_components_paginated.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`request`	Models::Operations::TicketingListProjectComponentsRequest	✔️	The request object to use for the request.

Response

T.nilable(Models::Operations::TicketingListProjectComponentsResponse)

Errors

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

list_project_ticket_types

Retrieve a paginated list of ticket types for a project.

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)

req = Models::Operations::TicketingListProjectTicketTypesRequest.new(
  prefer: 'heartbeat',
  fields_: 'id,remote_id,name,project_id,remote_project_id,unified_custom_fields',
  filter: Models::Operations::TicketingListProjectTicketTypesQueryParamFilter.new(
    updated_after: DateTime.iso8601('2020-01-01T00:00:00.000Z')
  ),
  id: '<id>',
  x_account_id: '<id>'
)
res = s.ticketing.list_project_ticket_types(request: req)

unless res.ticketing_ticket_type_paginated.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`request`	Models::Operations::TicketingListProjectTicketTypesRequest	✔️	The request object to use for the request.

Response

T.nilable(Models::Operations::TicketingListProjectTicketTypesResponse)

Errors

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

list_projects

Retrieve a paginated list of projects.

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)

req = Models::Operations::TicketingListProjectsRequest.new(
  prefer: 'heartbeat',
  fields_: 'id,remote_id,organization_id,remote_organization_id,name,description,created_at,updated_at,unified_custom_fields',
  filter: Models::Operations::TicketingListProjectsQueryParamFilter.new(
    updated_after: DateTime.iso8601('2020-01-01T00:00:00.000Z')
  ),
  x_account_id: '<id>'
)
res = s.ticketing.list_projects(request: req)

unless res.ticketing_projects_paginated.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`request`	Models::Operations::TicketingListProjectsRequest	✔️	The request object to use for the request.

Response

T.nilable(Models::Operations::TicketingListProjectsResponse)

Errors

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

list_ticket_statuses

Retrieve a paginated list of statuses for a ticket.

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)

req = Models::Operations::TicketingListTicketStatusesRequest.new(
  prefer: 'heartbeat',
  filter: Models::Operations::TicketingListTicketStatusesQueryParamFilter.new(
    updated_after: DateTime.iso8601('2020-01-01T00:00:00.000Z')
  ),
  id: '<id>',
  x_account_id: '<id>'
)
res = s.ticketing.list_ticket_statuses(request: req)

unless res.ticketing_ticket_statuses_paginated.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`request`	Models::Operations::TicketingListTicketStatusesRequest	✔️	The request object to use for the request.

Response

T.nilable(Models::Operations::TicketingListTicketStatusesResponse)

Errors

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

list_ticket_types

Retrieve a paginated list of all ticket types.

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)

req = Models::Operations::TicketingListTicketTypesRequest.new(
  prefer: 'heartbeat',
  fields_: 'id,remote_id,name,project_id,remote_project_id,unified_custom_fields',
  filter: Models::Operations::TicketingListTicketTypesQueryParamFilter.new(
    updated_after: DateTime.iso8601('2020-01-01T00:00:00.000Z')
  ),
  x_account_id: '<id>'
)
res = s.ticketing.list_ticket_types(request: req)

unless res.ticketing_ticket_type_paginated.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`request`	Models::Operations::TicketingListTicketTypesRequest	✔️	The request object to use for the request.

Response

T.nilable(Models::Operations::TicketingListTicketTypesResponse)

Errors

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

list_tickets

Retrieve a paginated list of tickets.

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)

req = Models::Operations::TicketingListTicketsRequest.new(
  prefer: 'heartbeat',
  fields_: 'id,remote_id,type,ticket_number,title,creator_id,remote_creator_id,reporters,assignees,content,parent_id,remote_parent_id,closed_at,ticket_url,status,priority,tags,projects,components,organization,created_at,updated_at,unified_custom_fields',
  filter: Models::Operations::TicketingListTicketsQueryParamFilter.new(
    updated_after: DateTime.iso8601('2020-01-01T00:00:00.000Z')
  ),
  x_account_id: '<id>'
)
res = s.ticketing.list_tickets(request: req)

unless res.ticketing_tickets_paginated.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`request`	Models::Operations::TicketingListTicketsRequest	✔️	The request object to use for the request.

Response

T.nilable(Models::Operations::TicketingListTicketsResponse)

Errors

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

list_users

Retrieve a paginated list of users.

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)

req = Models::Operations::TicketingListUsersRequest.new(
  prefer: 'heartbeat',
  fields_: 'id,remote_id,type,name,primary_email,primary_phone,username,active,first_name,last_name,customer_account_reference,created_at,updated_at,unified_custom_fields',
  filter: Models::Operations::TicketingListUsersQueryParamFilter.new(
    updated_after: DateTime.iso8601('2020-01-01T00:00:00.000Z')
  ),
  x_account_id: '<id>'
)
res = s.ticketing.list_users(request: req)

unless res.ticketing_users_paginated.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`request`	Models::Operations::TicketingListUsersRequest	✔️	The request object to use for the request.

Response

T.nilable(Models::Operations::TicketingListUsersResponse)

Errors

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

update_ticket

Update an existing ticket record by its identifier.

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)
res = s.ticketing.update_ticket(ticketing_ticket_update_request_dto: Models::Shared::TicketingTicketUpdateRequestDto.new(
  assignees: [
    'user-001',
    'user-002',
  ],
  component_ids: '["component-001","component-002"]',
  content: [
    Models::Shared::TicketingContent.new(
      html: '<p>This is some content</p>',
      plain: 'This is some content'
    ),
  ],
  parent_id: 'ticket-002',
  priority: Models::Shared::TicketingTicketUpdateRequestDtoPriority.new(
    id: '001',
    source_value: 'Normal',
    value: Models::Shared::TicketingTicketUpdateRequestDtoValue::MEDIUM
  ),
  project_id: 'project-001',
  reporters: [
    'user-001',
    'user-002',
  ],
  status: Models::Shared::TicketingTicketUpdateRequestDtoStatus.new(
    id: '001',
    name: 'Backlog',
    type: Models::Shared::TicketingTicketUpdateRequestDtoType.new(
      source_value: 'New',
      value: Models::Shared::TicketingTicketUpdateRequestDtoSchemasValue::TO_DO
    )
  ),
  tags: [
    'tag-001',
    'tag-002',
  ],
  title: 'System outage in production environment',
  unified_custom_fields: {
    'my_project_custom_field_1' => 'REF-1236',
    'my_project_custom_field_2' => 'some other value',
  }
), id: '<id>', x_account_id: '<id>', prefer: 'heartbeat')

unless res.update_result.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description	Example
`ticketing_ticket_update_request_dto`	Models::Shared::TicketingTicketUpdateRequestDto	✔️	N/A
`id`	::String	✔️	N/A
`x_account_id`	::String	✔️	The account identifier
`prefer`	T.nilable(::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

T.nilable(Models::Operations::TicketingUpdateTicketResponse)

Errors

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

FilesExpand file tree

README.md

Latest commit

History

README.md

File metadata and controls

Ticketing

Overview

Available Operations

create_ticket

Example Usage

Parameters

Response

Errors

download_ticketing_attachment

Example Usage

Parameters

Response

Errors

get_attachment

Example Usage

Parameters

Response

Errors

get_comment

Example Usage

Parameters

Response

Errors

get_project

Example Usage

Parameters

Response

Errors

get_project_component

Example Usage

Parameters

Response

Errors

get_ticket

Example Usage

Parameters

Response

Errors

get_ticket_type

Example Usage

Parameters

Response

Errors

get_user

Example Usage

Parameters

Response

Errors

list_attachments

Example Usage

Parameters

Response

Errors

list_comments

Example Usage

Parameters

Response

Errors

list_project_components

Example Usage

Parameters

Response

Errors

list_project_ticket_types

Example Usage

Parameters

Response

Errors

list_projects

Example Usage

Parameters

Response

Errors

list_ticket_statuses