1. Home
  2. Docs
  3. API Documentation
  4. Reports
  5. CreateProjectReport

CreateProjectReport

Route: https://kayran.live/api/CreateProjectReport

You can use this function to create a summary report on an entire project, even if it consists of several scans.

Roles Required: Admin and Users. Private Users can only Create Reports for Projects and Scans they have created.

Request Syntax

{
    "apiKey": "String",
    "type": json|docx|pdf|html|csv|xml,
    "projectId": 0123456789,
    "projectName": ["111", "222"]
}

Request Parameters

Parameters being used in the Request

Parameter Name :

apiKey

Parameter Usage and Options :

Your Kayran given API Key.

How do I get it ? :

Located in the “Profile” section.

Note : by default, the “API Status” is enabled, unless, the Admin has disabled it in the “Server Settings” section.

Type :

String

Is it Optional ? :

No.


Parameter Name :

type

Parameter Usage and Options :

The type\format of the report you wish to export.

Value :

json\docx\pdf\html\csv\xml.

Type :

String

Is it Optional ? :

No.


Parameter Name :

projectId

Parameter Usage and Options :

The ID of the requested project.

How do I get it ? :

Simply use the “DetailsProject” or “GetProjects” functions.

Type :

Integer

Is it Optional ? :

Yes – you can just insert the project’s name instead.


Parameter Name :

projectName

Parameter Usage and Options :

This Name of the requested project.

How do I get it ? :

Simply use the “DetailsProject” or “GetProjects” functions, or, refer to the projects table in the “Projects” section on your Kayran server.

Type :

String

Is it Optional ? :

No.


Successful Response


{
    "company_name": "Name",
    "about_company": "des",
    "date": "30/05/2022 02:04:34 PM",
    "targets": []
}

Errors and their Possible Causes

For more information, please refer to the General Errors section.