Secvisogram 2.0 CSAF-Backend API

CSAF Content Management Systems: Secvisogram 2.0
More information: https://openapi-generator.tech
Contact Info: team@openapitools.org
Version: 1.0.0
BasePath:
MIT
https://mit-license.org/

Access

Methods

[ Jump to Models ]

Table of Contents

Advisory

Main

Advisory

Up 
post /api/v1/advisories/{advisoryId}/comments/{commentId}/answers
Add an answer to an advisory comment. (addAnswer)
Add a answer to the comment with the given ID.

Path parameters

advisoryId (required)
Path Parameter — The ID of the advisory the answered comment belongs to. default: null
commentId (required)
Path Parameter — The ID of the comment to add the answer to. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body string (required)
Body Parameter —

Return type

EntityCreateResponse

Example data

Content-Type: */*
{
  "id" : "9690e3a3-614f-44be-8709-3aa8d58b6cb5",
  "revision" : "2-efaa5db9409b2d4300535c70aaf6a66b"
}

Example data

Content-Type: application/json
{
  "id" : "9690e3a3-614f-44be-8709-3aa8d58b6cb5",
  "revision" : "2-efaa5db9409b2d4300535c70aaf6a66b"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

401

Unauthorized access. EntityCreateResponse

400

Invalid advisory id. EntityCreateResponse

404

Advisory or comment not found. EntityCreateResponse

500

Error during process the advisory. EntityCreateResponse

200

Answer created. EntityCreateResponse
Up 
patch /api/v1/advisories/{advisoryId}/comments/{commentId}/answers/{answerId}
Change answer text to an advisory comment. (changeAnswer)
Change the text of an answer to a comment.

Path parameters

advisoryId (required)
Path Parameter — The ID of the advisory the answered comment belongs to. default: null
commentId (required)
Path Parameter — The ID of the comment to change an answer of. default: null
answerId (required)
Path Parameter — The ID of the answer to change. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body string (required)
Body Parameter —

Query parameters

revision (required)
Query Parameter — Optimistic locking revision of the answer. default: null

Return type

EntityCreateResponse

Example data

Content-Type: */*
{
  "id" : "9690e3a3-614f-44be-8709-3aa8d58b6cb5",
  "revision" : "2-efaa5db9409b2d4300535c70aaf6a66b"
}

Example data

