openapi: 3.0.0 info: version: 1.0.0 title: PSS servers: - url: 'https://api.ukfast.io' components: schemas: Author: properties: id: type: integer example: 1 readOnly: false name: type: string example: 'George Kaplan' readOnly: true type: type: string enum: - Client - Support example: Client readOnly: true description: "\n *

Details on the user that created the request.

\n *

When the type is Client, this refers to you as the Customer.\n *

When the type is Auto, this refers to an automated system such as our monitoring platform.\n *

WHen the type is Support, this refers the a member of the UKFast technical support team.\n *

The ID can be null depending on the type of Author.\n * " required: { } 'Case Category': properties: id: type: string example: 78e8a223-c125-4641-8ca9-c201d2cc4785 generationStrategy: uuid readOnly: true name: type: string example: 'Business Applications' readOnly: true description: 'Case Category - used to create Incident and Change Cases' required: { } 'Case Option': properties: option: type: string example: Major readOnly: true description: 'Case Option of a requests type - used to create Incident and Change Cases' required: { } 'Case Update': properties: id: type: string example: 78e8a223-c125-4641-8ca9-c201d2cc4785 generationStrategy: uuid readOnly: true subject: type: string example: 'Glass - Customer Update' readOnly: true description: type: string example: 'An update to be attached to the case' readOnly: false contact: type: string example: 'John Doe' readOnly: true contact_id: type: integer example: '123' readOnly: false writeOnly: true created_at: type: string example: '2022-01-01T00:00:00+00:00' readOnly: true updated_at: type: string example: '2022-01-01T00:00:00+00:00' readOnly: true description: 'Case Update' required: { } 'Change Case': properties: id: type: string example: CHG123457 readOnly: true case_type: type: string enum: - Change example: Change readOnly: false title: type: string example: 'Title of the change request' readOnly: false description: type: string example: 'Description of the change request' readOnly: false is_security: type: boolean example: true readOnly: false type: type: string enum: - Normal - Standard - Emergency - Project - 'Centre of Excellence' example: Normal readOnly: true priority: type: string enum: - CR1 - CR2 - CR3 - CR4 - CR5 - CR-S - CR-E - CR-P example: CR1 readOnly: true squad: type: string example: 'SMB - Windows' readOnly: true status: type: string enum: - 'In Progress' - 'On Hold' - Open - 'Case Created' - Resolved - 'Pending Assessment' - 'Pending SME' - 'Problem Assessment' - Closed - 'Pending Customers Approval' - 'Pending ANS CAB' - 'Pending Implementation' - 'Implementation Started' - Delivered - Rejected - 'Schedule Change' - 'Customer Closure' - 'Problem Solved' - 'Information Provided' - 'Closed with Customer Consent' - 'Closed - Customer Not Contactable' - 'Closed with Team Leader Approval' - 'Case Closed' - 'ANS Operator Error' - 'Customer Error' - 'Out of Scope of Service Contract' example: 'In Progress' readOnly: true contact: type: string example: 'Joe Bloggs' readOnly: true scheduled_date: type: string example: '2020-01-01T10:30:00+00:00' readOnly: true customer_reference: type: string example: my-reference-123 readOnly: false owner: type: string example: 'Joe Bloggs' readOnly: true stage: type: string enum: - 'Case Type' - Identify - 'Pending Assessment' - Approvals - 'Pending Implementation' - 'Implementation Started' - Delivered example: 'Case Type' readOnly: true reason: type: string example: 'Any additional information or special instructions that you would like the team to take into account whilst processing the change.' readOnly: false impact: type: string enum: - High - Medium - Low example: High readOnly: false risk: type: string enum: - High - Medium - Low example: High readOnly: false service_name: type: string example: 'Cloud Centre of Excellence (CCOE)' readOnly: true estimated_time_for_completion: type: integer example: 60 readOnly: true estimated_downtime: type: integer example: 60 readOnly: true impact_and_potential_risks: type: string example: 'Impact and potential risks of the change' readOnly: true backout_plan: type: string example: 'Backout plan' readOnly: true implementation_steps: type: string example: 'Implementation steps' readOnly: true test_steps: type: string example: 'Test steps' readOnly: true created_at: type: string example: '2020-01-01T10:30:00+00:00' readOnly: true updated_at: type: string example: '2020-01-01T10:30:00+00:00' readOnly: true category_id: type: string example: 78e8a223-c125-4641-8ca9-c201d2cc4785 generationStrategy: uuid readOnly: false writeOnly: true supported_service_id: type: string example: 78e8a223-c125-4641-8ca9-c201d2cc4785 generationStrategy: uuid readOnly: false writeOnly: true description: 'Change Case' required: { } Feedback: properties: id: type: integer example: 1 readOnly: true contact_id: type: integer example: 1 readOnly: false created_at: type: string example: '2020-01-01T10:30:00+00:00' readOnly: true score: type: integer example: 1 readOnly: false comment: type: string example: 'Wowo, this is good service!' readOnly: false speed_resolved: type: integer example: 1 readOnly: false quality: type: integer example: 1 readOnly: false nps_score: type: integer example: 1 readOnly: false thirdparty_consent: type: boolean example: true readOnly: false description: '' required: { } 'Incident Case': properties: id: type: string example: INC123456 readOnly: true case_type: type: string enum: - Incident example: Incident readOnly: false title: type: string example: 'Title of the incident' readOnly: false description: type: string example: 'Description of the incident' readOnly: false is_security: type: boolean example: true readOnly: false type: type: string enum: - Fault - 'Service Request' - 'Change Advisory' - 'Project Incident' - 'Access Request' - 'Scheduled Maintenance' - 'Architectural Advice' - 'Security Event' example: Fault readOnly: false priority: type: string enum: - P1 - P2 - P3 - P4 - P5 example: P1 readOnly: true squad: type: string example: 'SMB - Windows' readOnly: true status: type: string enum: - 'In Progress' - 'On Hold' - Open - 'Case Created' - Resolved - 'Pending Assessment' - 'Pending SME' - 'Problem Assessment' - Closed - 'Pending Customers Approval' - 'Pending ANS CAB' - 'Pending Implementation' - 'Implementation Started' - Delivered - Rejected - 'Schedule Change' - 'Customer Closure' - 'Problem Solved' - 'Information Provided' - 'Closed with Customer Consent' - 'Closed - Customer Not Contactable' - 'Closed with Team Leader Approval' - 'Case Closed' - 'ANS Operator Error' - 'Customer Error' - 'Out of Scope of Service Contract' example: 'In Progress' readOnly: true customer_reference: type: string example: my-reference-123 readOnly: false source: type: string example: GLASS readOnly: true contact_id: type: integer example: '123' readOnly: false writeOnly: true contact: type: string example: 'Joe Bloggs' readOnly: true criteria_for_resolution: type: string example: 'Investigate and resolve' readOnly: true service_name: type: string example: 'Cloud Centre of Excellence (CCOE)' readOnly: true owner: type: string example: 'Joe Bloggs' readOnly: true response_target: type: string example: '2020-01-01T10:30:00+00:00' readOnly: true resolution_target: type: string example: '2020-01-01T10:30:00+00:00' readOnly: true created_at: type: string example: '2020-01-01T10:30:00+00:00' readOnly: true updated_at: type: string example: '2020-01-01T10:30:00+00:00' readOnly: true category_id: type: string example: 78e8a223-c125-4641-8ca9-c201d2cc4785 generationStrategy: uuid readOnly: false writeOnly: true supported_service_id: type: string example: 78e8a223-c125-4641-8ca9-c201d2cc4785 generationStrategy: uuid readOnly: false writeOnly: true impact: type: string enum: - Major - Moderate - Minor example: Major readOnly: false writeOnly: true description: 'Incident Case' required: { } 'Problem Case': properties: id: type: string example: PRB123458 readOnly: true case_type: type: string enum: - Problem example: Problem readOnly: true title: type: string example: 'Title of the problem' readOnly: true description: type: string example: 'Description of the problem' readOnly: true is_security: type: boolean example: true readOnly: true type: type: string enum: - RCA - 'Known Error' - Vulnerability - 'Issue Re-Occurence' - Non-Compliance - 'Bug Fix' example: RCA readOnly: true priority: type: string enum: - PRB1 - PRB2 - PRB3 - PRB4 - PRB5 - PRB-RCA - PRB-MI example: PRB1 readOnly: true squad: type: string example: 'SMB - Windows' readOnly: true status: type: string enum: - 'In Progress' - 'On Hold' - Open - 'Case Created' - Resolved - 'Pending Assessment' - 'Pending SME' - 'Problem Assessment' - Closed - 'Pending Customers Approval' - 'Pending ANS CAB' - 'Pending Implementation' - 'Implementation Started' - Delivered - Rejected - 'Schedule Change' - 'Customer Closure' - 'Problem Solved' - 'Information Provided' - 'Closed with Customer Consent' - 'Closed - Customer Not Contactable' - 'Closed with Team Leader Approval' - 'Case Closed' - 'ANS Operator Error' - 'Customer Error' - 'Out of Scope of Service Contract' example: 'In Progress' readOnly: true current_assignee: type: string example: Joe readOnly: true urgency: type: string enum: - 'System / Service Down' - 'System / Service Affected' - 'User Down / Affected' example: 'System / Service Down' readOnly: true detailed_impact: type: string enum: - Major - Moderate - Minor example: Major readOnly: true known_workaround: type: string enum: - 'Not Currently Known' - 'Temporary Workaround' - 'Permanent Workaround' - 'Currently Unavailable / Awaiting Vendor' example: 'Not Currently Known' readOnly: true known_workaround_details: type: string example: 'Details of the workaround for the problem' readOnly: true known_cause: type: string enum: - 'Not Currently Known' - 'Software Defect' - 'Hardware Failure' - 'Communications Failure' - 'Hardware Limitation' - 'Business Process Issue' - User example: 'Not Currently Known' readOnly: true created_at: type: string example: '2020-01-01T10:30:00+00:00' readOnly: true updated_at: type: string example: '2020-01-01T10:30:00+00:00' readOnly: true description: 'Problem Case' required: { } Reply: properties: id: type: string example: C5837 readOnly: true author: type: object $ref: '#/components/schemas/Author' readOnly: false description: type: string example: 'How to enable backups for my server' readOnly: false created_at: type: string example: '2020-01-01T10:30:00+00:00' readOnly: true attachments: type: array items: type: object properties: name: type: string example: file.png readOnly: true description: 'A single reply in a request conversation' required: { } Request: properties: id: type: integer example: 1 readOnly: true author: type: object $ref: '#/components/schemas/Author' readOnly: false type: type: string enum: - Linux - Windows - General - Datacentre - Network - Backup - Launch - 'R&D' - 'Backup Restore' example: Linux readOnly: true secure: type: boolean example: true readOnly: false subject: type: string example: "Domain isn't working" readOnly: false details: type: string example: 'Configuration error' readOnly: false created_at: type: string example: '2020-01-01T10:30:00+00:00' readOnly: true priority: type: string enum: - Low - Normal - High - Critical example: Low readOnly: false archived: type: boolean example: true readOnly: false status: type: string enum: - Completed - 'Awaiting Customer Response' - 'Replied and Completed' - Submitted example: Completed readOnly: false request_sms: type: boolean example: true readOnly: false version: type: integer example: '2' readOnly: false customer_reference: type: string example: TICKET12 readOnly: false system_reference: type: string example: bxgq9nw1ypfrg-revud5gpk-9qsey5d0a9y9z readOnly: true product: type: object properties: id: type: integer example: 1 type: type: string enum: - 'eCloud Flex' - SSL - eCloud - Firewalls - Servers - 'Shared Exchange' - Domains example: 'eCloud Flex' readOnly: false last_replied_at: type: string example: '2020-01-01T10:30:00+00:00' readOnly: true unread_replies: type: integer example: 2 readOnly: true description: 'A support request' required: - secure - subject - priority 'Supported Service': properties: id: type: string example: 78e8a223-c125-4641-8ca9-c201d2cc4785 generationStrategy: uuid readOnly: true name: type: string example: 'Managed Cloud' readOnly: true description: 'Supported Service - used to create Incident and Change Cases' required: { } securitySchemes: api_key: type: apiKey description: 'API key authentication' in: header name: Authorization security: - api_key: - api_key paths: { }