Content-Type: application/json
{
  "id" : "9690e3a3-614f-44be-8709-3aa8d58b6cb5",
  "revision" : "2-efaa5db9409b2d4300535c70aaf6a66b"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

401

Unauthorized access. EntityUpdateResponse

200

Answer changed. EntityCreateResponse

400

Invalid advisory or comment id. EntityUpdateResponse

500

Error during process the advisory. EntityUpdateResponse

404

Advisory, comment or answer not found. EntityUpdateResponse
Up 
patch /api/v1/advisories/{advisoryId}/comments/{commentId}
Change the text of a comment. (changeComment)
Change the text of the comment with the given ID.

Path parameters

advisoryId (required)
Path Parameter — The ID of the advisory a comment of. default: null
commentId (required)
Path Parameter — The ID of the comment to change. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body string (required)
Body Parameter —

Query parameters

revision (required)
Query Parameter — Optimistic locking revision. default: null

Return type

EntityCreateResponse

Example data

Content-Type: */*
{
  "id" : "9690e3a3-614f-44be-8709-3aa8d58b6cb5",
  "revision" : "2-efaa5db9409b2d4300535c70aaf6a66b"
}

Example data

Content-Type: application/json
{
  "id" : "9690e3a3-614f-44be-8709-3aa8d58b6cb5",
  "revision" : "2-efaa5db9409b2d4300535c70aaf6a66b"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

401

Unauthorized access. EntityUpdateResponse

200

Comment changed. EntityCreateResponse

400

Invalid advisory id. EntityUpdateResponse

404

Advisory or comment not found. EntityUpdateResponse

500

Error during process the advisory. EntityUpdateResponse
Up 
patch /api/v1/advisories/{advisoryId}
Change advisory. (changeCsafDocument)
Change a CSAF document in the system. On saving a document its content (version) may change. Thus, after changing a document, it must be reloaded on the client side.

Path parameters

advisoryId (required)
Path Parameter — The ID of the advisory to change. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

CreateAdvisoryRequest CreateAdvisoryRequest (required)
Body Parameter —

Query parameters

revision (required)
Query Parameter — The optimistic locking revision. default: null

Return type

EntityUpdateResponse

Example data

Content-Type: */*
{
  "revision" : "2-efaa5db9409b2d4300535c70aaf6a66b"
}

Example data

Content-Type: application/json
{
  "revision" : "2-efaa5db9409b2d4300535c70aaf6a66b"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

401

Unauthorized access. EntityUpdateResponse

404

Advisory not found. EntityUpdateResponse

200

Id and revison id of new advisory- EntityUpdateResponse

422

Advisory is not valid. EntityUpdateResponse

400

Required content of advisory is wrong, malformed or missing. EntityUpdateResponse

500

Error storing or reading database. EntityUpdateResponse
Up 
post /api/v1/advisories/{advisoryId}/comments
Create a new comment in the system. (createComment)
Creates a new comment associated with the advisory with the given ID. The comments are generated independently of the CSAF document and may link to a specific node of the CSAF document by its $nodeId

Path parameters

advisoryId (required)
Path Parameter — The ID of the advisory to add the comments to. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body string (required)
Body Parameter —

Return type

EntityCreateResponse

Example data

Content-Type: */*
{
  "id" : "9690e3a3-614f-44be-8709-3aa8d58b6cb5",
  "revision" : "2-efaa5db9409b2d4300535c70aaf6a66b"
}

Example data

Content-Type: application/json
{
  "id" : "9690e3a3-614f-44be-8709-3aa8d58b6cb5",
  "revision" : "2-efaa5db9409b2d4300535c70aaf6a66b"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Comment created. EntityCreateResponse

401

Unauthorized access. EntityCreateResponse

400

Invalid advisory id. EntityCreateResponse

500

Error during process the advisory. EntityCreateResponse
Up 
post /api/v1/advisories
Create a new Advisory. (createCsafDocument)
Create a new CSAF document with added node IDs in the system. It possible to add an summary and a legacy version information for the revision history.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

CreateAdvisoryRequest CreateAdvisoryRequest (required)
Body Parameter —

Return type

EntityCreateResponse

Example data

Content-Type: */*
{
  "id" : "9690e3a3-614f-44be-8709-3aa8d58b6cb5",
  "revision" : "2-efaa5db9409b2d4300535c70aaf6a66b"
}

Example data

Content-Type: application/json
{
  "id" : "9690e3a3-614f-44be-8709-3aa8d58b6cb5",
  "revision" : "2-efaa5db9409b2d4300535c70aaf6a66b"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

401

Unauthorized access. EntityCreateResponse

400

Required content of advisory is wrong, malformed or missing. EntityCreateResponse

500

Error storing or reading database. EntityCreateResponse

201

Id and revison id of new advisory- EntityCreateResponse
Up 
patch /api/v1/advisories/{advisoryId}/createNewVersion
Increase version of an advisory. (createNewCsafDocumentVersion)
Increase the version of a CSAF document. This can only be done in workflow state Published

Path parameters

advisoryId (required)
Path Parameter — The ID of the advisory to change. default: null

Query parameters

revision (required)
Query Parameter — The optimistic locking revision. default: null

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

400

No valid UUID. String

401

Unauthorized access. String

404

Advisory not found. String

200

Id and revison id of new advisory-

500

Error storing or reading database. String
Up 
delete /api/v1/advisories/{advisoryId}
Delete an advisory. (deleteCsafDocument)
Delete a CSAF document from the system. All older versions of the document, corresponding comments and audit-trails are also deleted.

Path parameters

advisoryId (required)
Path Parameter — The ID of the advisory to change. default: null

Query parameters

revision (required)
Query Parameter — The optimistic locking revision. default: null

Responses

400

No valid UUID.

401

Unauthorized access.

404

Advisory not found.

200

Advisory deleted.

500

Error storing or reading database.
Up 
get /api/v1/advisories/{advisoryId}/csaf
Export a CSAF document. (exportAdvisory)
Export advisory csaf in different formats, possible formats are: PDF, Markdown, HTML, JSON.

Path parameters

advisoryId (required)
Path Parameter — The ID of the advisory to export. default: null

Query parameters

format (optional)
Query Parameter — The format in which the document shall be exported. default: null

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

400

Bad format requested. File

401

Unauthorized access. File

404

Advisory not found. File

500

Error during export. File

200

JSON template for advisory
Up 
post /api/v1/advisories/import
Import a new Advisory. (importCsafDocument)
Import a new CSAF document into the system.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body object (required)
Body Parameter —

Return type

EntityCreateResponse

Example data

Content-Type: */*
{
  "id" : "9690e3a3-614f-44be-8709-3aa8d58b6cb5",
  "revision" : "2-efaa5db9409b2d4300535c70aaf6a66b"
}

Example data

Content-Type: application/json
{
  "id" : "9690e3a3-614f-44be-8709-3aa8d58b6cb5",
  "revision" : "2-efaa5db9409b2d4300535c70aaf6a66b"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

422

CSAF document is not valid, id dulicate or has wrong state. EntityCreateResponse

401

Unauthorized access. EntityCreateResponse

500

Error storing or reading database. EntityCreateResponse

201

Id and revison id of new advisory- EntityCreateResponse
Up 
get /api/v1/advisories/templates
Get all authorized templates. (listAllTemplates)
Get all available templates in the system.

Return type

array[AdvisoryTemplateInformation]

Example data

Content-Type: application/json
[ {
  "templateDescription" : "Template for the profile CSAF base.",
  "templateId" : "33476793"
}, {
  "templateDescription" : "Template for the profile CSAF base.",
  "templateId" : "33476793"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

List of all templates that the user can access. List is empty of no templates are available.
Up 
get /api/v1/advisories/{advisoryId}/comments/{commentId}/answers
Show answers of a comment. (listAnswers)
Show all answers of the comment with the given commentId.

Path parameters

advisoryId (required)
Path Parameter — The ID of the advisory to the comment belongs to. default: null
commentId (required)
Path Parameter — The ID of the comment to get answers of. default: null

Return type

array[CommentInformation]

Example data

Content-Type: */*
[ {
  "answerId" : "9690e3a3-614f-44be-8709-3aa8d58b6cb5",
  "owner" : "Mustermann",
  "answerTo" : "9690e3a3-614f-44be-8709-3aa8d58b6cb5",
  "deletable" : false,
  "changeable" : true
}, {
  "answerId" : "9690e3a3-614f-44be-8709-3aa8d58b6cb5",
  "owner" : "Mustermann",
  "answerTo" : "9690e3a3-614f-44be-8709-3aa8d58b6cb5",
  "deletable" : false,
  "changeable" : true
} ]

Example data

Content-Type: application/json
[ {
  "answerId" : "9690e3a3-614f-44be-8709-3aa8d58b6cb5",
  "owner" : "Mustermann",
  "answerTo" : "9690e3a3-614f-44be-8709-3aa8d58b6cb5",
  "deletable" : false,
  "changeable" : true
}, {
  "answerId" : "9690e3a3-614f-44be-8709-3aa8d58b6cb5",
  "owner" : "Mustermann",
  "answerTo" : "9690e3a3-614f-44be-8709-3aa8d58b6cb5",
  "deletable" : false,
  "changeable" : true
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

401

Unauthorized access.

200

List of all answers for a comment.

404

Advisory or comment not found.

500

Error during process the advisory.

400

Invalid advisory id or comment id.
Up 
get /api/v1/advisories/{advisoryId}/comments
Show comments of an advisory. (listComments)
Show all comments of the advisory with the given advisoryId.

Path parameters

advisoryId (required)
Path Parameter — The ID of the advisory to get the comments of. default: null

Return type

array[CommentInformation]

Example data

Content-Type: */*
[ {
  "answerId" : "9690e3a3-614f-44be-8709-3aa8d58b6cb5",
  "owner" : "Mustermann",
  "answerTo" : "9690e3a3-614f-44be-8709-3aa8d58b6cb5",
  "deletable" : false,
  "changeable" : true
}, {
  "answerId" : "9690e3a3-614f-44be-8709-3aa8d58b6cb5",
  "owner" : "Mustermann",
  "answerTo" : "9690e3a3-614f-44be-8709-3aa8d58b6cb5",
  "deletable" : false,
  "changeable" : true
} ]

Example data

Content-Type: application/json
[ {
  "answerId" : "9690e3a3-614f-44be-8709-3aa8d58b6cb5",
  "owner" : "Mustermann",
  "answerTo" : "9690e3a3-614f-44be-8709-3aa8d58b6cb5",
  "deletable" : false,
  "changeable" : true
}, {
  "answerId" : "9690e3a3-614f-44be-8709-3aa8d58b6cb5",
  "owner" : "Mustermann",
  "answerTo" : "9690e3a3-614f-44be-8709-3aa8d58b6cb5",
  "deletable" : false,
  "changeable" : true
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

401

Unauthorized access.

404

Advisory not found.

400

Invalid advisory id.

200

List of all comments for an advisory.

500

Error during process the advisory.
Up 
get /api/v1/advisories
Get all authorized advisories. (listCsafDocuments)
All CSAF documents for which the logged in user is authorized are returned. This depends on the user's role and the state of the CSAF document.

Query parameters

expression (optional)
Query Parameter — The filter expression in JSON format. Example to find documents with title equal 'title1': { "type" : "Operator", "selector" : [ "csaf", "document", "title" ], "operatorType" : "Equal", "value" : "title1", "valueType" : "Text" }. Possible operatorType's: 'Equal', 'NotEqual', 'Greater', 'GreaterOrEqual', 'Less', 'LessOrEqual', 'ContainsIgnoreCase'. Possible valueType's: 'Text', 'Decimal', 'Boolean'. You can search for all attributes in 'csaf/document default: null format: json

Return type

array[AdvisoryDocumentInformation]

Example data

Content-Type: */*
[ {
  "owner" : "Mustermann",
  "allowedStateChanges" : [ "Approved", "Published" ],
  "currentReleaseDate" : "currentReleaseDate",
  "advisoryId" : "9690e3a3-614f-44be-8709-3aa8d58b6cb5",
  "documentTrackingId" : "RHBA-2019_0024",
  "workflowState" : "Approved",
  "deletable" : false,
  "canCreateVersion" : false,
  "changeable" : true,
  "title" : "Cisco IPv6 Crafted Packet Denial of Service Vulnerability",
  "revision" : "2-efaa5db9409b2d4300535c70aaf6a66b"
}, {
  "owner" : "Mustermann",
  "allowedStateChanges" : [ "Approved", "Published" ],
  "currentReleaseDate" : "currentReleaseDate",
  "advisoryId" : "9690e3a3-614f-44be-8709-3aa8d58b6cb5",
  "documentTrackingId" : "RHBA-2019_0024",
  "workflowState" : "Approved",
  "deletable" : false,
  "canCreateVersion" : false,
  "changeable" : true,
  "title" : "Cisco IPv6 Crafted Packet Denial of Service Vulnerability",
  "revision" : "2-efaa5db9409b2d4300535c70aaf6a66b"
} ]

Example data

Content-Type: application/json
[ {
  "owner" : "Mustermann",
  "allowedStateChanges" : [ "Approved", "Published" ],
  "currentReleaseDate" : "currentReleaseDate",
  "advisoryId" : "9690e3a3-614f-44be-8709-3aa8d58b6cb5",
  "documentTrackingId" : "RHBA-2019_0024",
  "workflowState" : "Approved",
  "deletable" : false,
  "canCreateVersion" : false,
  "changeable" : true,
  "title" : "Cisco IPv6 Crafted Packet Denial of Service Vulnerability",
  "revision" : "2-efaa5db9409b2d4300535c70aaf6a66b"
}, {
  "owner" : "Mustermann",
  "allowedStateChanges" : [ "Approved", "Published" ],
  "currentReleaseDate" : "currentReleaseDate",
  "advisoryId" : "9690e3a3-614f-44be-8709-3aa8d58b6cb5",
  "documentTrackingId" : "RHBA-2019_0024",
  "workflowState" : "Approved",
  "deletable" : false,
  "canCreateVersion" : false,
  "changeable" : true,
  "title" : "Cisco IPv6 Crafted Packet Denial of Service Vulnerability",
  "revision" : "2-efaa5db9409b2d4300535c70aaf6a66b"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

401

Unauthorized access.

200

List of all advisories that the user can access.

400

Invalid filter expression String

500

Error reading advisories
Up 
get /api/v1/advisories/{advisoryId}
Get a single Advisory. (readCsafDocument)
Get the advisory CSAF document and some additional data for the given advisoryId.

Path parameters

advisoryId (required)
Path Parameter — The ID of the advisory to read. default: null

Return type

AdvisoryDocument

Example data

Content-Type: */*
{
  "owner" : "Mustermann",
  "allowedStateChanges" : [ "Approved", "Published" ],
  "currentReleaseDate" : "currentReleaseDate",
  "advisoryId" : "9690e3a3-614f-44be-8709-3aa8d58b6cb5",
  "documentTrackingId" : "RHBA-2019_0024",
  "workflowState" : "Approved",
  "deletable" : false,
  "canCreateVersion" : false,
  "changeable" : true,
  "csaf" : "{$nodeId: \"nodeId123\", document: { $nodeId: \"nodeId567\", category: \"CSAF Base\",... }, vulnerabilities: {...}}",
  "title" : "Cisco IPv6 Crafted Packet Denial of Service Vulnerability",
  "revision" : "2-efaa5db9409b2d4300535c70aaf6a66b"
}

Example data

Content-Type: application/json
{
  "owner" : "Mustermann",
  "allowedStateChanges" : [ "Approved", "Published" ],
  "currentReleaseDate" : "currentReleaseDate",
  "advisoryId" : "9690e3a3-614f-44be-8709-3aa8d58b6cb5",
  "documentTrackingId" : "RHBA-2019_0024",
  "workflowState" : "Approved",
  "deletable" : false,
  "canCreateVersion" : false,
  "changeable" : true,
  "csaf" : "{$nodeId: \"nodeId123\", document: { $nodeId: \"nodeId567\", category: \"CSAF Base\",... }, vulnerabilities: {...}}",
  "title" : "Cisco IPv6 Crafted Packet Denial of Service Vulnerability",
  "revision" : "2-efaa5db9409b2d4300535c70aaf6a66b"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

401

Unauthorized access. AdvisoryDocument

404

Requested advisory not found. AdvisoryDocument

500

Error reading advisory. AdvisoryDocument

400

Invalid UUID AdvisoryDocument

200

Single requested advisory AdvisoryDocument
Up 
get /api/v1/advisories/templates/{templateId}
Get template content. (readTemplate)
Get the content of the template with the given templateId.

Path parameters

templateId (required)
Path Parameter — The ID of the template to read. default: null

Return type

Object

Example data

Content-Type: */*
"{$nodeId: \"nodeId123\", document: { $nodeId: \"nodeId567\", category: \"CSAF Base\",... }, vulnerabilities: {...}}"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

401

Unauthorized access. Object

500

Error loading template. Object

200

JSON template for advisory Object

404

Template not found. Object
Up 
patch /api/v1/advisories/{advisoryId}/workflowstate/Approved
Change workflow state of an advisory to Approved. (setWorkflowStateToApproved)
Change the workflow state of the advisory with the given id to Approve.

Path parameters

advisoryId (required)
Path Parameter — The ID of the advisory to change the workflow state of. default: null

Query parameters

revision (required)
Query Parameter — The optimistic locking revision. default: null

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

400

Advisory ID not found. String

422

Invalid formatted advisory. String

200

Workflow state changed to approved.

401

Unauthorized access to change workflow state. String
Up 
patch /api/v1/advisories/{advisoryId}/workflowstate/Draft
Change workflow state of an advisory to Draft. (setWorkflowStateToDraft)
Change the workflow state of the advisory with the given id to Draft.

Path parameters

advisoryId (required)
Path Parameter — The ID of the advisory to change the workflow state of. default: null

Query parameters

revision (required)
Query Parameter — The optimistic locking revision. default: null

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

400

Advisory ID not found. String

200

Workflow state changed to draft.

422

Invalid formatted advisory. String

401

Unauthorized access to change workflow state. String
Up 
patch /api/v1/advisories/{advisoryId}/workflowstate/Published
Change workflow state of an advisory to Published. (setWorkflowStateToPublished)
Change the workflow state of the advisory with the given id to Published.

Path parameters

advisoryId (required)
Path Parameter — The ID of the advisory to change the workflow state of. default: null

Query parameters

revision (required)
Query Parameter — Optimistic locking revision. default: null
proposedTime (optional)
Query Parameter — Proposed Time at which the publication should take place as ISO-8601 UTC string. default: null
documentTrackingStatus (required)
Query Parameter — The new Document Tracking Status of the CSAF Document. Only Interim and Final are allowed. default: null

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Workflow state changed to Publication.

400

Advisory ID not found. String

422

Invalid formatted advisory. String

500

Error during process the advisory. String

401

Unauthorized access to change workflow state. String
Up 
patch /api/v1/advisories/{advisoryId}/workflowstate/Review
Change workflow state of an advisory to Draft. (setWorkflowStateToReview)
Change the workflow state of the advisory with the given id to Review.

Path parameters

advisoryId (required)
Path Parameter — The ID of the advisory to change the workflow state of. default: null

Query parameters

revision (required)
Query Parameter — The optimistic locking revision. default: null

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

400

Advisory ID not found. String

200

Workflow state changed to review.

422

Invalid formatted advisory. String

401

Unauthorized access to change workflow state. String
Up 
patch /api/v1/advisories/{advisoryId}/workflowstate/RfPublication
Change workflow state of an advisory to RfPublication. (setWorkflowStateToRfPublication)
Change the workflow state of the advisory with the given id to Request for Publication (Request for Publication).

Path parameters

advisoryId (required)
Path Parameter — The ID of the advisory to change the workflow state of. default: null

Query parameters

revision (required)
Query Parameter — The optimistic locking revision. default: null
proposedTime (optional)
Query Parameter — Proposed Time at which the publication should take place as ISO-8601 UTC string. default: null

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

400

Advisory ID not found. String

422

Invalid formatted advisory. String

503

Validation server not available. String

200

Workflow state changed to RfPublication.

401

Unauthorized access to change workflow state. String

Main

Up 
get /api/v1/about
Current version (about)
Get the current version of the backend service.

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Version String as JSON String

Models

[ Jump to Methods ]

Table of Contents

  1. AdvisoryDocument -
  2. AdvisoryDocumentInformation -
  3. AdvisoryTemplateInformation -
  4. CommentInformation -
  5. CreateAdvisoryRequest -
  6. EntityCreateResponse -
  7. EntityUpdateResponse -

AdvisoryDocument - Up

revision (optional)
String The document revision for optimistic concurrency.
advisoryId (optional)
String The unique ID of the advisory.
workflowState (optional)
String The current workflow state of the advisory.
Enum:
Draft
Review
Approved
RfPublication
Published
documentTrackingId (optional)
String The CSAF tracking ID of the advisory.
title (optional)
String The CSAF title of the advisory.
owner (optional)
String The current owner of the advisory.
changeable (optional)
Boolean Indicates if the currently logged in user can change this advisory.
deletable (optional)
Boolean Indicates if the logged in user can delete this advisory.
canCreateVersion (optional)
Boolean Indicates if the logged in user can create a new csaf document version of this advisory.
allowedStateChanges (optional)
array[String] A list of allowed state changes of the logged in user.
Enum:
currentReleaseDate (optional)
String
csaf (optional)
Object The current CSAF document enhanced with comment IDs.

AdvisoryDocumentInformation - Up

revision (optional)
String The document revision for optimistic concurrency.
advisoryId (optional)
String The unique ID of the advisory.
workflowState (optional)
String The current workflow state of the advisory.
Enum:
Draft
Review
Approved
RfPublication
Published
documentTrackingId (optional)
String The CSAF tracking ID of the advisory.
title (optional)
String The CSAF title of the advisory.
owner (optional)
String The current owner of the advisory.
changeable (optional)
Boolean Indicates if the currently logged in user can change this advisory.
deletable (optional)
Boolean Indicates if the logged in user can delete this advisory.
canCreateVersion (optional)
Boolean Indicates if the logged in user can create a new csaf document version of this advisory.
allowedStateChanges (optional)
array[String] A list of allowed state changes of the logged in user.
Enum:
currentReleaseDate (optional)
String

AdvisoryTemplateInformation - Up

templateId (optional)
String The unique ID of the template.
templateDescription (optional)
String The description of the template.

CommentInformation - Up

answerId (optional)
String The unique ID of the answer.
owner (optional)
String The current owner of the answer.
answerTo (optional)
String The ID of the comment this is an answer to.
changeable (optional)
Boolean Indicates if the currently logged in user can change this answer.
deletable (optional)
Boolean Indicates if the logged in user can delete this answer.

CreateAdvisoryRequest - Up

summary (optional)
String The text of the summary in the revision history.
legacyVersion (optional)
String The text of the legacy version in the revision history.
csaf (optional)
Object The current CSAF document enhanced with comment IDs.

EntityCreateResponse - Up

id (optional)
String The unique ID of the create object.
revision (optional)
String The document revision for optimistic concurrency.

EntityUpdateResponse - Up

revision (optional)
String The document revision for optimistic concurrency.