{"items":[{"type":"link","label":"Code Insight REST API Documentation","link":"/swagger","routeSlug":"/swagger","content":{"contentType":"overview","meta":{"name":"Code Insight REST API Documentation"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"swagger.json","url":"/_bundle/swagger.json?download"},{"kind":"download","label":"swagger.yaml","url":"/_bundle/swagger.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Code Insight REST API Documentation (v1)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Code Insight REST APIs provide a standardized interface for interacting with the application."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An authorization JWT token must be included in the HTTP Authorization header using the Bearer schema."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token can be obtained from the Code Insight Web UI under the Preferences menu."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To set the token, click the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorize"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" button below on the right, enter the JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, then click Authorize and close the dialog. Once authorized, the token will be automatically included in the HTTP Authorization header for all API requests made through the Swagger UI."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If accessing the REST APIs through external tools such as "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"curl"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Postman"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", include the token manually in the HTTP header using the following format:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer JWT_TOKEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Bearer\" must precede the actual JWT token value."},"children":[]}]}]}]}]}]}],"sectionId":"/swagger"}],"sectionId":"/swagger"}]}]}},{"type":"group","label":"Email Templates","link":"/swagger/email-templates","routeSlug":"/swagger/email-templates","items":[{"label":"Get custom email template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/email-templates/getemailtemplate","routeSlug":"/swagger/email-templates/getemailtemplate","metadata":{"seo":{"title":"Get custom email template","description":"Retrieves a custom email template from the core server's file system"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEmailTemplate","name":"Get custom email template","isWebhook":false,"pointer":"/paths/~1emailTemplates~1{templateName}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get custom email template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a custom email template from the core server's file system"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"templateName","in":"path","schemaId":"schema_57","description":"Template name without .html extension","required":true}],"pointer":"/paths/~1emailTemplates~1{templateName}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/emailTemplates/{templateName}","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"templateName","in":"path","required":true,"schemaId":"schema_57"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404","500"],"pointer":"/emailTemplates/{templateName}","href":"email-templates/getemailtemplate","openApiOperationId":"getEmailTemplate","summary":"Get custom email template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Template content returned successfully"},{"code":"404","description":"Template not found"},{"code":"500","description":"Internal server error"}],"pointer":"/paths/~1emailTemplates~1{templateName}/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/email-templates/getemailtemplate"}],"panels":[]}]},"httpPath":"/emailTemplates/{templateName}"},{"label":"Get email template inline image","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/email-templates/getemailtemplateimage","routeSlug":"/swagger/email-templates/getemailtemplateimage","metadata":{"seo":{"title":"Get email template inline image","description":"Retrieves an inline image from the core server's email templates images folder"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEmailTemplateImage","name":"Get email template inline image","isWebhook":false,"pointer":"/paths/~1emailTemplates~1images~1{imageName}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get email template inline image","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves an inline image from the core server's email templates images folder"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"imageName","in":"path","schemaId":"schema_57","description":"Image filename with extension","required":true}],"pointer":"/paths/~1emailTemplates~1images~1{imageName}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/emailTemplates/images/{imageName}","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"imageName","in":"path","required":true,"schemaId":"schema_57"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404","500"],"pointer":"/emailTemplates/images/{imageName}","href":"email-templates/getemailtemplateimage","openApiOperationId":"getEmailTemplateImage","summary":"Get email template inline image"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Image returned successfully"},{"code":"404","description":"Image not found"},{"code":"500","description":"Internal server error"}],"pointer":"/paths/~1emailTemplates~1images~1{imageName}/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/email-templates/getemailtemplateimage"}],"panels":[]}]},"httpPath":"/emailTemplates/images/{imageName}"},{"label":"Check if custom email template exists","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/email-templates/templateexists","routeSlug":"/swagger/email-templates/templateexists","metadata":{"seo":{"title":"Check if custom email template exists","description":"Checks if a custom email template exists on the core server"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"templateExists","name":"Check if custom email template exists","isWebhook":false,"pointer":"/paths/~1emailTemplates~1{templateName}~1exists/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Check if custom email template exists","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Checks if a custom email template exists on the core server"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"templateName","in":"path","schemaId":"schema_57","description":"Template name without .html extension","required":true}],"pointer":"/paths/~1emailTemplates~1{templateName}~1exists/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/emailTemplates/{templateName}/exists","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"templateName","in":"path","required":true,"schemaId":"schema_57"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/emailTemplates/{templateName}/exists","href":"email-templates/templateexists","openApiOperationId":"templateExists","summary":"Check if custom email template exists"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Template exists"},{"code":"404","description":"Template not found"}],"pointer":"/paths/~1emailTemplates~1{templateName}~1exists/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/email-templates/templateexists"}],"panels":[]}]},"httpPath":"/emailTemplates/{templateName}/exists"}],"content":{"contentType":"group","meta":{"name":"Email Templates"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Email Templates","showPageActions":true},{"nodeType":"markdoc","content":"Internal API for fetching custom email templates and images from core server"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/emailTemplates/{templateName}","summary":"Get custom email template","prefix":{"name":"get","color":"get"},"badges":[],"link":"/email-templates/getemailtemplate","deprecated":false},{"title":"/emailTemplates/images/{imageName}","summary":"Get email template inline image","prefix":{"name":"get","color":"get"},"badges":[],"link":"/email-templates/getemailtemplateimage","deprecated":false},{"title":"/emailTemplates/{templateName}/exists","summary":"Check if custom email template exists","prefix":{"name":"get","color":"get"},"badges":[],"link":"/email-templates/templateexists","deprecated":false}]}]}]}]}},{"type":"group","label":"CodebaseFolder","link":"/swagger/codebasefolder","routeSlug":"/swagger/codebasefolder","items":[{"label":"Mark folder as reviewed/unreviewed","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/codebasefolder/updatefolderreview","routeSlug":"/swagger/codebasefolder/updatefolderreview","metadata":{"seo":{"title":"Mark folder as reviewed/unreviewed","description":"For the given folderId mark as reviewed/unreviewed. Only the Analyst has the permission to do this operation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateFolderReview","name":"Mark folder as reviewed/unreviewed","isWebhook":false,"pointer":"/paths/~1codebasefolder~1{folderId}~1review/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Mark folder as reviewed/unreviewed","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"For the given folderId mark as reviewed/unreviewed. Only the Analyst has the permission to do this operation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"folderId","in":"path","schemaId":"schema_58","description":"ID of the Folder","required":true,"example":1}],"pointer":"/paths/~1codebasefolder~1{folderId}~1review/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"isRemote","in":"query","schemaId":"schema_59","description":"if true, fetch results of corresponding remote folder"},{"name":"markAsReviewed","in":"query","schemaId":"schema_59","description":"if true, mark files inside the folder as reviewed"}],"pointer":"/paths/~1codebasefolder~1{folderId}~1review/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/codebasefolder/{folderId}/review","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"folderId","in":"path","required":true,"example":1,"schemaId":"schema_58"}],"query":[{"name":"isRemote","in":"query","schemaId":"schema_59"},{"name":"markAsReviewed","in":"query","schemaId":"schema_59"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/codebasefolder/{folderId}/review","href":"codebasefolder/updatefolderreview","openApiOperationId":"updateFolderReview","summary":"Mark folder as reviewed/unreviewed"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1codebasefolder~1{folderId}~1review/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/codebasefolder/updatefolderreview"}],"panels":[]}]},"httpPath":"/codebasefolder/{folderId}/review"}],"content":{"contentType":"group","meta":{"name":"CodebaseFolder"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CodebaseFolder","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/codebasefolder/{folderId}/review","summary":"Mark folder as reviewed/unreviewed","prefix":{"name":"put","color":"put"},"badges":[],"link":"/codebasefolder/updatefolderreview","deprecated":false}]}]}]}]}},{"type":"group","label":"Deprecated APIs","link":"/swagger/deprecated-apis","routeSlug":"/swagger/deprecated-apis","items":[{"label":"Component Lookup","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/deprecated-apis/componentlookup","routeSlug":"/swagger/deprecated-apis/componentlookup","metadata":{"seo":{"title":"Component Lookup","description":"This API is Deprecated and new API is codeinsight/api/components/search"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"componentLookup","name":"Component Lookup","deprecated":true,"isWebhook":false,"pointer":"/paths/~1component~1lookup/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Component Lookup","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This API is Deprecated and new API is codeinsight/api/components/search"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"keyword","in":"query","schemaId":"schema_57","description":"Any Keyword (Example: GNU)","required":true},{"name":"size","in":"query","schemaId":"schema_60","description":"Page Size"},{"name":"page","in":"query","schemaId":"schema_61","description":"Page Number"}],"pointer":"/paths/~1component~1lookup/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/component/lookup","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[{"name":"keyword","in":"query","required":true,"schemaId":"schema_57"},{"name":"size","in":"query","schemaId":"schema_60"},{"name":"page","in":"query","schemaId":"schema_61"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/component/lookup","href":"deprecated-apis/componentlookup","openApiOperationId":"componentLookup","summary":"Component Lookup"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}},"schemaId":"schema_57"},{"code":"400","description":"Bad request"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1component~1lookup/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_57","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}}},{"code":"400"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/deprecated-apis/componentlookup"}],"panels":[]}]},"httpPath":"/component/lookup"},{"label":"Generate Report","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/deprecated-apis/generatereport","routeSlug":"/swagger/deprecated-apis/generatereport","metadata":{"seo":{"title":"Generate Report","description":"This API is deprecated please refer to /projects/{projectId}/reports/{reportId}/generate to Generate a report.Refer /projects/{projectId}/reports/{reportId}/download to Download a report.Generates Reports (PROJECT, AUDIT, NOTICES, CUSTOM_REPORT) for a given projectId. For CUSTOM_REPORT provide the name of the report. All project users including Observer, Reviewer and Analyst can generate reports for private projects.Try it out is not available for this API. This API can be tested using conventional REST API clients such as postman or cURL.When calling this API from a REST client, you need to redirect output to a zip file as follows"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"generateReport","name":"Generate Report","deprecated":true,"isWebhook":false,"pointer":"/paths/~1project~1generateReport/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate Report","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API is deprecated please refer to /projects/{projectId}/reports/{reportId}/generate to Generate a report."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer /projects/{projectId}/reports/{reportId}/download to Download a report."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generates Reports (PROJECT, AUDIT, NOTICES, CUSTOM_REPORT) for a given projectId. For CUSTOM_REPORT provide the name of the report. All project users including Observer, Reviewer and Analyst can generate reports for private projects."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Try it out is not available for this API. This API can be tested using conventional REST API clients such as postman or cURL."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When calling this API from a REST client, you need to redirect output to a zip file as follows"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -X GET \"http://HOST:PORT/codeinsight/api/project/generateReport?reportType=REPORT_TYPE&projectId=PROJECT_ID\" -H \"accept: application/octet-stream\" -H \"Authorization: Bearer JWT_TOKEN\" > report.zip\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -X GET \"http://HOST:PORT/codeinsight/api/project/generateReport?reportType=REPORT_TYPE&projectId=PROJECT_ID\" -H \"accept: application/octet-stream\" -H \"Authorization: Bearer JWT_TOKEN\" > report.zip\n"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"projectId","in":"query","schemaId":"schema_62","description":"ID of the Project","required":true,"example":1},{"name":"reportType","in":"query","schemaId":"schema_57","description":"Report Type","required":true,"example":"PROJECT"},{"name":"otherProjectId","in":"query","schemaId":"schema_63","description":"Project Id of the secondary project to be included in the report. This parameter is required, if the enableProjectPicker property for this report type is set to true. (Example: 2)"}],"pointer":"/paths/~1project~1generateReport/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/project/generateReport","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[{"name":"projectId","in":"query","required":true,"example":1,"schemaId":"schema_62"},{"name":"reportType","in":"query","required":true,"example":"PROJECT","schemaId":"schema_57"},{"name":"otherProjectId","in":"query","schemaId":"schema_63"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/project/generateReport","href":"deprecated-apis/generatereport","openApiOperationId":"generateReport","summary":"Generate Report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/octet-stream","mediaTypes":["application/octet-stream"],"mediaTypeContent":{"application/octet-stream":{}}},{"code":"400","description":"Bad request: No project with id x"}],"pointer":"/paths/~1project~1generateReport/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/deprecated-apis/generatereport"}],"panels":[]}]},"httpPath":"/project/generateReport"},{"label":"Create Project","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/deprecated-apis/createproject","routeSlug":"/swagger/deprecated-apis/createproject","metadata":{"seo":{"title":"Create Project","description":"Use the enhanced '/projects' api."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createProject","name":"Create Project","deprecated":true,"isWebhook":false,"pointer":"/paths/~1project~1createProject/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Project","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use the enhanced '/projects' api."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateProjectModel"}},"schemaId":"components/schemas/CreateProjectModel","pointer":"/paths/~1project~1createProject/post/requestBody","description":"To create a project the projectName field is required and other fields are optional. If the optional fields are left blank, the 'Project Default' values are applied for them."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/project/createProject","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateProjectModel"}},"responseCodes":["200","500"],"pointer":"/project/createProject","href":"deprecated-apis/createproject","openApiOperationId":"createProject","summary":"Create Project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"components/schemas/CreateProjectModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateProjectModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_64"}},"schemaId":"schema_64"},{"code":"500","description":"Error : error message"}],"pointer":"/paths/~1project~1createProject/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_64","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_64"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/deprecated-apis/createproject"}],"panels":[]}]},"httpPath":"/project/createProject"},{"label":"Import Project Data","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/deprecated-apis/importprojectdata","routeSlug":"/swagger/deprecated-apis/importprojectdata","metadata":{"seo":{"title":"Import Project Data","description":"Imports project data for a given projectId. Only Project Owner and Analyst can Import Project Data into a private project.Try it out is not available for this API. This API can be tested using conventional REST API clients such as postman or cURLWhen calling this API from a REST client, you need to run curl as follows"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"importProjectData","name":"Import Project Data","deprecated":true,"isWebhook":false,"pointer":"/paths/~1importer~1importProjectData/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Import Project Data","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Imports project data for a given projectId. Only Project Owner and Analyst can Import Project Data into a private project."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Try it out is not available for this API. This API can be tested using conventional REST API clients such as postman or cURL"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When calling this API from a REST client, you need to run curl as follows"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -X POST \"http://HOST:PORT/codeinsight/api/importer/importProjectData?projectId=PROJECT_ID&checkInventory=false&checkReviewed=false&createEmptyInventory=false&overwriteInventoryNotes=true\" -H \"accept: application/json\" -H \"Authorization: Bearer JWT_TOKEN\" -H \"content-type: application/octet-stream\" --data-binary \"@path/filename.zip\"\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -X POST \"http://HOST:PORT/codeinsight/api/importer/importProjectData?projectId=PROJECT_ID&checkInventory=false&checkReviewed=false&createEmptyInventory=false&overwriteInventoryNotes=true\" -H \"accept: application/json\" -H \"Authorization: Bearer JWT_TOKEN\" -H \"content-type: application/octet-stream\" --data-binary \"@path/filename.zip\"\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Since this is deprecated, you can find the new api under projects api i.e., /projects/{projectId}/import"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"projectId","in":"query","schemaId":"schema_62","description":"ID of the Project","required":true,"example":1},{"name":"checkInventory","in":"query","schemaId":"schema_57","description":"Check file MD5 for inventory. If enabled, only files with matching MD5 in the import data file and the scanned file will be associated to inventory."},{"name":"checkReviewed","in":"query","schemaId":"schema_57","description":"Check file MD5 for review.  If enabled, only files with matching MD5 in the import data file and the scanned file will be marked as reviewed."},{"name":"createEmptyInventory","in":"query","schemaId":"schema_57","description":"Create inventory even if no matching file is found. By default value of this parameter is retrieved from the Project Setting(On data import or rescan, delete inventory with no associated files). If you wish to override the project setting you can pass true or false. "},{"name":"overwriteInventoryNotes","in":"query","schemaId":"schema_57","description":"Choose to overwrite or append inventory notes (Audit Notes, Notices Text, Usage Guidance, Remediation Notes). By default notes will be overwritten if the inventory is same. If set to false, notes will be appended to existing ones."}],"pointer":"/paths/~1importer~1importProjectData/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/octet-stream"],"mediaTypeSchemas":{"application/octet-stream":{"schemaId":"schema_65"}},"schemaId":"schema_65","pointer":"/paths/~1importer~1importProjectData/post/requestBody","description":"Project data to import"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/importer/importProjectData","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[{"name":"projectId","in":"query","required":true,"example":1,"schemaId":"schema_62"},{"name":"checkInventory","in":"query","schemaId":"schema_57"},{"name":"checkReviewed","in":"query","schemaId":"schema_57"},{"name":"createEmptyInventory","in":"query","schemaId":"schema_57"},{"name":"overwriteInventoryNotes","in":"query","schemaId":"schema_57"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/octet-stream":{"schemaId":"schema_65"}},"responseCodes":["200"],"pointer":"/importer/importProjectData","href":"deprecated-apis/importprojectdata","openApiOperationId":"importProjectData","summary":"Import Project Data"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"schema_65","mediaTypes":["application/octet-stream"],"mediaTypeSchemas":{"application/octet-stream":{"schemaId":"schema_65"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{}}}],"pointer":"/paths/~1importer~1importProjectData/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/deprecated-apis/importprojectdata"}],"panels":[]}]},"httpPath":"/importer/importProjectData"}],"content":{"contentType":"group","meta":{"name":"Deprecated APIs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deprecated APIs","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/component/lookup","summary":"Component Lookup","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/deprecated-apis/componentlookup","deprecated":true},{"title":"/project/generateReport","summary":"Generate Report","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/deprecated-apis/generatereport","deprecated":true},{"title":"/project/createProject","summary":"Create Project","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/deprecated-apis/createproject","deprecated":true},{"title":"/importer/importProjectData","summary":"Import Project Data","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/deprecated-apis/importprojectdata","deprecated":true}]}]}]}]}},{"type":"group","label":"Component","link":"/swagger/component","routeSlug":"/swagger/component","items":[{"label":"Component Search","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/component/componentsearch","routeSlug":"/swagger/component/componentsearch","metadata":{"seo":{"title":"Component Search","description":"Search for the components based on the given input and return list of components which includes registered,popular and unpopular.Response will not include vulnerabilities and licenses of the version"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"componentSearch","name":"Component Search","isWebhook":false,"pointer":"/paths/~1components~1search/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Component Search","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Search for the components based on the given input and return list of components which includes registered,popular and unpopular.Response will not include vulnerabilities and licenses of the version"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"searchBy","in":"query","schemaId":"schema_66","description":"Search Type. default is NAME.","required":true},{"name":"filter","in":"query","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search Filter. This is required for searchBy NAME, default is ALL_TERMS."},"children":[]}]}]}]},{"name":"searchTerm","in":"query","schemaId":"schema_57","description":"Any Keyword. This is required for searchBy NAME/URL and optional for CPE. For searchBy CPE, the supplied searchTerm E.g.\"apache commons\" would perform exact match against the component."},{"name":"includeVersions","in":"query","schemaId":"schema_59","description":"If true , response will include versions as well."},{"name":"vendor","in":"query","schemaId":"schema_57","description":"Vendor name (Example: gnu)"},{"name":"product","in":"query","schemaId":"schema_57","description":"Product name (Example: zlib)"},{"name":"forgeName","in":"query","schemaId":"schema_68","description":"Forge Name. is required for searchBy FORGE and optional for NAME/URL/CPE"},{"name":"projectName","in":"query","schemaId":"schema_57","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required param for forges: SourceForge|Apache|MySQL AB|Java.net|GNU|Free Software Directory|CodePlex|Savannah|Google Code|GitLab (Example: apache-batik)"},"children":[]}]}]}]},{"name":"packageName","in":"query","schemaId":"schema_57","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required param for forges: Hackage|NuGet Gallery|npm|PyPI|Packagist|CentOS Project (Example: newtonsoft.json)"},"children":[]}]}]}]},{"name":"groupId","in":"query","schemaId":"schema_57","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required param for forges: Google's Maven Repository|Clojars|Ibiblio Maven2 (Example: com.google.firebase)"},"children":[]}]}]}]},{"name":"artifactId","in":"query","schemaId":"schema_57","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required param for forges: Google's Maven Repository|Clojars|Ibiblio Maven2 (Example: firebase-abt)"},"children":[]}]}]}]},{"name":"moduleOrDistributionName","in":"query","schemaId":"schema_57","description":"Required param for forge: CPAN (Example: exporter-tidy)"},{"name":"packageOrDistributionName","in":"query","schemaId":"schema_57","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required param for forge: CRAN | Fedora Koji (Example: acid)"},"children":[]}]}]}]},{"name":"author","in":"query","schemaId":"schema_57","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required param for forge: GitHub | GitLab (It accepts Author/Org value (Example: jquery)"},"children":[]}]}]}]},{"name":"repositoryName","in":"query","schemaId":"schema_57","description":"Required param for forge: GitHub (Example: jquery-ui)"},{"name":"vendorName","in":"query","schemaId":"schema_57","description":"Required param for forge: Packagist (Example: 100hz)"},{"name":"gemName","in":"query","schemaId":"schema_57","description":"Required param for forge: RubyGems (Example: x-editable-rails)"},{"name":"crate","in":"query","schemaId":"schema_57","description":"Required param for forge: crates.io (Example: brewstillery)"},{"name":"limit","in":"query","schemaId":"schema_69","description":"Page Size. Number Of Records to fetch per page"},{"name":"offset","in":"query","schemaId":"schema_70","description":"Page Number. Index of the page to start with(starts from 1)"}],"pointer":"/paths/~1components~1search/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/components/search","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[{"name":"searchBy","in":"query","required":true,"schemaId":"schema_66"},{"name":"filter","in":"query","schemaId":"schema_67"},{"name":"searchTerm","in":"query","schemaId":"schema_57"},{"name":"includeVersions","in":"query","schemaId":"schema_59"},{"name":"vendor","in":"query","schemaId":"schema_57"},{"name":"product","in":"query","schemaId":"schema_57"},{"name":"forgeName","in":"query","schemaId":"schema_68"},{"name":"projectName","in":"query","schemaId":"schema_57"},{"name":"packageName","in":"query","schemaId":"schema_57"},{"name":"groupId","in":"query","schemaId":"schema_57"},{"name":"artifactId","in":"query","schemaId":"schema_57"},{"name":"moduleOrDistributionName","in":"query","schemaId":"schema_57"},{"name":"packageOrDistributionName","in":"query","schemaId":"schema_57"},{"name":"author","in":"query","schemaId":"schema_57"},{"name":"repositoryName","in":"query","schemaId":"schema_57"},{"name":"vendorName","in":"query","schemaId":"schema_57"},{"name":"gemName","in":"query","schemaId":"schema_57"},{"name":"crate","in":"query","schemaId":"schema_57"},{"name":"limit","in":"query","schemaId":"schema_69"},{"name":"offset","in":"query","schemaId":"schema_70"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/components/search","href":"component/componentsearch","openApiOperationId":"componentSearch","summary":"Component Search"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ComponentListModel"}},"schemaId":"components/schemas/ComponentListModel"},{"code":"400","description":"Bad request"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1components~1search/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ComponentListModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ComponentListModel"}}},{"code":"400"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/component/componentsearch"}],"panels":[]}]},"httpPath":"/components/search"},{"label":"Create a component custom version","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/component/createcomponentversion","routeSlug":"/swagger/component/createcomponentversion","metadata":{"seo":{"title":"Create a component custom version","description":"Create a component custom version"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createComponentVersion","name":"Create a component custom version","isWebhook":false,"pointer":"/paths/~1components~1{componentId}~1versions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a component custom version","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a component custom version"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"componentId","in":"path","schemaId":"schema_58","description":"ID of the Component","required":true,"example":1}],"pointer":"/paths/~1components~1{componentId}~1versions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VersionModel"}},"schemaId":"components/schemas/VersionModel","pointer":"/paths/~1components~1{componentId}~1versions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/components/{componentId}/versions","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"componentId","in":"path","required":true,"example":1,"schemaId":"schema_58"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VersionModel"}},"responseCodes":["201","400","404","500"],"pointer":"/components/{componentId}/versions","href":"component/createcomponentversion","openApiOperationId":"createComponentVersion","summary":"Create a component custom version"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"components/schemas/VersionModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VersionModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created"},{"code":"400","description":"Bad Request"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1components~1{componentId}~1versions/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/component/createcomponentversion"}],"panels":[]}]},"httpPath":"/components/{componentId}/versions"},{"label":"Create a custom component","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/component/createcustomcomponent","routeSlug":"/swagger/component/createcustomcomponent","metadata":{"seo":{"title":"Create a custom component","description":"Creates a custom component"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCustomComponent","name":"Create a custom component","isWebhook":false,"pointer":"/paths/~1components/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a custom component","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a custom component"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ComponentModel"}},"schemaId":"components/schemas/ComponentModel","pointer":"/paths/~1components/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create a custom component the name, title and url field is required."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only users with the “library_manager” permission can create a custom component."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allowable values of forgeId(Optional) are"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 : Other(This will be used as default when none is supplied) | 2 : SourceForge | 3 : Apache | 5 : MySQL AB | 11 : kernel.org | 53 : Mozilla | 78 : Java.net | 87 : GNU | 175 : Free Software Directory | 176 : CodePlex | 186 : Savannah | 248 : CPAN | 419 : Google Code | 628 : Ibiblio Maven2 | 696 : GitHub | 2033 : NuGet Gallery | 2037 : npm |2039 : RubyGems | 2040 : CentOS Project | 2067 : PyPI | 2070 : Packagist | 2073 : Google's Maven Repository | 2076 : crates.io"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/components","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ComponentModel"}},"responseCodes":["201","400","500"],"pointer":"/components","href":"component/createcustomcomponent","openApiOperationId":"createCustomComponent","summary":"Create a custom component"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"components/schemas/ComponentModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ComponentModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created"},{"code":"400","description":"Bad Request"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1components/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/component/createcustomcomponent"}],"panels":[]}]},"httpPath":"/components"},{"label":"Delete a component custom version","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/component/deletecomponentversion","routeSlug":"/swagger/component/deletecomponentversion","metadata":{"seo":{"title":"Delete a component custom version","description":"Delete a custom version using the component ID and version ID. All existing inventory that uses this version will have its version changed to Unknown. You must have the Library Manager permission to delete a custom version."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteComponentVersion","name":"Delete a component custom version","isWebhook":false,"pointer":"/paths/~1components~1{componentId}~1versions~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a component custom version","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a custom version using the component ID and version ID. All existing inventory that uses this version will have its version changed to Unknown. You must have the Library Manager permission to delete a custom version."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"componentId","in":"path","schemaId":"schema_62","description":"ID of the component","required":true,"example":1},{"name":"id","in":"path","schemaId":"schema_58","description":"ID of the component version","required":true,"example":1}],"pointer":"/paths/~1components~1{componentId}~1versions~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/components/{componentId}/versions/{id}","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"componentId","in":"path","required":true,"example":1,"schemaId":"schema_62"},{"name":"id","in":"path","required":true,"example":1,"schemaId":"schema_58"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["201","400","500"],"pointer":"/components/{componentId}/versions/{id}","href":"component/deletecomponentversion","openApiOperationId":"deleteComponentVersion","summary":"Delete a component custom version"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Deleted"},{"code":"400","description":"Bad Request"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1components~1{componentId}~1versions~1{id}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/component/deletecomponentversion"}],"panels":[]}]},"httpPath":"/components/{componentId}/versions/{id}"},{"label":"Delete a custom component","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/component/deletecustomcomponent","routeSlug":"/swagger/component/deletecustomcomponent","metadata":{"seo":{"title":"Delete a custom component","description":"Delete a custom component using the component ID. All existing inventory that uses this component will be changed to work in progress. You must have the Library Manager permission to delete a custom component."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCustomComponent","name":"Delete a custom component","isWebhook":false,"pointer":"/paths/~1components~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a custom component","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a custom component using the component ID. All existing inventory that uses this component will be changed to work in progress. You must have the Library Manager permission to delete a custom component."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_62","description":"ID of the component","required":true,"example":1}],"pointer":"/paths/~1components~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/components/{id}","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":1,"schemaId":"schema_62"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["201","400","500"],"pointer":"/components/{id}","href":"component/deletecustomcomponent","openApiOperationId":"deleteCustomComponent","summary":"Delete a custom component"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Deleted"},{"code":"400","description":"Bad Request"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1components~1{id}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/component/deletecustomcomponent"}],"panels":[]}]},"httpPath":"/components/{id}"},{"label":"Get Component","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/component/getcomponent","routeSlug":"/swagger/component/getcomponent","metadata":{"seo":{"title":"Get Component","description":"Get Component by id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getComponent","name":"Get Component","isWebhook":false,"pointer":"/paths/~1components~1{componentId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Component","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get Component by id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"componentId","in":"path","schemaId":"schema_62","description":"ID of the Component","required":true,"example":1}],"pointer":"/paths/~1components~1{componentId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"includeVersions","in":"query","schemaId":"schema_71","description":"If true, display version details(Default is true)"},{"name":"vulnerabilitySummary","in":"query","schemaId":"schema_59","description":"If true , display vulnerability summary details and hide vulnerability list"},{"name":"cvssVersion","in":"query","schemaId":"schema_72","description":"CVSS Version : This field is required only if vulnerabilitySummary is set to true"}],"pointer":"/paths/~1components~1{componentId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/components/{componentId}","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"componentId","in":"path","required":true,"example":1,"schemaId":"schema_62"}],"query":[{"name":"includeVersions","in":"query","schemaId":"schema_71"},{"name":"vulnerabilitySummary","in":"query","schemaId":"schema_59"},{"name":"cvssVersion","in":"query","schemaId":"schema_72"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404","500"],"pointer":"/components/{componentId}","href":"component/getcomponent","openApiOperationId":"getComponent","summary":"Get Component"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExtendedComponentModel"}},"schemaId":"components/schemas/ExtendedComponentModel"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1components~1{componentId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExtendedComponentModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExtendedComponentModel"}}},{"code":"404"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/component/getcomponent"}],"panels":[]}]},"httpPath":"/components/{componentId}"},{"label":"Get Component version details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/component/getversiondetails","routeSlug":"/swagger/component/getversiondetails","metadata":{"seo":{"title":"Get Component version details","description":"Get Component version details"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getVersionDetails","name":"Get Component version details","isWebhook":false,"pointer":"/paths/~1components~1versions~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Component version details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get Component version details"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_62","description":"ID of the component version","required":true,"example":1}],"pointer":"/paths/~1components~1versions~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/components/versions/{id}","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":1,"schemaId":"schema_62"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/components/versions/{id}","href":"component/getversiondetails","openApiOperationId":"getVersionDetails","summary":"Get Component version details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1components~1versions~1{id}/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/component/getversiondetails"}],"panels":[]}]},"httpPath":"/components/versions/{id}"},{"label":"Get Component version vulnerabilities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/component/getvulnerabilties","routeSlug":"/swagger/component/getvulnerabilties","metadata":{"seo":{"title":"Get Component version vulnerabilities","description":"Get vulnerability details of a component version"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getVulnerabilties","name":"Get Component version vulnerabilities","isWebhook":false,"pointer":"/paths/~1components~1{versionId}~1vulnerabilities/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Component version vulnerabilities","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get vulnerability details of a component version"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"versionId","in":"path","schemaId":"schema_62","description":"ID of the component version","required":true,"example":1}],"pointer":"/paths/~1components~1{versionId}~1vulnerabilities/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_73","description":"Page Size. Number Of Records to fetch per page"},{"name":"offset","in":"query","schemaId":"schema_74","description":"Page Number. Index of the page to start with(starts from 1)"}],"pointer":"/paths/~1components~1{versionId}~1vulnerabilities/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/components/{versionId}/vulnerabilities","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"versionId","in":"path","required":true,"example":1,"schemaId":"schema_62"}],"query":[{"name":"limit","in":"query","schemaId":"schema_73"},{"name":"offset","in":"query","schemaId":"schema_74"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/components/{versionId}/vulnerabilities","href":"component/getvulnerabilties","openApiOperationId":"getVulnerabilties","summary":"Get Component version vulnerabilities"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1components~1{versionId}~1vulnerabilities/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/component/getvulnerabilties"}],"panels":[]}]},"httpPath":"/components/{versionId}/vulnerabilities"},{"label":"Component Lookup","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/component/componentlookup","routeSlug":"/swagger/component/componentlookup","metadata":{"seo":{"title":"Component Lookup","description":"This API is Deprecated and new API is codeinsight/api/components/search"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"componentLookup","name":"Component Lookup","deprecated":true,"isWebhook":false,"pointer":"/paths/~1component~1lookup/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Component Lookup","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This API is Deprecated and new API is codeinsight/api/components/search"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"keyword","in":"query","schemaId":"schema_57","description":"Any Keyword (Example: GNU)","required":true},{"name":"size","in":"query","schemaId":"schema_60","description":"Page Size"},{"name":"page","in":"query","schemaId":"schema_61","description":"Page Number"}],"pointer":"/paths/~1component~1lookup/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/component/lookup","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[{"name":"keyword","in":"query","required":true,"schemaId":"schema_57"},{"name":"size","in":"query","schemaId":"schema_60"},{"name":"page","in":"query","schemaId":"schema_61"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/component/lookup","href":"component/componentlookup","openApiOperationId":"componentLookup","summary":"Component Lookup"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}},"schemaId":"schema_57"},{"code":"400","description":"Bad request"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1component~1lookup/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_57","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}}},{"code":"400"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/component/componentlookup"}],"panels":[]}]},"httpPath":"/component/lookup"}],"content":{"contentType":"group","meta":{"name":"Component"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Component","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/components/search","summary":"Component Search","prefix":{"name":"get","color":"get"},"badges":[],"link":"/component/componentsearch","deprecated":false},{"title":"/components/{componentId}/versions","summary":"Create a component custom version","prefix":{"name":"post","color":"post"},"badges":[],"link":"/component/createcomponentversion","deprecated":false},{"title":"/components","summary":"Create a custom component","prefix":{"name":"post","color":"post"},"badges":[],"link":"/component/createcustomcomponent","deprecated":false},{"title":"/components/{componentId}/versions/{id}","summary":"Delete a component custom version","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/component/deletecomponentversion","deprecated":false},{"title":"/components/{id}","summary":"Delete a custom component","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/component/deletecustomcomponent","deprecated":false},{"title":"/components/{componentId}","summary":"Get Component","prefix":{"name":"get","color":"get"},"badges":[],"link":"/component/getcomponent","deprecated":false},{"title":"/components/versions/{id}","summary":"Get Component version details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/component/getversiondetails","deprecated":false},{"title":"/components/{versionId}/vulnerabilities","summary":"Get Component version vulnerabilities","prefix":{"name":"get","color":"get"},"badges":[],"link":"/component/getvulnerabilties","deprecated":false},{"title":"/component/lookup","summary":"Component Lookup","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/component/componentlookup","deprecated":true}]}]}]}]}},{"type":"group","label":"email","link":"/swagger/email","routeSlug":"/swagger/email","items":[{"label":"Send test vulnerability alert email","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/email/sendtestvulnerabilityalert","routeSlug":"/swagger/email/sendtestvulnerabilityalert","metadata":{"seo":{"title":"Send test vulnerability alert email","description":"Send a test vulnerability alert email to demonstrate notification functionality. Shows how FNCI notifies project owners when new vulnerabilities are discovered. [Development/Testing Only]"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sendTestVulnerabilityAlert","name":"Send test vulnerability alert email","isWebhook":false,"pointer":"/paths/~1email~1test-vulnerability-alert/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send test vulnerability alert email","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send a test vulnerability alert email to demonstrate notification functionality. Shows how FNCI notifies project owners when new vulnerabilities are discovered. [Development/Testing Only]"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/email/test-vulnerability-alert","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","403","500"],"pointer":"/email/test-vulnerability-alert","href":"email/sendtestvulnerabilityalert","openApiOperationId":"sendTestVulnerabilityAlert","summary":"Send test vulnerability alert email"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK : Test vulnerability alert email sent successfully"},{"code":"403","description":"FORBIDDEN : This endpoint is not available in production"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INTERNAL_SERVER_ERROR : Failed to send test email"},"children":[]}]}]}]}],"pointer":"/paths/~1email~1test-vulnerability-alert/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/email/sendtestvulnerabilityalert"}],"panels":[]}]},"httpPath":"/email/test-vulnerability-alert"},{"label":"Update SMTP email password","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/email/updateemailpassword","routeSlug":"/swagger/email/updateemailpassword","metadata":{"seo":{"title":"Update SMTP email password","description":"Update the SMTP email password used for sending notifications. Only system administrators have permission to perform this operation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateEmailPassword","name":"Update SMTP email password","isWebhook":false,"pointer":"/paths/~1email~1password/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update SMTP email password","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update the SMTP email password used for sending notifications. Only system administrators have permission to perform this operation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EmailPasswordUpdateRequest"}},"schemaId":"components/schemas/EmailPasswordUpdateRequest","pointer":"/paths/~1email~1password/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/email/password","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EmailPasswordUpdateRequest"}},"responseCodes":["200","400","403","500","501"],"pointer":"/email/password","href":"email/updateemailpassword","openApiOperationId":"updateEmailPassword","summary":"Update SMTP email password"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"components/schemas/EmailPasswordUpdateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EmailPasswordUpdateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK : Email SMTP password updated successfully"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BAD_REQUEST : Password cannot be null or empty"},"children":[]}]}]}]},{"code":"403","description":"FORBIDDEN : User does not have permission to perform this operation, only system admin can perform this operation. Please check and try again"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INTERNAL_SERVER_ERROR : Failed to update email SMTP password. Please contact your administrator."},"children":[]}]}]}]},{"code":"501","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOT_IMPLEMENTED : Email server is not enabled. Please enable it in Administration settings"},"children":[]}]}]}]}],"pointer":"/paths/~1email~1password/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/email/updateemailpassword"}],"panels":[]}]},"httpPath":"/email/password"}],"content":{"contentType":"group","meta":{"name":"email"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"email","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/email/test-vulnerability-alert","summary":"Send test vulnerability alert email","prefix":{"name":"get","color":"get"},"badges":[],"link":"/email/sendtestvulnerabilityalert","deprecated":false},{"title":"/email/password","summary":"Update SMTP email password","prefix":{"name":"put","color":"put"},"badges":[],"link":"/email/updateemailpassword","deprecated":false}]}]}]}]}},{"type":"group","label":"Files","link":"/swagger/files","routeSlug":"/swagger/files","items":[{"label":"Get details of a file by Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/files/getfiledetails","routeSlug":"/swagger/files/getfiledetails","metadata":{"seo":{"title":"Get details of a file by Id","description":"Get file details of a given fileId. If the remote flag is true, it'll fetch the corresponding remote file info, otherwise by default the flag is false and scanner file information will be shown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFileDetails","name":"Get details of a file by Id","isWebhook":false,"pointer":"/paths/~1files~1{fileId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get details of a file by Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get file details of a given fileId. If the remote flag is true, it'll fetch the corresponding remote file info, otherwise by default the flag is false and scanner file information will be shown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"fileId","in":"path","schemaId":"schema_58","description":"ID of the File","required":true,"example":1}],"pointer":"/paths/~1files~1{fileId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"isRemote","in":"query","schemaId":"schema_59","description":"if true, fetch results of corresponding remote file"}],"pointer":"/paths/~1files~1{fileId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/files/{fileId}","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"fileId","in":"path","required":true,"example":1,"schemaId":"schema_58"}],"query":[{"name":"isRemote","in":"query","schemaId":"schema_59"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/files/{fileId}","href":"files/getfiledetails","openApiOperationId":"getFileDetails","summary":"Get details of a file by Id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1files~1{fileId}/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/files/getfiledetails"}],"panels":[]}]},"httpPath":"/files/{fileId}"},{"label":"Mark file reviewed/unreviewed","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/files/updatefilereview","routeSlug":"/swagger/files/updatefilereview","metadata":{"seo":{"title":"Mark file reviewed/unreviewed","description":"For the given fileId mark as reviewed/unreviewed. Only the Analyst has the permission to do this operation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateFileReview","name":"Mark file reviewed/unreviewed","isWebhook":false,"pointer":"/paths/~1files~1{fileId}~1review/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Mark file reviewed/unreviewed","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"For the given fileId mark as reviewed/unreviewed. Only the Analyst has the permission to do this operation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"fileId","in":"path","schemaId":"schema_58","description":"ID of the File","required":true,"example":1}],"pointer":"/paths/~1files~1{fileId}~1review/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"isRemote","in":"query","schemaId":"schema_59","description":"if true, fetch results of corresponding remote file"},{"name":"markAsReviewed","in":"query","schemaId":"schema_59","description":"if true, mark file as reviewed"}],"pointer":"/paths/~1files~1{fileId}~1review/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/files/{fileId}/review","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"fileId","in":"path","required":true,"example":1,"schemaId":"schema_58"}],"query":[{"name":"isRemote","in":"query","schemaId":"schema_59"},{"name":"markAsReviewed","in":"query","schemaId":"schema_59"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/files/{fileId}/review","href":"files/updatefilereview","openApiOperationId":"updateFileReview","summary":"Mark file reviewed/unreviewed"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1files~1{fileId}~1review/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/files/updatefilereview"}],"panels":[]}]},"httpPath":"/files/{fileId}/review"}],"content":{"contentType":"group","meta":{"name":"Files"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Files","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/files/{fileId}","summary":"Get details of a file by Id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/files/getfiledetails","deprecated":false},{"title":"/files/{fileId}/review","summary":"Mark file reviewed/unreviewed","prefix":{"name":"put","color":"put"},"badges":[],"link":"/files/updatefilereview","deprecated":false}]}]}]}]}},{"type":"group","label":"Folder","link":"/swagger/folder","routeSlug":"/swagger/folder","items":[{"label":"Create Folder","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/folder/createfolder","routeSlug":"/swagger/folder/createfolder","metadata":{"seo":{"title":"Create Folder","description":"Creates a folder for the given name and returns folderId with success message."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createFolder","name":"Create Folder","isWebhook":false,"pointer":"/paths/~1folders/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Folder","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a folder for the given name and returns folderId with success message."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FolderModel"}},"schemaId":"components/schemas/FolderModel","pointer":"/paths/~1folders/post/requestBody","description":"To create a folder, folderName is required and parentFolderId is optional. "}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/folders","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/FolderModel"}},"responseCodes":["201","400","401","500"],"pointer":"/folders","href":"folder/createfolder","openApiOperationId":"createFolder","summary":"Create Folder"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"components/schemas/FolderModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FolderModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1folders/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/folder/createfolder"}],"panels":[]}]},"httpPath":"/folders"},{"label":"Get Folder By Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/folder/getfolder","routeSlug":"/swagger/folder/getfolder","metadata":{"seo":{"title":"Get Folder By Id","description":"Get existing folder by folderId"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFolder","name":"Get Folder By Id","isWebhook":false,"pointer":"/paths/~1folders~1{folderId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Folder By Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get existing folder by folderId"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"folderId","in":"path","schemaId":"schema_75","required":true}],"pointer":"/paths/~1folders~1{folderId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/folders/{folderId}","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"folderId","in":"path","required":true,"schemaId":"schema_75"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/folders/{folderId}","href":"folder/getfolder","openApiOperationId":"getFolder","summary":"Get Folder By Id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1folders~1{folderId}/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/folder/getfolder"}],"panels":[]}]},"httpPath":"/folders/{folderId}"},{"label":"Update folder details","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/folder/updatefolder","routeSlug":"/swagger/folder/updatefolder","metadata":{"seo":{"title":"Update folder details","description":"Update folder details for the given folderId."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateFolder","name":"Update folder details","isWebhook":false,"pointer":"/paths/~1folders~1{folderId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update folder details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update folder details for the given folderId."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"folderId","in":"path","schemaId":"schema_75","required":true}],"pointer":"/paths/~1folders~1{folderId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FolderModel"}},"schemaId":"components/schemas/FolderModel","pointer":"/paths/~1folders~1{folderId}/put/requestBody","description":"Update details of a folder."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/folders/{folderId}","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"folderId","in":"path","required":true,"schemaId":"schema_75"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/FolderModel"}},"responseCodes":["200","400","401","404","500"],"pointer":"/folders/{folderId}","href":"folder/updatefolder","openApiOperationId":"updateFolder","summary":"Update folder details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"components/schemas/FolderModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FolderModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1folders~1{folderId}/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/folder/updatefolder"}],"panels":[]}]},"httpPath":"/folders/{folderId}"},{"label":"Delete a folder","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/folder/deletefolder","routeSlug":"/swagger/folder/deletefolder","metadata":{"seo":{"title":"Delete a folder","description":"Deleting a folder will delete all subfolders, contained projects will be associated wih the parent folder(Projects(0))."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteFolder","name":"Delete a folder","isWebhook":false,"pointer":"/paths/~1folders~1{folderId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a folder","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deleting a folder will delete all subfolders, contained projects will be associated wih the parent folder(Projects(0))."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"folderId","in":"path","schemaId":"schema_58","description":"ID of the folder","required":true,"example":1}],"pointer":"/paths/~1folders~1{folderId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/folders/{folderId}","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"folderId","in":"path","required":true,"example":1,"schemaId":"schema_58"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/folders/{folderId}","href":"folder/deletefolder","openApiOperationId":"deleteFolder","summary":"Delete a folder"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1folders~1{folderId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/folder/deletefolder"}],"panels":[]}]},"httpPath":"/folders/{folderId}"},{"label":"Get folders based on the name provided","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/folder/searchfolders","routeSlug":"/swagger/folder/searchfolders","metadata":{"seo":{"title":"Get folders based on the name provided","description":"Return folders based on the name provided"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchFolders","name":"Get folders based on the name provided","isWebhook":false,"pointer":"/paths/~1folders~1search/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get folders based on the name provided","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Return folders based on the name provided"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"folderName","in":"query","schemaId":"schema_57","description":"Search happens based on the name given "},{"name":"offset","in":"query","schemaId":"schema_76","description":"Index of the page to start with"},{"name":"limit","in":"query","schemaId":"schema_77","description":"Number of records to fetch"}],"pointer":"/paths/~1folders~1search/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/folders/search","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[{"name":"folderName","in":"query","schemaId":"schema_57"},{"name":"offset","in":"query","schemaId":"schema_76"},{"name":"limit","in":"query","schemaId":"schema_77"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/folders/search","href":"folder/searchfolders","openApiOperationId":"searchFolders","summary":"Get folders based on the name provided"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1folders~1search/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/folder/searchfolders"}],"panels":[]}]},"httpPath":"/folders/search"}],"content":{"contentType":"group","meta":{"name":"Folder"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Folder","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/folders","summary":"Create Folder","prefix":{"name":"post","color":"post"},"badges":[],"link":"/folder/createfolder","deprecated":false},{"title":"/folders/{folderId}","summary":"Get Folder By Id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/folder/getfolder","deprecated":false},{"title":"/folders/{folderId}","summary":"Update folder details","prefix":{"name":"put","color":"put"},"badges":[],"link":"/folder/updatefolder","deprecated":false},{"title":"/folders/{folderId}","summary":"Delete a folder","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/folder/deletefolder","deprecated":false},{"title":"/folders/search","summary":"Get folders based on the name provided","prefix":{"name":"get","color":"get"},"badges":[],"link":"/folder/searchfolders","deprecated":false}]}]}]}]}},{"type":"group","label":"Project API","link":"/swagger/project-api","routeSlug":"/swagger/project-api","items":[{"label":"Get Project Inventories Delta from latest scan","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/project-api/getmodifiedprojectinventorybyproject","routeSlug":"/swagger/project-api/getmodifiedprojectinventorybyproject","metadata":{"seo":{"title":"Get Project Inventories Delta from latest scan","description":"Returns a Delta list of inventory after latest scan and relevant details for a given project. All project users including Observer, Reviewer and Analyst can view project inventory of private/public projects."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getModifiedProjectInventoryByProject","name":"Get Project Inventories Delta from latest scan","isWebhook":false,"pointer":"/paths/~1project~1inventoryDeltaFromLastScan~1{projectId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Project Inventories Delta from latest scan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a Delta list of inventory after latest scan and relevant details for a given project. All project users including Observer, Reviewer and Analyst can view project inventory of private/public projects."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_62","description":"ID of the Project","required":true,"example":1}],"pointer":"/paths/~1project~1inventoryDeltaFromLastScan~1{projectId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"inventoryUpdatedType","in":"query","schemaId":"schema_78","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required param for inventoryUpdatedType: All | New Inventories | Updated Inventories | Removed Inventories"},"children":[]}]}]}]},{"name":"size","in":"query","schemaId":"schema_60","description":"Page Size. Number Of Records to fetch per page"},{"name":"page","in":"query","schemaId":"schema_61","description":"Page Number. Index of the page to start with(starts from 1)"}],"pointer":"/paths/~1project~1inventoryDeltaFromLastScan~1{projectId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/project/inventoryDeltaFromLastScan/{projectId}","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":1,"schemaId":"schema_62"}],"query":[{"name":"inventoryUpdatedType","in":"query","schemaId":"schema_78"},{"name":"size","in":"query","schemaId":"schema_60"},{"name":"page","in":"query","schemaId":"schema_61"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/project/inventoryDeltaFromLastScan/{projectId}","href":"project-api/getmodifiedprojectinventorybyproject","openApiOperationId":"getModifiedProjectInventoryByProject","summary":"Get Project Inventories Delta from latest scan"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad request: The project Id entered was not found"}],"pointer":"/paths/~1project~1inventoryDeltaFromLastScan~1{projectId}/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project-api/getmodifiedprojectinventorybyproject"}],"panels":[]}]},"httpPath":"/project/inventoryDeltaFromLastScan/{projectId}"},{"label":"Get Project Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/project-api/getprojectid","routeSlug":"/swagger/project-api/getprojectid","metadata":{"seo":{"title":"Get Project Id","description":"Returns projectId for a given projectName."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProjectId","name":"Get Project Id","isWebhook":false,"pointer":"/paths/~1project~1id/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Project Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns projectId for a given projectName."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"projectName","in":"query","schemaId":"schema_57","description":"Name of the Project (Example: eportal)","required":true}],"pointer":"/paths/~1project~1id/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/project/id","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[{"name":"projectName","in":"query","required":true,"schemaId":"schema_57"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/project/id","href":"project-api/getprojectid","openApiOperationId":"getProjectId","summary":"Get Project Id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_64"}},"schemaId":"schema_64"},{"code":"400","description":"Bad request: The project name entered was not found"}],"pointer":"/paths/~1project~1id/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_64","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_64"}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project-api/getprojectid"}],"panels":[]}]},"httpPath":"/project/id"},{"label":"Get Project Inventory","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/project-api/getprojectinventory","routeSlug":"/swagger/project-api/getprojectinventory","metadata":{"seo":{"title":"Get Project Inventory","description":"Returns a list of inventory and inventory details for a given project; includes a flag for a short/long version. All project users including Observer, Reviewer and Analyst can view project inventory of private projects."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProjectInventory","name":"Get Project Inventory","isWebhook":false,"pointer":"/paths/~1project~1inventory~1{projectId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Project Inventory","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of inventory and inventory details for a given project; includes a flag for a short/long version. All project users including Observer, Reviewer and Analyst can view project inventory of private projects."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_62","description":"ID of the Project","required":true,"example":1}],"pointer":"/paths/~1project~1inventory~1{projectId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"skipVulnerabilities","in":"query","schemaId":"schema_59","description":"If true , hide vulnerability details in the response"},{"name":"published","in":"query","schemaId":"schema_71","description":"If true, then only published inventory items are returned; if false, then only not-published inventory items are returned;; if all, then all inventory items are returned"},{"name":"vendor","in":"query","schemaId":"schema_57","description":"CPE Vendor name (Example: gnu)"},{"name":"product","in":"query","schemaId":"schema_57","description":"CPE Product name (Example: zlib)"},{"name":"size","in":"query","schemaId":"schema_60","description":"Page Size. Number Of Records to fetch per page"},{"name":"page","in":"query","schemaId":"schema_61","description":"Page Number. Index of the page to start with(starts from 1)"},{"name":"reviewStatus","in":"query","schemaId":"schema_79","description":"return items based on the reviewStatus which we selected. Ex: if reviewStatus is APPROVED then only APPROVED items returned"},{"name":"alerts","in":"query","schemaId":"schema_80","description":"return items based the alert status selected. If alert status selected as OPEN then only open alerts returned"},{"name":"includeFiles","in":"query","schemaId":"schema_71","description":"If true, display the associated files to an Inventory(Default is true)"},{"name":"includeCopyrights","in":"query","schemaId":"schema_59","description":"If true, display the copyrights of an Inventory(Default is false)"}],"pointer":"/paths/~1project~1inventory~1{projectId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/project/inventory/{projectId}","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":1,"schemaId":"schema_62"}],"query":[{"name":"skipVulnerabilities","in":"query","schemaId":"schema_59"},{"name":"published","in":"query","schemaId":"schema_71"},{"name":"vendor","in":"query","schemaId":"schema_57"},{"name":"product","in":"query","schemaId":"schema_57"},{"name":"size","in":"query","schemaId":"schema_60"},{"name":"page","in":"query","schemaId":"schema_61"},{"name":"reviewStatus","in":"query","schemaId":"schema_79"},{"name":"alerts","in":"query","schemaId":"schema_80"},{"name":"includeFiles","in":"query","schemaId":"schema_71"},{"name":"includeCopyrights","in":"query","schemaId":"schema_59"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/project/inventory/{projectId}","href":"project-api/getprojectinventory","openApiOperationId":"getProjectInventory","summary":"Get Project Inventory"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InventoryGroup"}},"schemaId":"components/schemas/InventoryGroup"},{"code":"400","description":"Bad request: The project Id entered was not found"}],"pointer":"/paths/~1project~1inventory~1{projectId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/InventoryGroup","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InventoryGroup"}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project-api/getprojectinventory"}],"panels":[]}]},"httpPath":"/project/inventory/{projectId}"},{"label":"Get Project Inventory by Date","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/project-api/getprojectinventorybydate","routeSlug":"/swagger/project-api/getprojectinventorybydate","metadata":{"seo":{"title":"Get Project Inventory by Date","description":"Returns a list of inventory and relevant details for a given project within the given date and time. All project users including Observer, Reviewer and Analyst can view project inventory of private/public projects."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProjectInventoryByDate","name":"Get Project Inventory by Date","isWebhook":false,"pointer":"/paths/~1project~1inventoryLite~1{projectId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Project Inventory by Date","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of inventory and relevant details for a given project within the given date and time. All project users including Observer, Reviewer and Analyst can view project inventory of private/public projects."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_62","description":"ID of the Project","required":true,"example":1}],"pointer":"/paths/~1project~1inventoryLite~1{projectId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"startTime","in":"query","schemaId":"schema_57","description":"Start time for an inventory (Format: YYYY-MM-DD HH:MM:SS)"},{"name":"endTime","in":"query","schemaId":"schema_57","description":"End time for an inventory (Format: YYYY-MM-DD HH:MM:SS)"},{"name":"size","in":"query","schemaId":"schema_60","description":"Page Size. Number Of Records to fetch per page"},{"name":"page","in":"query","schemaId":"schema_61","description":"Page Number. Index of the page to start with(starts from 1)"}],"pointer":"/paths/~1project~1inventoryLite~1{projectId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/project/inventoryLite/{projectId}","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":1,"schemaId":"schema_62"}],"query":[{"name":"startTime","in":"query","schemaId":"schema_57"},{"name":"endTime","in":"query","schemaId":"schema_57"},{"name":"size","in":"query","schemaId":"schema_60"},{"name":"page","in":"query","schemaId":"schema_61"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/project/inventoryLite/{projectId}","href":"project-api/getprojectinventorybydate","openApiOperationId":"getProjectInventoryByDate","summary":"Get Project Inventory by Date"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad request: The project Id entered was not found"}],"pointer":"/paths/~1project~1inventoryLite~1{projectId}/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project-api/getprojectinventorybydate"}],"panels":[]}]},"httpPath":"/project/inventoryLite/{projectId}"},{"label":"Get Scan Status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/project-api/getprojectscanstatus","routeSlug":"/swagger/project-api/getprojectscanstatus","metadata":{"seo":{"title":"Get Scan Status","description":"Returns a scan status for a given taskId which is obtained from /projectScan/{projectId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProjectScanStatus","name":"Get Scan Status","isWebhook":false,"pointer":"/paths/~1project~1scanStatus~1{taskId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Scan Status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a scan status for a given taskId which is obtained from /projectScan/{projectId}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"taskId","in":"path","schemaId":"schema_62","description":"ID of the project scan task","required":true,"example":1}],"pointer":"/paths/~1project~1scanStatus~1{taskId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/project/scanStatus/{taskId}","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"taskId","in":"path","required":true,"example":1,"schemaId":"schema_62"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/project/scanStatus/{taskId}","href":"project-api/getprojectscanstatus","openApiOperationId":"getProjectScanStatus","summary":"Get Scan Status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCHEDULED | ACTIVE | TERMINATED | FAILED | COMPLETED"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_81"}},"schemaId":"schema_81"},{"code":"400","description":"Bad request: The task Id entered was not found"}],"pointer":"/paths/~1project~1scanStatus~1{taskId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_81","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_81"}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project-api/getprojectscanstatus"}],"panels":[]}]},"httpPath":"/project/scanStatus/{taskId}"},{"label":"Upload Project Files.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/project-api/uploadproject","routeSlug":"/swagger/project-api/uploadproject","metadata":{"seo":{"title":"Upload Project Files.","description":"Uploads and extracts a codebase zip file for a project. (* Maximum supported file size is 10GB.). Upload only files with extensions zip,tar,tar.gz and 7z. Do not upload any .gz files directly without archiving it in a tar file. The upload result may come wrong if any compressed files uploaded directly without archiving it. Only Project Admin and Analyst can upload project codebase to a project.Try it out is not available for this API. This API can be tested using conventional REST API clients such as postman or cURL.When calling this API from a REST client, you need to run curl as follows"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadProject","name":"Upload Project Files.","isWebhook":false,"pointer":"/paths/~1project~1uploadProjectCodebase/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload Project Files.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Uploads and extracts a codebase zip file for a project. (* Maximum supported file size is 10GB.). Upload only files with extensions zip,tar,tar.gz and 7z. Do not upload any .gz files directly without archiving it in a tar file. The upload result may come wrong if any compressed files uploaded directly without archiving it. Only Project Admin and Analyst can upload project codebase to a project."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Try it out is not available for this API. This API can be tested using conventional REST API clients such as postman or cURL."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When calling this API from a REST client, you need to run curl as follows"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -X POST \"http://HOST:PORT/codeinsight/api/project/uploadProjectCodebase?projectId=PROJECT_ID&deleteExistingFileOnServer=true&expansionLevel=1\" -H \"accept: application/json\" -H \"Authorization: Bearer JWT_TOKEN\" -H \"content-type: application/octet-stream\" --data-binary \"@path/filename.zip\"\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -X POST \"http://HOST:PORT/codeinsight/api/project/uploadProjectCodebase?projectId=PROJECT_ID&deleteExistingFileOnServer=true&expansionLevel=1\" -H \"accept: application/json\" -H \"Authorization: Bearer JWT_TOKEN\" -H \"content-type: application/octet-stream\" --data-binary \"@path/filename.zip\"\n"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"projectId","in":"query","schemaId":"schema_62","description":"ID of the Project","required":true,"example":1},{"name":"deleteExistingFileOnServer","in":"query","schemaId":"schema_59","description":"Delete existing files on server. By deleting exiting files on the server, all existing project codebase files will be permanently removed from the scan server. If you rescan the project without replacing these files via a new upload, the scan results for the removed files will be permanently deleted."},{"name":"expansionLevel","in":"query","schemaId":"schema_62","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Codebase expansion level for the project. 1: None | 2: First level | 3: Recursive level . If the expansionLevel parameter is not provided, the codebase will get extracted as 'None' by default."},"children":[]}]}]}]},{"name":"deleteArchiveAfterExpand","in":"query","schemaId":"schema_59","description":"Delete inner archives after expansion"},{"name":"archiveDirSuffix","in":"query","schemaId":"schema_57","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Suffix to be added to the expanded folder. Value cannot be more than 20 characters and cannot contain the following special characters  \\ / : * ? \" < > | \\0 (Example: _Expanded)"},"children":[]}]}]}]}],"pointer":"/paths/~1project~1uploadProjectCodebase/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/octet-stream"],"mediaTypeSchemas":{"application/octet-stream":{"schemaId":"schema_82"}},"schemaId":"schema_82","pointer":"/paths/~1project~1uploadProjectCodebase/post/requestBody","description":"Zipped codebase to scan"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/project/uploadProjectCodebase","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[{"name":"projectId","in":"query","required":true,"example":1,"schemaId":"schema_62"},{"name":"deleteExistingFileOnServer","in":"query","schemaId":"schema_59"},{"name":"expansionLevel","in":"query","schemaId":"schema_62"},{"name":"deleteArchiveAfterExpand","in":"query","schemaId":"schema_59"},{"name":"archiveDirSuffix","in":"query","schemaId":"schema_57"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/octet-stream":{"schemaId":"schema_82"}},"responseCodes":["200","400","500","503"],"pointer":"/project/uploadProjectCodebase","href":"project-api/uploadproject","openApiOperationId":"uploadProject","summary":"Upload Project Files."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"schema_82","mediaTypes":["application/octet-stream"],"mediaTypeSchemas":{"application/octet-stream":{"schemaId":"schema_82"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"500","description":"Internal Server Error"},{"code":"503","description":"Service Unavailable"}],"pointer":"/paths/~1project~1uploadProjectCodebase/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project-api/uploadproject"}],"panels":[]}]},"httpPath":"/project/uploadProjectCodebase"},{"label":"Export Project Data","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/project-api/exportprojectdata","routeSlug":"/swagger/project-api/exportprojectdata","metadata":{"seo":{"title":"Export Project Data","description":"Exports project data for a given projectId. Only Project Admin and Analyst can Export Project Data from a project.Try it out is not available for this API. This API can be tested using conventional REST API clients such as postman or cURL.When calling this API from a REST client, you need to redirect output to a zip file as follows"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"exportProjectData","name":"Export Project Data","isWebhook":false,"pointer":"/paths/~1project~1exportProjectData/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Export Project Data","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exports project data for a given projectId. Only Project Admin and Analyst can Export Project Data from a project."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Try it out is not available for this API. This API can be tested using conventional REST API clients such as postman or cURL."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When calling this API from a REST client, you need to redirect output to a zip file as follows"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -X GET \"http://HOST:PORT/codeinsight/api/project/exportProjectData?projectId=PROJECT_ID\" -H \"accept: application/octet-stream\" -H \"Authorization: Bearer JWT_TOKEN\" > export.zip\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -X GET \"http://HOST:PORT/codeinsight/api/project/exportProjectData?projectId=PROJECT_ID\" -H \"accept: application/octet-stream\" -H \"Authorization: Bearer JWT_TOKEN\" > export.zip\n"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"projectId","in":"query","schemaId":"schema_62","description":"ID of the Project","required":true,"example":1}],"pointer":"/paths/~1project~1exportProjectData/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/project/exportProjectData","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[{"name":"projectId","in":"query","required":true,"example":1,"schemaId":"schema_62"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/project/exportProjectData","href":"project-api/exportprojectdata","openApiOperationId":"exportProjectData","summary":"Export Project Data"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/octet-stream","mediaTypes":["application/octet-stream"],"mediaTypeContent":{"application/octet-stream":{}}},{"code":"400","description":"Bad request: No project named x"}],"pointer":"/paths/~1project~1exportProjectData/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project-api/exportprojectdata"}],"panels":[]}]},"httpPath":"/project/exportProjectData"},{"label":"Download Report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/project-api/downloadreport","routeSlug":"/swagger/project-api/downloadreport","metadata":{"seo":{"title":"Download Report","description":"Download Reports (PROJECT, AUDIT, NOTICES, CUSTOM_REPORT) for a given projectId. For ALL Reports we need to provide the id of the report. All project users including Observer, Reviewer and Analyst can download reports for private projects.If a task is in progress the response will be 202 and the status will be provided in the header for e.g(ACTIVE, SCHEDULED).Try it out is not available for this API. This API can be tested using conventional REST API clients such as postman or cURL.When calling this API from a REST client, you need to redirect output to a zip file as follows"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadReport","name":"Download Report","isWebhook":false,"pointer":"/paths/~1projects~1{projectId}~1reports~1{reportId}~1download/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download Report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Download Reports (PROJECT, AUDIT, NOTICES, CUSTOM_REPORT) for a given projectId. For ALL Reports we need to provide the id of the report. All project users including Observer, Reviewer and Analyst can download reports for private projects."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a task is in progress the response will be 202 and the status will be provided in the header for e.g(ACTIVE, SCHEDULED)."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Try it out is not available for this API. This API can be tested using conventional REST API clients such as postman or cURL."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When calling this API from a REST client, you need to redirect output to a zip file as follows"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -X GET \"http://HOST:PORT/codeinsight/api/projects/{projectId}/reports/{reportId}/download?taskId={taskId}\" -H \"accept: application/octet-stream\" -H \"Authorization: Bearer JWT_TOKEN\" > report.zip\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -X GET \"http://HOST:PORT/codeinsight/api/projects/{projectId}/reports/{reportId}/download?taskId={taskId}\" -H \"accept: application/octet-stream\" -H \"Authorization: Bearer JWT_TOKEN\" > report.zip\n"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_63","description":"ID of the Project","required":true,"example":1},{"name":"reportId","in":"path","schemaId":"schema_63","description":"ID of the Report that is to be generated or downloaded","required":true,"example":1}],"pointer":"/paths/~1projects~1{projectId}~1reports~1{reportId}~1download/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"taskId","in":"query","schemaId":"schema_63","description":"ID of the Report Task that is to be downloaded","required":true,"example":1}],"pointer":"/paths/~1projects~1{projectId}~1reports~1{reportId}~1download/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/projects/{projectId}/reports/{reportId}/download","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":1,"schemaId":"schema_63"},{"name":"reportId","in":"path","required":true,"example":1,"schemaId":"schema_63"}],"query":[{"name":"taskId","in":"query","required":true,"example":1,"schemaId":"schema_63"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","202","400","401","404","500"],"pointer":"/projects/{projectId}/reports/{reportId}/download","href":"project-api/downloadreport","openApiOperationId":"downloadReport","summary":"Download Report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/octet-stream","mediaTypes":["application/octet-stream"],"mediaTypeContent":{"application/octet-stream":{}}},{"code":"202","description":"Accepted"},{"code":"400","description":"Bad request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1projects~1{projectId}~1reports~1{reportId}~1download/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project-api/downloadreport"}],"panels":[]}]},"httpPath":"/projects/{projectId}/reports/{reportId}/download"},{"label":"Generate Report","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/project-api/generatereport_1","routeSlug":"/swagger/project-api/generatereport_1","metadata":{"seo":{"title":"Generate Report","description":"Generates Reports (PROJECT, AUDIT, NOTICES, CUSTOM_REPORT) for a given projectId. For ALL Reports we need to provide the id of the report. All project users including Observer, Reviewer and Analyst can generate reports for private projects."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"generateReport_1","name":"Generate Report","isWebhook":false,"pointer":"/paths/~1projects~1{projectId}~1reports~1{reportId}~1generate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate Report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generates Reports (PROJECT, AUDIT, NOTICES, CUSTOM_REPORT) for a given projectId. For ALL Reports we need to provide the id of the report. All project users including Observer, Reviewer and Analyst can generate reports for private projects."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_63","description":"ID of the Project","required":true,"example":1},{"name":"reportId","in":"path","schemaId":"schema_63","description":"ID of the Report that is to be generated","required":true,"example":1}],"pointer":"/paths/~1projects~1{projectId}~1reports~1{reportId}~1generate/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReportsModel"}},"schemaId":"components/schemas/ReportsModel","pointer":"/paths/~1projects~1{projectId}~1reports~1{reportId}~1generate/post/requestBody","description":"The success response of the generate is a taskId which should be used during download. If the report type is custom report and enableProjectPicker is true otherProjectId is required."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/projects/{projectId}/reports/{reportId}/generate","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":1,"schemaId":"schema_63"},{"name":"reportId","in":"path","required":true,"example":1,"schemaId":"schema_63"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ReportsModel"}},"responseCodes":["200","400","401","404","500","503"],"pointer":"/projects/{projectId}/reports/{reportId}/generate","href":"project-api/generatereport_1","openApiOperationId":"generateReport_1","summary":"Generate Report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"components/schemas/ReportsModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReportsModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"},{"code":"503","description":"Service Unavailable"}],"pointer":"/paths/~1projects~1{projectId}~1reports~1{reportId}~1generate/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project-api/generatereport_1"}],"panels":[]}]},"httpPath":"/projects/{projectId}/reports/{reportId}/generate"},{"label":"Add child projects to parent project","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/project-api/addchildprojects","routeSlug":"/swagger/project-api/addchildprojects","metadata":{"seo":{"title":"Add child projects to parent project","description":"Add child projects to parent project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addChildProjects","name":"Add child projects to parent project","isWebhook":false,"pointer":"/paths/~1projects~1{projectId}~1children/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add child projects to parent project","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Add child projects to parent project."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_58","description":"Id of Parent Project","required":true,"example":1}],"pointer":"/paths/~1projects~1{projectId}~1children/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"childProjectIds","in":"query","schemaId":"schema_83","description":"Id of Child Projects","required":true}],"pointer":"/paths/~1projects~1{projectId}~1children/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/projects/{projectId}/children","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":1,"schemaId":"schema_58"}],"query":[{"name":"childProjectIds","in":"query","required":true,"schemaId":"schema_83"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/projects/{projectId}/children","href":"project-api/addchildprojects","openApiOperationId":"addChildProjects","summary":"Add child projects to parent project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1projects~1{projectId}~1children/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project-api/addchildprojects"}],"panels":[]}]},"httpPath":"/projects/{projectId}/children"},{"label":"Remove child Projects from parent project","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/project-api/removechildprojects","routeSlug":"/swagger/project-api/removechildprojects","metadata":{"seo":{"title":"Remove child Projects from parent project","description":"Remove child project from parent project"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"removeChildProjects","name":"Remove child Projects from parent project","isWebhook":false,"pointer":"/paths/~1projects~1{projectId}~1children/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove child Projects from parent project","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Remove child project from parent project"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_63","description":"Id of Parent Project","required":true,"example":1}],"pointer":"/paths/~1projects~1{projectId}~1children/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"childProjectIds","in":"query","schemaId":"schema_83","description":"Id of Child Projects","required":true}],"pointer":"/paths/~1projects~1{projectId}~1children/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/projects/{projectId}/children","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":1,"schemaId":"schema_63"}],"query":[{"name":"childProjectIds","in":"query","required":true,"schemaId":"schema_83"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/projects/{projectId}/children","href":"project-api/removechildprojects","openApiOperationId":"removeChildProjects","summary":"Remove child Projects from parent project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1projects~1{projectId}~1children/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project-api/removechildprojects"}],"panels":[]}]},"httpPath":"/projects/{projectId}/children"},{"label":"Archive a project","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/project-api/archiveproject","routeSlug":"/swagger/project-api/archiveproject","metadata":{"seo":{"title":"Archive a project","description":"Archives a project. Archive is IRREVOCABLE. The operation runs asynchronously: it deletes codebase files and Lucene indexes from the scanner filesystem, then atomically changes the project status to Archived. All inventory, evidence, scan history, reports, and exports are preserved in the database. Archived projects become fully read-only all modification APIs are blocked except DELETE. Only Project Administrators can archive projects. Pre-conditions: no active scans, copies, imports, exports or branching jobs on the project or its children."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"archiveProject","name":"Archive a project","isWebhook":false,"pointer":"/paths/~1projects~1{projectId}~1archive/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Archive a project","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Archives a project. Archive is IRREVOCABLE. The operation runs asynchronously: it deletes codebase files and Lucene indexes from the scanner filesystem, then atomically changes the project status to Archived. All inventory, evidence, scan history, reports, and exports are preserved in the database. Archived projects become fully read-only all modification APIs are blocked except DELETE. Only Project Administrators can archive projects. Pre-conditions: no active scans, copies, imports, exports or branching jobs on the project or its children."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_58","description":"ID of the project to archive","required":true,"example":1}],"pointer":"/paths/~1projects~1{projectId}~1archive/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"archiveChildProjects","in":"query","schemaId":"schema_59","description":"If true, all first-level child projects will also be archived (FR-18)"},{"name":"comments","in":"query","schemaId":"schema_57","description":"Mandatory reason/comments for archiving. Also displayed in the audit trail (FR-15, FR-16).","required":true}],"pointer":"/paths/~1projects~1{projectId}~1archive/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/projects/{projectId}/archive","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":1,"schemaId":"schema_58"}],"query":[{"name":"archiveChildProjects","in":"query","schemaId":"schema_59"},{"name":"comments","in":"query","required":true,"schemaId":"schema_57"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["202","400","401","404","500"],"pointer":"/projects/{projectId}/archive","href":"project-api/archiveproject","openApiOperationId":"archiveProject","summary":"Archive a project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted - archive task has been scheduled"},{"code":"400","description":"Bad Request - project already archived or active jobs running"},{"code":"401","description":"Unauthorized - only Project Administrators can archive"},{"code":"404","description":"Project Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1projects~1{projectId}~1archive/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project-api/archiveproject"}],"panels":[]}]},"httpPath":"/projects/{projectId}/archive"},{"label":"Users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/project-api/getprojectuserrole","routeSlug":"/swagger/project-api/getprojectuserrole","metadata":{"seo":{"title":"Users","description":"Get Project Users with respect to Role"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProjectUserRole","name":"Users","isWebhook":false,"pointer":"/paths/~1projects~1{projectId}~1users/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Users","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get Project Users with respect to Role"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_58","description":"ID of the Project","required":true,"example":1}],"pointer":"/paths/~1projects~1{projectId}~1users/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"roleId","in":"query","schemaId":"schema_84","required":true}],"pointer":"/paths/~1projects~1{projectId}~1users/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/projects/{projectId}/users","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":1,"schemaId":"schema_58"}],"query":[{"name":"roleId","in":"query","required":true,"schemaId":"schema_84"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/projects/{projectId}/users","href":"project-api/getprojectuserrole","openApiOperationId":"getProjectUserRole","summary":"Users"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1projects~1{projectId}~1users/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project-api/getprojectuserrole"}],"panels":[]}]},"httpPath":"/projects/{projectId}/users"},{"label":"Assign Role","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/project-api/assignprojectrole","routeSlug":"/swagger/project-api/assignprojectrole","metadata":{"seo":{"title":"Assign Role","description":"Assign a Users to a specific Project Role.Here \"ownerId refers to the \"contactId of the project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"assignProjectRole","name":"Assign Role","isWebhook":false,"pointer":"/paths/~1projects~1{projectId}~1users/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Assign Role","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Assign a Users to a specific Project Role."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Here \"ownerId refers to the \"contactId of the project."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_58","description":"ID of the Project","required":true,"example":1}],"pointer":"/paths/~1projects~1{projectId}~1users/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProjectRoleModel"}},"schemaId":"components/schemas/ProjectRoleModel","pointer":"/paths/~1projects~1{projectId}~1users/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add a Users to a specific Project Role. Accepted RoleId: PROJECT_ADMIN, ANALYST, REVIEWER, OBSERVER"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/projects/{projectId}/users","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":1,"schemaId":"schema_58"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ProjectRoleModel"}},"responseCodes":["200","400","401","404","500"],"pointer":"/projects/{projectId}/users","href":"project-api/assignprojectrole","openApiOperationId":"assignProjectRole","summary":"Assign Role"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"components/schemas/ProjectRoleModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProjectRoleModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1projects~1{projectId}~1users/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project-api/assignprojectrole"}],"panels":[]}]},"httpPath":"/projects/{projectId}/users"},{"label":"Unassign Project Role","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/project-api/unassignprojectroles","routeSlug":"/swagger/project-api/unassignprojectroles","metadata":{"seo":{"title":"Unassign Project Role","description":"Remove User(s) from a specific Project Role"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"unassignProjectRoles","name":"Unassign Project Role","isWebhook":false,"pointer":"/paths/~1projects~1{projectId}~1users/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unassign Project Role","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Remove User(s) from a specific Project Role"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_58","description":"ID of the Project","required":true,"example":1}],"pointer":"/paths/~1projects~1{projectId}~1users/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/usersRole"}},"schemaId":"components/schemas/usersRole","pointer":"/paths/~1projects~1{projectId}~1users/delete/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Remove User(s) from a specific Project Role. Accepted RoleId: PROJECT_ADMIN, ANALYST, REVIEWER, OBSERVER"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/projects/{projectId}/users","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":1,"schemaId":"schema_58"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/usersRole"}},"responseCodes":["200","400","401","404","500"],"pointer":"/projects/{projectId}/users","href":"project-api/unassignprojectroles","openApiOperationId":"unassignProjectRoles","summary":"Unassign Project Role"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"components/schemas/usersRole","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/usersRole"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1projects~1{projectId}~1users/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project-api/unassignprojectroles"}],"panels":[]}]},"httpPath":"/projects/{projectId}/users"},{"label":"Get Projects","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/project-api/getprojects","routeSlug":"/swagger/project-api/getprojects","metadata":{"seo":{"title":"Get Projects","description":"Get All The Projects"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProjects","name":"Get Projects","isWebhook":false,"pointer":"/paths/~1projects/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Projects","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get All The Projects"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_76","description":"Index of the page to start with"},{"name":"limit","in":"query","schemaId":"schema_77","description":"Number Of Records to fetch"}],"pointer":"/paths/~1projects/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/projects","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[{"name":"offset","in":"query","schemaId":"schema_76"},{"name":"limit","in":"query","schemaId":"schema_77"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/projects","href":"project-api/getprojects","openApiOperationId":"getProjects","summary":"Get Projects"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1projects/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project-api/getprojects"}],"panels":[]}]},"httpPath":"/projects"},{"label":"Create Project","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/project-api/createproject_1","routeSlug":"/swagger/project-api/createproject_1","metadata":{"seo":{"title":"Create Project","description":"Creates a project for the given input, updates project custom field values and returns projectId with success message."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createProject_1","name":"Create Project","isWebhook":false,"pointer":"/paths/~1projects/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Project","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a project for the given input, updates project custom field values and returns projectId with success message."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProjectModel"}},"schemaId":"components/schemas/ProjectModel","pointer":"/paths/~1projects/post/requestBody","description":"To create a project the projectName field is required and other fields are optional. If the optional fields are left blank, the 'Project Default' values are applied for them.\nNote: For 'folderName', passing entire folder path like 'folder1/folder2' is not supported."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/projects","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ProjectModel"}},"responseCodes":["201","400","401","500"],"pointer":"/projects","href":"project-api/createproject_1","openApiOperationId":"createProject_1","summary":"Create Project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"components/schemas/ProjectModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProjectModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1projects/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project-api/createproject_1"}],"panels":[]}]},"httpPath":"/projects"},{"label":"Get Project Information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/project-api/getprojectbyid","routeSlug":"/swagger/project-api/getprojectbyid","metadata":{"seo":{"title":"Get Project Information","description":"Get Project Information By Id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProjectById","name":"Get Project Information","isWebhook":false,"pointer":"/paths/~1projects~1{projectId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Project Information","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get Project Information By Id"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_62","description":"ID of the Project","required":true,"example":1}],"pointer":"/paths/~1projects~1{projectId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/projects/{projectId}","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":1,"schemaId":"schema_62"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/projects/{projectId}","href":"project-api/getprojectbyid","openApiOperationId":"getProjectById","summary":"Get Project Information"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1projects~1{projectId}/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project-api/getprojectbyid"}],"panels":[]}]},"httpPath":"/projects/{projectId}"},{"label":"Update Project","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/project-api/updateproject","routeSlug":"/swagger/project-api/updateproject","metadata":{"seo":{"title":"Update Project","description":"Updates a project, custom field values for the given projectId.Here \"owner\" field refers to the \"contact\" of the project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateProject","name":"Update Project","isWebhook":false,"pointer":"/paths/~1projects~1{projectId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Project","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates a project, custom field values for the given projectId."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Here \"owner\" field refers to the \"contact\" of the project."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_63","description":"ID of the Project","required":true,"example":1}],"pointer":"/paths/~1projects~1{projectId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExtendedProjectModel"}},"schemaId":"components/schemas/ExtendedProjectModel","pointer":"/paths/~1projects~1{projectId}/put/requestBody","description":"Updates a project, autoPublish is required when markAssociatedFilesAsReviewed and doNotPublishInventoryUnknownLicense is part of a request."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/projects/{projectId}","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":1,"schemaId":"schema_63"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ExtendedProjectModel"}},"responseCodes":["200","400","401","404","500"],"pointer":"/projects/{projectId}","href":"project-api/updateproject","openApiOperationId":"updateProject","summary":"Update Project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"components/schemas/ExtendedProjectModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExtendedProjectModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1projects~1{projectId}/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project-api/updateproject"}],"panels":[]}]},"httpPath":"/projects/{projectId}"},{"label":"Delete a project, deletion operation will be added to queue. To get status of project deletion use jobs/{jobId} API","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/project-api/deleteproject","routeSlug":"/swagger/project-api/deleteproject","metadata":{"seo":{"title":"Delete a project, deletion operation will be added to queue. To get status of project deletion use jobs/{jobId} API","description":"Deleting a project will delete all project inventory, custom field values, corresponding notes and all code base files permanently from the server."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteProject","name":"Delete a project, deletion operation will be added to queue. To get status of project deletion use jobs/{jobId} API","isWebhook":false,"pointer":"/paths/~1projects~1{projectId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a project, deletion operation will be added to queue. To get status of project deletion use jobs/{jobId} API","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deleting a project will delete all project inventory, custom field values, corresponding notes and all code base files permanently from the server."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_58","description":"ID of the Project","required":true,"example":1}],"pointer":"/paths/~1projects~1{projectId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/projects/{projectId}","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":1,"schemaId":"schema_58"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["202","400","401","404","500"],"pointer":"/projects/{projectId}","href":"project-api/deleteproject","openApiOperationId":"deleteProject","summary":"Delete a project, deletion operation will be added to queue. To get status of project deletion use jobs/{jobId} API"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1projects~1{projectId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project-api/deleteproject"}],"panels":[]}]},"httpPath":"/projects/{projectId}"},{"label":"get all child projects","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/project-api/getallchildprojects","routeSlug":"/swagger/project-api/getallchildprojects","metadata":{"seo":{"title":"get all child projects","description":"Get all child projects. parentProject property will not be shown in the response."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllChildProjects","name":"get all child projects","isWebhook":false,"pointer":"/paths/~1projects~1{projectId}~1childProjects/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"get all child projects","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all child projects. parentProject property will not be shown in the response."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_58","description":"ID of the Project","required":true,"example":1}],"pointer":"/paths/~1projects~1{projectId}~1childProjects/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"recursive","in":"query","schemaId":"schema_59"}],"pointer":"/paths/~1projects~1{projectId}~1childProjects/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/projects/{projectId}/childProjects","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":1,"schemaId":"schema_58"}],"query":[{"name":"recursive","in":"query","schemaId":"schema_59"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/projects/{projectId}/childProjects","href":"project-api/getallchildprojects","openApiOperationId":"getAllChildProjects","summary":"get all child projects"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1projects~1{projectId}~1childProjects/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project-api/getallchildprojects"}],"panels":[]}]},"httpPath":"/projects/{projectId}/childProjects"},{"label":"get all parent projects","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/project-api/getallparentprojects","routeSlug":"/swagger/project-api/getallparentprojects","metadata":{"seo":{"title":"get all parent projects","description":"Get all parent projects. childProject property will not be shown in the response."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllParentProjects","name":"get all parent projects","isWebhook":false,"pointer":"/paths/~1projects~1{projectId}~1parentProjects/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"get all parent projects","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all parent projects. childProject property will not be shown in the response."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_58","description":"ID of the Project","required":true,"example":1}],"pointer":"/paths/~1projects~1{projectId}~1parentProjects/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"recursive","in":"query","schemaId":"schema_59"}],"pointer":"/paths/~1projects~1{projectId}~1parentProjects/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/projects/{projectId}/parentProjects","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":1,"schemaId":"schema_58"}],"query":[{"name":"recursive","in":"query","schemaId":"schema_59"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/projects/{projectId}/parentProjects","href":"project-api/getallparentprojects","openApiOperationId":"getAllParentProjects","summary":"get all parent projects"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1projects~1{projectId}~1parentProjects/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project-api/getallparentprojects"}],"panels":[]}]},"httpPath":"/projects/{projectId}/parentProjects"},{"label":"Fetch all scanned files for a project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/project-api/getallscannedfiles","routeSlug":"/swagger/project-api/getallscannedfiles","metadata":{"seo":{"title":"Fetch all scanned files for a project","description":"Fetch all scanned files for a project"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllScannedFiles","name":"Fetch all scanned files for a project","isWebhook":false,"pointer":"/paths/~1projects~1{projectId}~1allscannedfiles/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch all scanned files for a project","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_63","description":"ID of the Project","required":true,"example":1}],"pointer":"/paths/~1projects~1{projectId}~1allscannedfiles/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"includeMD5Hash","in":"query","schemaId":"schema_85","description":"if true, display MD5 of the files"},{"name":"includeSHA1Hash","in":"query","schemaId":"schema_85","description":"if true, display SHA1 of the files"},{"name":"offset","in":"query","schemaId":"schema_76","description":"Index of the page to start with"},{"name":"limit","in":"query","schemaId":"schema_77","description":"Number Of Records to fetch"}],"pointer":"/paths/~1projects~1{projectId}~1allscannedfiles/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/projects/{projectId}/allscannedfiles","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":1,"schemaId":"schema_63"}],"query":[{"name":"includeMD5Hash","in":"query","schemaId":"schema_85"},{"name":"includeSHA1Hash","in":"query","schemaId":"schema_85"},{"name":"offset","in":"query","schemaId":"schema_76"},{"name":"limit","in":"query","schemaId":"schema_77"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/projects/{projectId}/allscannedfiles","href":"project-api/getallscannedfiles","openApiOperationId":"getAllScannedFiles","summary":"Fetch all scanned files for a project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1projects~1{projectId}~1allscannedfiles/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project-api/getallscannedfiles"}],"panels":[]}]},"httpPath":"/projects/{projectId}/allscannedfiles"},{"label":"Fetch Evidences for a project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/project-api/getevidences","routeSlug":"/swagger/project-api/getevidences","metadata":{"seo":{"title":"Fetch Evidences for a project","description":"Fetch Evidences for a project"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEvidences","name":"Fetch Evidences for a project","isWebhook":false,"pointer":"/paths/~1projects~1{projectId}~1evidences/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch Evidences for a project","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_58","description":"ID of the Project","required":true,"example":1}],"pointer":"/paths/~1projects~1{projectId}~1evidences/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/projects/{projectId}/evidences","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":1,"schemaId":"schema_58"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/projects/{projectId}/evidences","href":"project-api/getevidences","openApiOperationId":"getEvidences","summary":"Fetch Evidences for a project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1projects~1{projectId}~1evidences/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project-api/getevidences"}],"panels":[]}]},"httpPath":"/projects/{projectId}/evidences"},{"label":"Get Id of file or folder","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/project-api/getfileorfolderid","routeSlug":"/swagger/project-api/getfileorfolderid","metadata":{"seo":{"title":"Get Id of file or folder","description":"Returns the ID of file and/or folder"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFileOrFolderId","name":"Get Id of file or folder","isWebhook":false,"pointer":"/paths/~1projects~1{projectId}~1files/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Id of file or folder","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the ID of file and/or folder"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_58","description":"ID of the Project","required":true,"example":1}],"pointer":"/paths/~1projects~1{projectId}~1files/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filePath","in":"query","schemaId":"schema_57","description":"Path of File (Example: git.0/angular/packages/forms/package.json)"},{"name":"folderPath","in":"query","schemaId":"schema_57","description":"Path of Folder (Example: git.0/angular/packages/forms)"}],"pointer":"/paths/~1projects~1{projectId}~1files/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/projects/{projectId}/files","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":1,"schemaId":"schema_58"}],"query":[{"name":"filePath","in":"query","schemaId":"schema_57"},{"name":"folderPath","in":"query","schemaId":"schema_57"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/projects/{projectId}/files","href":"project-api/getfileorfolderid","openApiOperationId":"getFileOrFolderId","summary":"Get Id of file or folder"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{}}},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1projects~1{projectId}~1files/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project-api/getfileorfolderid"}],"panels":[]}]},"httpPath":"/projects/{projectId}/files"},{"label":"Get Project Contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/project-api/getprojectcontact","routeSlug":"/swagger/project-api/getprojectcontact","metadata":{"seo":{"title":"Get Project Contact","description":"Get project contact for the given projectId."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProjectContact","name":"Get Project Contact","isWebhook":false,"pointer":"/paths/~1projects~1{projectId}~1contact/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Project Contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get project contact for the given projectId."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_63","description":"ID of the Project","required":true,"example":1}],"pointer":"/paths/~1projects~1{projectId}~1contact/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/projects/{projectId}/contact","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":1,"schemaId":"schema_63"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/projects/{projectId}/contact","href":"project-api/getprojectcontact","openApiOperationId":"getProjectContact","summary":"Get Project Contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1projects~1{projectId}~1contact/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project-api/getprojectcontact"}],"panels":[]}]},"httpPath":"/projects/{projectId}/contact"},{"label":"Update Project Contact","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/project-api/updateprojectcontact","routeSlug":"/swagger/project-api/updateprojectcontact","metadata":{"seo":{"title":"Update Project Contact","description":"Updates project contact for the given projectId."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateProjectContact","name":"Update Project Contact","isWebhook":false,"pointer":"/paths/~1projects~1{projectId}~1contact/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Project Contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates project contact for the given projectId."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_63","description":"ID of the Project","required":true,"example":1}],"pointer":"/paths/~1projects~1{projectId}~1contact/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProjectContact"}},"schemaId":"components/schemas/ProjectContact","pointer":"/paths/~1projects~1{projectId}~1contact/put/requestBody","description":"Updates a project contact"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/projects/{projectId}/contact","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":1,"schemaId":"schema_63"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ProjectContact"}},"responseCodes":["200","400","401","404","500"],"pointer":"/projects/{projectId}/contact","href":"project-api/updateprojectcontact","openApiOperationId":"updateProjectContact","summary":"Update Project Contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"components/schemas/ProjectContact","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProjectContact"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1projects~1{projectId}~1contact/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project-api/updateprojectcontact"}],"panels":[]}]},"httpPath":"/projects/{projectId}/contact"},{"label":"Get project inventories for the given scan-agent or scan-server alias","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/project-api/getprojectinventoriesbyalias","routeSlug":"/swagger/project-api/getprojectinventoriesbyalias","metadata":{"seo":{"title":"Get project inventories for the given scan-agent or scan-server alias","description":"Returns all inventories of the project associated with the given scan-agent or scan-server alias"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProjectInventoriesByAlias","name":"Get project inventories for the given scan-agent or scan-server alias","isWebhook":false,"pointer":"/paths/~1projects~1{projectId}~1inventories~1{alias}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get project inventories for the given scan-agent or scan-server alias","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns all inventories of the project associated with the given scan-agent or scan-server alias"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_58","description":"ID of the Project","required":true,"example":1},{"name":"alias","in":"path","schemaId":"schema_57","description":"Alias of scan-server or scan-agent (Example: generic-plugin-test)","required":true}],"pointer":"/paths/~1projects~1{projectId}~1inventories~1{alias}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_73","description":"Page Size. Number Of Records to fetch per page"},{"name":"offset","in":"query","schemaId":"schema_74","description":"Page Number. Index of the page to start with(starts from 1)"}],"pointer":"/paths/~1projects~1{projectId}~1inventories~1{alias}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/projects/{projectId}/inventories/{alias}","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":1,"schemaId":"schema_58"},{"name":"alias","in":"path","required":true,"schemaId":"schema_57"}],"query":[{"name":"limit","in":"query","schemaId":"schema_73"},{"name":"offset","in":"query","schemaId":"schema_74"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","500"],"pointer":"/projects/{projectId}/inventories/{alias}","href":"project-api/getprojectinventoriesbyalias","openApiOperationId":"getProjectInventoriesByAlias","summary":"Get project inventories for the given scan-agent or scan-server alias"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"},{"code":"409","description":"Conflict"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1projects~1{projectId}~1inventories~1{alias}/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project-api/getprojectinventoriesbyalias"}],"panels":[]}]},"httpPath":"/projects/{projectId}/inventories/{alias}"},{"label":"Get Inventory Summary of the project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/project-api/getprojectinventorysummary","routeSlug":"/swagger/project-api/getprojectinventorysummary","metadata":{"seo":{"title":"Get Inventory Summary of the project","description":"Get Project level inventory summary"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProjectInventorySummary","name":"Get Inventory Summary of the project","isWebhook":false,"pointer":"/paths/~1projects~1{projectId}~1inventorySummary/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Inventory Summary of the project","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get Project level inventory summary"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_63","description":"ID of the Project","required":true,"example":1}],"pointer":"/paths/~1projects~1{projectId}~1inventorySummary/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"vulnerabilitySummary","in":"query","schemaId":"schema_59","description":"If false , hide vulnerabilty summary details"},{"name":"cvssVersion","in":"query","schemaId":"schema_72","description":"CVSS : This field is required only if vulnerabilitySummary is set to true"},{"name":"published","in":"query","schemaId":"schema_86","description":"If published, then only published inventory items are returned; if unpublished, then only not-published inventory items are returned; if all, then return all inventories"},{"name":"offset","in":"query","schemaId":"schema_76","description":"Index of the page to start with"},{"name":"limit","in":"query","schemaId":"schema_77","description":"Number Of Records to fetch"}],"pointer":"/paths/~1projects~1{projectId}~1inventorySummary/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/projects/{projectId}/inventorySummary","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":1,"schemaId":"schema_63"}],"query":[{"name":"vulnerabilitySummary","in":"query","schemaId":"schema_59"},{"name":"cvssVersion","in":"query","schemaId":"schema_72"},{"name":"published","in":"query","schemaId":"schema_86"},{"name":"offset","in":"query","schemaId":"schema_76"},{"name":"limit","in":"query","schemaId":"schema_77"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/projects/{projectId}/inventorySummary","href":"project-api/getprojectinventorysummary","openApiOperationId":"getProjectInventorySummary","summary":"Get Inventory Summary of the project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1projects~1{projectId}~1inventorySummary/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project-api/getprojectinventorysummary"}],"panels":[]}]},"httpPath":"/projects/{projectId}/inventorySummary"},{"label":"Fetch all scan nodes (alias) of a project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/project-api/getscannodes","routeSlug":"/swagger/project-api/getscannodes","metadata":{"seo":{"title":"Fetch all scan nodes (alias) of a project","description":"Returns all the alias node information of a project"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getScanNodes","name":"Fetch all scan nodes (alias) of a project","isWebhook":false,"pointer":"/paths/~1projects~1{projectId}~1scanNodes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch all scan nodes (alias) of a project","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns all the alias node information of a project"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_58","description":"ID of the Project","required":true,"example":1}],"pointer":"/paths/~1projects~1{projectId}~1scanNodes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/projects/{projectId}/scanNodes","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":1,"schemaId":"schema_58"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/projects/{projectId}/scanNodes","href":"project-api/getscannodes","openApiOperationId":"getScanNodes","summary":"Fetch all scan nodes (alias) of a project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1projects~1{projectId}~1scanNodes/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project-api/getscannodes"}],"panels":[]}]},"httpPath":"/projects/{projectId}/scanNodes"},{"label":"project status","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/project-api/updateprojectstatus","routeSlug":"/swagger/project-api/updateprojectstatus","metadata":{"seo":{"title":"project status","description":"Updates the status of a project.By default, a newly created project has the status \"Not Started\". After scanning begins, the status is automatically updated to \"Analysis In Progress\".Note: ProjectAction can be specified with below values:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateProjectStatus","name":"project status","isWebhook":false,"pointer":"/paths/~1projects~1{projectId}~1status/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"project status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates the status of a project."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, a newly created project has the status \"Not Started\". After scanning begins, the status is automatically updated to \"Analysis In Progress\"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ProjectAction can be specified with below values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update Status Only"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Only updates the status of the project, if project status is kept COMPLETED, it will lock the current project."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lock Child Projects"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Locks all child projects of the current project. (allowed only if project status is kept COMPLETED)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unlock Child Projects"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Unlocks all child projects of the current project. (allowed only if project status is not COMPLETED)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use projectAction to control the locking behavior in relation to the project's current status."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_58","description":"ID of the Project","required":true,"example":1}],"pointer":"/paths/~1projects~1{projectId}~1status/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"status","in":"query","schemaId":"schema_87","required":true},{"name":"projectAction","in":"query","schemaId":"schema_88","required":true}],"pointer":"/paths/~1projects~1{projectId}~1status/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/projects/{projectId}/status","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":1,"schemaId":"schema_58"}],"query":[{"name":"status","in":"query","required":true,"schemaId":"schema_87"},{"name":"projectAction","in":"query","required":true,"schemaId":"schema_88"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/projects/{projectId}/status","href":"project-api/updateprojectstatus","openApiOperationId":"updateProjectStatus","summary":"project status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1projects~1{projectId}~1status/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project-api/updateprojectstatus"}],"panels":[]}]},"httpPath":"/projects/{projectId}/status"},{"label":"Upload Report.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/project-api/uploadreport","routeSlug":"/swagger/project-api/uploadreport","metadata":{"seo":{"title":"Upload Report.","description":"Uploads and extracts a report zip file for a project.curl -H \"Authorization: Bearer %jwt%\" --form projectId=%projectId% --form reportId=%reportId% --form file=@\"pdf_reports.zip\" http://localhost:8888/codeinsight/api/projects/uploadReport"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadReport","name":"Upload Report.","isWebhook":false,"pointer":"/paths/~1projects~1uploadReport/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload Report.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Uploads and extracts a report zip file for a project.curl -H \"Authorization: Bearer %jwt%\" --form projectId=%projectId% --form reportId=%reportId% --form file=@\"pdf_reports.zip\" http://localhost:8888/codeinsight/api/projects/uploadReport"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_89"}},"schemaId":"schema_89","pointer":"/paths/~1projects~1uploadReport/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/projects/uploadReport","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_89"}},"responseCodes":["200","400","401","404","500"],"pointer":"/projects/uploadReport","href":"project-api/uploadreport","openApiOperationId":"uploadReport","summary":"Upload Report."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"schema_89","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_89"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1projects~1uploadReport/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project-api/uploadreport"}],"panels":[]}]},"httpPath":"/projects/uploadReport"},{"label":"Import Project Data","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/project-api/importprojectdata_1","routeSlug":"/swagger/project-api/importprojectdata_1","metadata":{"seo":{"title":"Import Project Data","description":"Imports project data for a given projectId. Only Project Owner and Analyst can Import Project Data into a private project.Try it out is not available for this API. This API can be tested using conventional REST API clients such as postman or cURLWhen calling this API from a REST client, you need to run either of the curl commands.Save the required attributes in a json or a text file for project import and provide that file in the command. If you are using text file, don't give .txt extension."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"importProjectData_1","name":"Import Project Data","isWebhook":false,"pointer":"/paths/~1projects~1{projectId}~1import/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Import Project Data","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Imports project data for a given projectId. Only Project Owner and Analyst can Import Project Data into a private project."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Try it out is not available for this API. This API can be tested using conventional REST API clients such as postman or cURL"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When calling this API from a REST client, you need to run either of the curl commands."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Save the required attributes in a json or a text file for project import and provide that file in the command. If you are using text file, don't give .txt extension."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -H \"Authorization:Bearer %jwt%\" -F importFile=@\"fileToImport.zip\" -F projectImportModel=@\"JsonFile.json Or textFile;type=application/json\" http://localhost:8888/codeinsight/api/projects/%projectId%/import\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -H \"Authorization:Bearer %jwt%\" -F importFile=@\"fileToImport.zip\" -F projectImportModel=@\"JsonFile.json Or textFile;type=application/json\" http://localhost:8888/codeinsight/api/projects/%projectId%/import\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Or else, instead of providing file, you can directly define the attributes for projectImportModel inside curly braces."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide 'FileMatchingCriteria' either of the below values:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COMPLETE_FILEPATH|PARTIAL_FILEPATH|FILENAME|MD5|MD5_AND_FILENAME|MD5_AND_COMPLETE_FILEPATH|MD5_AND_PARTIAL_FILEPATH"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_90","required":true}],"pointer":"/paths/~1projects~1{projectId}~1import/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_91"}},"schemaId":"schema_91","pointer":"/paths/~1projects~1{projectId}~1import/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/projects/{projectId}/import","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_91"}},"responseCodes":["200","400","401","404","500"],"pointer":"/projects/{projectId}/import","href":"project-api/importprojectdata_1","openApiOperationId":"importProjectData_1","summary":"Import Project Data"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"schema_91","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_91"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1projects~1{projectId}~1import/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project-api/importprojectdata_1"}],"panels":[]}]},"httpPath":"/projects/{projectId}/import"},{"label":"Import Sbom","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/project-api/importsbom","routeSlug":"/swagger/project-api/importsbom","metadata":{"seo":{"title":"Import Sbom","description":"Imports Sbom for a given projectId. Only Project Owner and Analyst can Import Project Sbom into a private project.Try it out is not available for this API. This API can be tested using conventional REST API clients such as postman or cURL. When calling this API from a REST client, you need to run either of the curl commands."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"importSbom","name":"Import Sbom","isWebhook":false,"pointer":"/paths/~1projects~1{projectId}~1importSbom/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Import Sbom","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Imports Sbom for a given projectId. Only Project Owner and Analyst can Import Project Sbom into a private project."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Try it out is not available for this API. This API can be tested using conventional REST API clients such as postman or cURL. When calling this API from a REST client, you need to run either of the curl commands."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -H \"Authorization:Bearer %jwt%\" -F sbomFile=@\"fileToImport.json;type=application/json\" http://localhost:8888/codeinsight/api/projects/%projectId%/importSbom\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -H \"Authorization:Bearer %jwt%\" -F sbomFile=@\"fileToImport.json;type=application/json\" http://localhost:8888/codeinsight/api/projects/%projectId%/importSbom\n"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_90","required":true}],"pointer":"/paths/~1projects~1{projectId}~1importSbom/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_92"}},"schemaId":"schema_92","pointer":"/paths/~1projects~1{projectId}~1importSbom/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/projects/{projectId}/importSbom","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_92"}},"responseCodes":["200","400","401","404","500"],"pointer":"/projects/{projectId}/importSbom","href":"project-api/importsbom","openApiOperationId":"importSbom","summary":"Import Sbom"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"schema_92","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_92"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1projects~1{projectId}~1importSbom/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project-api/importsbom"}],"panels":[]}]},"httpPath":"/projects/{projectId}/importSbom"},{"label":"Generate Report","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/project-api/generatereport","routeSlug":"/swagger/project-api/generatereport","metadata":{"seo":{"title":"Generate Report","description":"This API is deprecated please refer to /projects/{projectId}/reports/{reportId}/generate to Generate a report.Refer /projects/{projectId}/reports/{reportId}/download to Download a report.Generates Reports (PROJECT, AUDIT, NOTICES, CUSTOM_REPORT) for a given projectId. For CUSTOM_REPORT provide the name of the report. All project users including Observer, Reviewer and Analyst can generate reports for private projects.Try it out is not available for this API. This API can be tested using conventional REST API clients such as postman or cURL.When calling this API from a REST client, you need to redirect output to a zip file as follows"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"generateReport","name":"Generate Report","deprecated":true,"isWebhook":false,"pointer":"/paths/~1project~1generateReport/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate Report","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API is deprecated please refer to /projects/{projectId}/reports/{reportId}/generate to Generate a report."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer /projects/{projectId}/reports/{reportId}/download to Download a report."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generates Reports (PROJECT, AUDIT, NOTICES, CUSTOM_REPORT) for a given projectId. For CUSTOM_REPORT provide the name of the report. All project users including Observer, Reviewer and Analyst can generate reports for private projects."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Try it out is not available for this API. This API can be tested using conventional REST API clients such as postman or cURL."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When calling this API from a REST client, you need to redirect output to a zip file as follows"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -X GET \"http://HOST:PORT/codeinsight/api/project/generateReport?reportType=REPORT_TYPE&projectId=PROJECT_ID\" -H \"accept: application/octet-stream\" -H \"Authorization: Bearer JWT_TOKEN\" > report.zip\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -X GET \"http://HOST:PORT/codeinsight/api/project/generateReport?reportType=REPORT_TYPE&projectId=PROJECT_ID\" -H \"accept: application/octet-stream\" -H \"Authorization: Bearer JWT_TOKEN\" > report.zip\n"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"projectId","in":"query","schemaId":"schema_62","description":"ID of the Project","required":true,"example":1},{"name":"reportType","in":"query","schemaId":"schema_57","description":"Report Type","required":true,"example":"PROJECT"},{"name":"otherProjectId","in":"query","schemaId":"schema_63","description":"Project Id of the secondary project to be included in the report. This parameter is required, if the enableProjectPicker property for this report type is set to true. (Example: 2)"}],"pointer":"/paths/~1project~1generateReport/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/project/generateReport","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[{"name":"projectId","in":"query","required":true,"example":1,"schemaId":"schema_62"},{"name":"reportType","in":"query","required":true,"example":"PROJECT","schemaId":"schema_57"},{"name":"otherProjectId","in":"query","schemaId":"schema_63"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/project/generateReport","href":"project-api/generatereport","openApiOperationId":"generateReport","summary":"Generate Report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/octet-stream","mediaTypes":["application/octet-stream"],"mediaTypeContent":{"application/octet-stream":{}}},{"code":"400","description":"Bad request: No project with id x"}],"pointer":"/paths/~1project~1generateReport/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project-api/generatereport"}],"panels":[]}]},"httpPath":"/project/generateReport"},{"label":"Create Project","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/project-api/createproject","routeSlug":"/swagger/project-api/createproject","metadata":{"seo":{"title":"Create Project","description":"Use the enhanced '/projects' api."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createProject","name":"Create Project","deprecated":true,"isWebhook":false,"pointer":"/paths/~1project~1createProject/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Project","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use the enhanced '/projects' api."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateProjectModel"}},"schemaId":"components/schemas/CreateProjectModel","pointer":"/paths/~1project~1createProject/post/requestBody","description":"To create a project the projectName field is required and other fields are optional. If the optional fields are left blank, the 'Project Default' values are applied for them."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/project/createProject","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateProjectModel"}},"responseCodes":["200","500"],"pointer":"/project/createProject","href":"project-api/createproject","openApiOperationId":"createProject","summary":"Create Project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"components/schemas/CreateProjectModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateProjectModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_64"}},"schemaId":"schema_64"},{"code":"500","description":"Error : error message"}],"pointer":"/paths/~1project~1createProject/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_64","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_64"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project-api/createproject"}],"panels":[]}]},"httpPath":"/project/createProject"}],"content":{"contentType":"group","meta":{"name":"Project API"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Project API","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/project/inventoryDeltaFromLastScan/{projectId}","summary":"Get Project Inventories Delta from latest scan","prefix":{"name":"get","color":"get"},"badges":[],"link":"/project-api/getmodifiedprojectinventorybyproject","deprecated":false},{"title":"/project/id","summary":"Get Project Id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/project-api/getprojectid","deprecated":false},{"title":"/project/inventory/{projectId}","summary":"Get Project Inventory","prefix":{"name":"get","color":"get"},"badges":[],"link":"/project-api/getprojectinventory","deprecated":false},{"title":"/project/inventoryLite/{projectId}","summary":"Get Project Inventory by Date","prefix":{"name":"get","color":"get"},"badges":[],"link":"/project-api/getprojectinventorybydate","deprecated":false},{"title":"/project/scanStatus/{taskId}","summary":"Get Scan Status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/project-api/getprojectscanstatus","deprecated":false},{"title":"/project/uploadProjectCodebase","summary":"Upload Project Files.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/project-api/uploadproject","deprecated":false},{"title":"/project/exportProjectData","summary":"Export Project Data","prefix":{"name":"get","color":"get"},"badges":[],"link":"/project-api/exportprojectdata","deprecated":false},{"title":"/projects/{projectId}/reports/{reportId}/download","summary":"Download Report","prefix":{"name":"get","color":"get"},"badges":[],"link":"/project-api/downloadreport","deprecated":false},{"title":"/projects/{projectId}/reports/{reportId}/generate","summary":"Generate Report","prefix":{"name":"post","color":"post"},"badges":[],"link":"/project-api/generatereport_1","deprecated":false},{"title":"/projects/{projectId}/children","summary":"Add child projects to parent project","prefix":{"name":"post","color":"post"},"badges":[],"link":"/project-api/addchildprojects","deprecated":false},{"title":"/projects/{projectId}/children","summary":"Remove child Projects from parent project","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/project-api/removechildprojects","deprecated":false},{"title":"/projects/{projectId}/archive","summary":"Archive a project","prefix":{"name":"post","color":"post"},"badges":[],"link":"/project-api/archiveproject","deprecated":false},{"title":"/projects/{projectId}/users","summary":"Users","prefix":{"name":"get","color":"get"},"badges":[],"link":"/project-api/getprojectuserrole","deprecated":false},{"title":"/projects/{projectId}/users","summary":"Assign Role","prefix":{"name":"post","color":"post"},"badges":[],"link":"/project-api/assignprojectrole","deprecated":false},{"title":"/projects/{projectId}/users","summary":"Unassign Project Role","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/project-api/unassignprojectroles","deprecated":false},{"title":"/projects","summary":"Get Projects","prefix":{"name":"get","color":"get"},"badges":[],"link":"/project-api/getprojects","deprecated":false},{"title":"/projects","summary":"Create Project","prefix":{"name":"post","color":"post"},"badges":[],"link":"/project-api/createproject_1","deprecated":false},{"title":"/projects/{projectId}","summary":"Get Project Information","prefix":{"name":"get","color":"get"},"badges":[],"link":"/project-api/getprojectbyid","deprecated":false},{"title":"/projects/{projectId}","summary":"Update Project","prefix":{"name":"put","color":"put"},"badges":[],"link":"/project-api/updateproject","deprecated":false},{"title":"/projects/{projectId}","summary":"Delete a project, deletion operation will be added to queue. To get status of project deletion use jobs/{jobId} API","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/project-api/deleteproject","deprecated":false},{"title":"/projects/{projectId}/childProjects","summary":"get all child projects","prefix":{"name":"get","color":"get"},"badges":[],"link":"/project-api/getallchildprojects","deprecated":false},{"title":"/projects/{projectId}/parentProjects","summary":"get all parent projects","prefix":{"name":"get","color":"get"},"badges":[],"link":"/project-api/getallparentprojects","deprecated":false},{"title":"/projects/{projectId}/allscannedfiles","summary":"Fetch all scanned files for a project","prefix":{"name":"get","color":"get"},"badges":[],"link":"/project-api/getallscannedfiles","deprecated":false},{"title":"/projects/{projectId}/evidences","summary":"Fetch Evidences for a project","prefix":{"name":"get","color":"get"},"badges":[],"link":"/project-api/getevidences","deprecated":false},{"title":"/projects/{projectId}/files","summary":"Get Id of file or folder","prefix":{"name":"get","color":"get"},"badges":[],"link":"/project-api/getfileorfolderid","deprecated":false},{"title":"/projects/{projectId}/contact","summary":"Get Project Contact","prefix":{"name":"get","color":"get"},"badges":[],"link":"/project-api/getprojectcontact","deprecated":false},{"title":"/projects/{projectId}/contact","summary":"Update Project Contact","prefix":{"name":"put","color":"put"},"badges":[],"link":"/project-api/updateprojectcontact","deprecated":false},{"title":"/projects/{projectId}/inventories/{alias}","summary":"Get project inventories for the given scan-agent or scan-server alias","prefix":{"name":"get","color":"get"},"badges":[],"link":"/project-api/getprojectinventoriesbyalias","deprecated":false},{"title":"/projects/{projectId}/inventorySummary","summary":"Get Inventory Summary of the project","prefix":{"name":"get","color":"get"},"badges":[],"link":"/project-api/getprojectinventorysummary","deprecated":false},{"title":"/projects/{projectId}/scanNodes","summary":"Fetch all scan nodes (alias) of a project","prefix":{"name":"get","color":"get"},"badges":[],"link":"/project-api/getscannodes","deprecated":false},{"title":"/projects/{projectId}/status","summary":"project status","prefix":{"name":"put","color":"put"},"badges":[],"link":"/project-api/updateprojectstatus","deprecated":false},{"title":"/projects/uploadReport","summary":"Upload Report.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/project-api/uploadreport","deprecated":false},{"title":"/projects/{projectId}/import","summary":"Import Project Data","prefix":{"name":"post","color":"post"},"badges":[],"link":"/project-api/importprojectdata_1","deprecated":false},{"title":"/projects/{projectId}/importSbom","summary":"Import Sbom","prefix":{"name":"post","color":"post"},"badges":[],"link":"/project-api/importsbom","deprecated":false},{"title":"/project/generateReport","summary":"Generate Report","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/project-api/generatereport","deprecated":true},{"title":"/project/createProject","summary":"Create Project","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/project-api/createproject","deprecated":true}]}]}]}]}},{"type":"group","label":"Inventory API","link":"/swagger/inventory-api","routeSlug":"/swagger/inventory-api","items":[{"label":"Add Files and/or Folders to Inventory","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/inventory-api/addfilestoinventory","routeSlug":"/swagger/inventory-api/addfilestoinventory","metadata":{"seo":{"title":"Add Files and/or Folders to Inventory","description":"Add files and/or folders to inventory item and returns the response message"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addFilesToInventory","name":"Add Files and/or Folders to Inventory","isWebhook":false,"pointer":"/paths/~1inventories~1{inventoryId}~1files/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add Files and/or Folders to Inventory","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Add files and/or folders to inventory item and returns the response message"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"inventoryId","in":"path","schemaId":"schema_62","description":"ID of the Inventory","required":true,"example":1}],"pointer":"/paths/~1inventories~1{inventoryId}~1files/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InventoryFilesModel"}},"schemaId":"components/schemas/InventoryFilesModel","pointer":"/paths/~1inventories~1{inventoryId}~1files/put/requestBody","description":"To Add files and folders to the inventory provide file and folder paths."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/inventories/{inventoryId}/files","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"inventoryId","in":"path","required":true,"example":1,"schemaId":"schema_62"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/InventoryFilesModel"}},"responseCodes":["200","400","401","404","500"],"pointer":"/inventories/{inventoryId}/files","href":"inventory-api/addfilestoinventory","openApiOperationId":"addFilesToInventory","summary":"Add Files and/or Folders to Inventory"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"components/schemas/InventoryFilesModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InventoryFilesModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}},"schemaId":"schema_57"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1inventories~1{inventoryId}~1files/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_57","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}}},{"code":"400"},{"code":"401"},{"code":"404"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inventory-api/addfilestoinventory"}],"panels":[]}]},"httpPath":"/inventories/{inventoryId}/files"},{"label":"Create Inventory","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/inventory-api/createinventory","routeSlug":"/swagger/inventory-api/createinventory","metadata":{"seo":{"title":"Create Inventory","description":"Create an inventory. Name and Inventory type is a mandatory field."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createInventory","name":"Create Inventory","isWebhook":false,"pointer":"/paths/~1inventories/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Inventory","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an inventory. Name and Inventory type is a mandatory field."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Value for rememberLicense can be GLOBAL or INVENTORY (default)."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GLOBAL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Saves and applies the component version and license mapping to the current inventory and all future inventories across projects."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INVENTORY"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Updates only the current inventory. Future inventories will use the original license mapping."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProjectInventoryModel"}},"schemaId":"components/schemas/ProjectInventoryModel","pointer":"/paths/~1inventories/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/inventories","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ProjectInventoryModel"}},"responseCodes":["201","400","401","500"],"pointer":"/inventories","href":"inventory-api/createinventory","openApiOperationId":"createInventory","summary":"Create Inventory"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"components/schemas/ProjectInventoryModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProjectInventoryModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1inventories/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inventory-api/createinventory"}],"panels":[]}]},"httpPath":"/inventories"},{"label":"Get details of an inventory","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/inventory-api/getinventorybyid","routeSlug":"/swagger/inventory-api/getinventorybyid","metadata":{"seo":{"title":"Get details of an inventory","description":"Get details of an inventory."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getInventoryById","name":"Get details of an inventory","isWebhook":false,"pointer":"/paths/~1inventories~1{inventoryId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get details of an inventory","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get details of an inventory."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"inventoryId","in":"path","schemaId":"schema_62","description":"ID of the Inventory","required":true,"example":1}],"pointer":"/paths/~1inventories~1{inventoryId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"skipVulnerabilities","in":"query","schemaId":"schema_59","description":"If true , hide vulnerabilty details"}],"pointer":"/paths/~1inventories~1{inventoryId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/inventories/{inventoryId}","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"inventoryId","in":"path","required":true,"example":1,"schemaId":"schema_62"}],"query":[{"name":"skipVulnerabilities","in":"query","schemaId":"schema_59"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/inventories/{inventoryId}","href":"inventory-api/getinventorybyid","openApiOperationId":"getInventoryById","summary":"Get details of an inventory"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1inventories~1{inventoryId}/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inventory-api/getinventorybyid"}],"panels":[]}]},"httpPath":"/inventories/{inventoryId}"},{"label":"Update Inventory","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/inventory-api/updateinventory","routeSlug":"/swagger/inventory-api/updateinventory","metadata":{"seo":{"title":"Update Inventory","description":"Update an inventory for a given inventoryId."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateInventory","name":"Update Inventory","isWebhook":false,"pointer":"/paths/~1inventories~1{inventoryId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Inventory","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update an inventory for a given inventoryId."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Value for rememberLicense can be GLOBAL or INVENTORY (default)."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GLOBAL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Saves and applies the component version and license mapping to the current inventory and all future inventories across projects."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INVENTORY"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Updates only the current inventory. Future inventories will use the original license mapping."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"inventoryId","in":"path","schemaId":"schema_62","description":"ID of the Inventory","required":true,"example":1}],"pointer":"/paths/~1inventories~1{inventoryId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InventoryModel"}},"schemaId":"components/schemas/InventoryModel","pointer":"/paths/~1inventories~1{inventoryId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/inventories/{inventoryId}","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"inventoryId","in":"path","required":true,"example":1,"schemaId":"schema_62"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/InventoryModel"}},"responseCodes":["200","400","401","403","404","500"],"pointer":"/inventories/{inventoryId}","href":"inventory-api/updateinventory","openApiOperationId":"updateInventory","summary":"Update Inventory"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"components/schemas/InventoryModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InventoryModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1inventories~1{inventoryId}/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inventory-api/updateinventory"}],"panels":[]}]},"httpPath":"/inventories/{inventoryId}"},{"label":"Delete the inventory","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/inventory-api/deleteinventory","routeSlug":"/swagger/inventory-api/deleteinventory","metadata":{"seo":{"title":"Delete the inventory","description":"delete inventory"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteInventory","name":"Delete the inventory","isWebhook":false,"pointer":"/paths/~1inventories~1{inventoryId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete the inventory","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"delete inventory"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"inventoryId","in":"path","schemaId":"schema_62","description":"ID of the Inventory","required":true,"example":1}],"pointer":"/paths/~1inventories~1{inventoryId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/inventories/{inventoryId}","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"inventoryId","in":"path","required":true,"example":1,"schemaId":"schema_62"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/inventories/{inventoryId}","href":"inventory-api/deleteinventory","openApiOperationId":"deleteInventory","summary":"Delete the inventory"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1inventories~1{inventoryId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inventory-api/deleteinventory"}],"panels":[]}]},"httpPath":"/inventories/{inventoryId}"},{"label":"Get history of an inventory","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/inventory-api/fetchhistory","routeSlug":"/swagger/inventory-api/fetchhistory","metadata":{"seo":{"title":"Get history of an inventory","description":"Fetches the history for a given inventoryId, changes are grouped based on the revision id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"fetchHistory","name":"Get history of an inventory","isWebhook":false,"pointer":"/paths/~1inventories~1{inventoryId}~1history/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get history of an inventory","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches the history for a given inventoryId, changes are grouped based on the revision id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"inventoryId","in":"path","schemaId":"schema_62","description":"ID of the Inventory","required":true,"example":1}],"pointer":"/paths/~1inventories~1{inventoryId}~1history/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_73","description":"Page Size. Number Of Records to fetch per page"},{"name":"offset","in":"query","schemaId":"schema_74","description":"Page Number. Index of the page to start with(starts from 1)"}],"pointer":"/paths/~1inventories~1{inventoryId}~1history/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/inventories/{inventoryId}/history","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"inventoryId","in":"path","required":true,"example":1,"schemaId":"schema_62"}],"query":[{"name":"limit","in":"query","schemaId":"schema_73"},{"name":"offset","in":"query","schemaId":"schema_74"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/inventories/{inventoryId}/history","href":"inventory-api/fetchhistory","openApiOperationId":"fetchHistory","summary":"Get history of an inventory"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}},"schemaId":"schema_57"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1inventories~1{inventoryId}~1history/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_57","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}}},{"code":"400"},{"code":"401"},{"code":"404"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inventory-api/fetchhistory"}],"panels":[]}]},"httpPath":"/inventories/{inventoryId}/history"},{"label":"Get children of an inventory","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/inventory-api/fetchinventorychildren","routeSlug":"/swagger/inventory-api/fetchinventorychildren","metadata":{"seo":{"title":"Get children of an inventory","description":"Fetches the children for a given inventoryId."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"fetchInventoryChildren","name":"Get children of an inventory","isWebhook":false,"pointer":"/paths/~1inventories~1{inventoryId}~1children/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get children of an inventory","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches the children for a given inventoryId."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"inventoryId","in":"path","schemaId":"schema_62","description":"ID of the Inventory","required":true,"example":1}],"pointer":"/paths/~1inventories~1{inventoryId}~1children/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_73","description":"Page Size. Number Of Records to fetch per page"},{"name":"offset","in":"query","schemaId":"schema_74","description":"Page Number. Index of the page to start with(starts from 1)"}],"pointer":"/paths/~1inventories~1{inventoryId}~1children/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/inventories/{inventoryId}/children","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"inventoryId","in":"path","required":true,"example":1,"schemaId":"schema_62"}],"query":[{"name":"limit","in":"query","schemaId":"schema_73"},{"name":"offset","in":"query","schemaId":"schema_74"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/inventories/{inventoryId}/children","href":"inventory-api/fetchinventorychildren","openApiOperationId":"fetchInventoryChildren","summary":"Get children of an inventory"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}},"schemaId":"schema_57"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1inventories~1{inventoryId}~1children/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_57","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}}},{"code":"400"},{"code":"401"},{"code":"404"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inventory-api/fetchinventorychildren"}],"panels":[]}]},"httpPath":"/inventories/{inventoryId}/children"},{"label":"Get parents of an inventory","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/inventory-api/fetchinventoryparents","routeSlug":"/swagger/inventory-api/fetchinventoryparents","metadata":{"seo":{"title":"Get parents of an inventory","description":"Fetches the parents for a given inventoryId."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"fetchInventoryParents","name":"Get parents of an inventory","isWebhook":false,"pointer":"/paths/~1inventories~1{inventoryId}~1parents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get parents of an inventory","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches the parents for a given inventoryId."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"inventoryId","in":"path","schemaId":"schema_62","description":"ID of the Inventory","required":true,"example":1}],"pointer":"/paths/~1inventories~1{inventoryId}~1parents/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_73","description":"Page Size. Number Of Records to fetch per page"},{"name":"offset","in":"query","schemaId":"schema_74","description":"Page Number. Index of the page to start with(starts from 1)"}],"pointer":"/paths/~1inventories~1{inventoryId}~1parents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/inventories/{inventoryId}/parents","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"inventoryId","in":"path","required":true,"example":1,"schemaId":"schema_62"}],"query":[{"name":"limit","in":"query","schemaId":"schema_73"},{"name":"offset","in":"query","schemaId":"schema_74"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/inventories/{inventoryId}/parents","href":"inventory-api/fetchinventoryparents","openApiOperationId":"fetchInventoryParents","summary":"Get parents of an inventory"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}},"schemaId":"schema_57"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1inventories~1{inventoryId}~1parents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_57","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}}},{"code":"400"},{"code":"401"},{"code":"404"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inventory-api/fetchinventoryparents"}],"panels":[]}]},"httpPath":"/inventories/{inventoryId}/parents"},{"label":"Get All Inventories by Date","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/inventory-api/getallprojectinventoriesbydate","routeSlug":"/swagger/inventory-api/getallprojectinventoriesbydate","metadata":{"seo":{"title":"Get All Inventories by Date","description":"Returns a list of inventories and relevant details within the given date and time. All users can view project inventories of public projects and users with permission can view the inventories of private project"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllProjectInventoriesByDate","name":"Get All Inventories by Date","isWebhook":false,"pointer":"/paths/~1inventories~1searchByDate/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get All Inventories by Date","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of inventories and relevant details within the given date and time. All users can view project inventories of public projects and users with permission can view the inventories of private project"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"startTime","in":"query","schemaId":"schema_57","description":"Start time for an inventory (Format: YYYY-MM-DD HH:MM:SS)"},{"name":"endTime","in":"query","schemaId":"schema_57","description":"End time for an inventory (Format: YYYY-MM-DD HH:MM:SS)"},{"name":"published","in":"query","schemaId":"schema_86","description":"If published, then only published inventory items are returned; if unpublished, then only not-published inventory items are returned; if all, then return all inventories"},{"name":"size","in":"query","schemaId":"schema_60","description":"Page Size. Number Of Records to fetch per page"},{"name":"page","in":"query","schemaId":"schema_61","description":"Page Number. Index of the page to start with(starts from 1)"}],"pointer":"/paths/~1inventories~1searchByDate/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/inventories/searchByDate","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[{"name":"startTime","in":"query","schemaId":"schema_57"},{"name":"endTime","in":"query","schemaId":"schema_57"},{"name":"published","in":"query","schemaId":"schema_86"},{"name":"size","in":"query","schemaId":"schema_60"},{"name":"page","in":"query","schemaId":"schema_61"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/inventories/searchByDate","href":"inventory-api/getallprojectinventoriesbydate","openApiOperationId":"getAllProjectInventoriesByDate","summary":"Get All Inventories by Date"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1inventories~1searchByDate/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inventory-api/getallprojectinventoriesbydate"}],"panels":[]}]},"httpPath":"/inventories/searchByDate"},{"label":"Get the inventories of file/folder ids","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/inventory-api/getinventory","routeSlug":"/swagger/inventory-api/getinventory","metadata":{"seo":{"title":"Get the inventories of file/folder ids","description":"Returns the inventories file and/or folder ids"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getInventory","name":"Get the inventories of file/folder ids","isWebhook":false,"pointer":"/paths/~1inventories~1search/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the inventories of file/folder ids","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the inventories file and/or folder ids"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"projectId","in":"query","schemaId":"schema_58","description":"ID of the Project","required":true,"example":1},{"name":"fileIds","in":"query","schemaId":"schema_57","description":"Provide list of file ids"},{"name":"folderIds","in":"query","schemaId":"schema_57","description":"Provide list of folder ids"},{"name":"published","in":"query","schemaId":"schema_93","description":"If true, then only published inventory items are returned; if false, then only un-published inventory items are returned"},{"name":"limit","in":"query","schemaId":"schema_73","description":"Page Size. Number Of Records to fetch per page"},{"name":"offset","in":"query","schemaId":"schema_74","description":"Page Number. Index of the page to start with(starts from 1)"}],"pointer":"/paths/~1inventories~1search/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/inventories/search","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[{"name":"projectId","in":"query","required":true,"example":1,"schemaId":"schema_58"},{"name":"fileIds","in":"query","schemaId":"schema_57"},{"name":"folderIds","in":"query","schemaId":"schema_57"},{"name":"published","in":"query","schemaId":"schema_93"},{"name":"limit","in":"query","schemaId":"schema_73"},{"name":"offset","in":"query","schemaId":"schema_74"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/inventories/search","href":"inventory-api/getinventory","openApiOperationId":"getInventory","summary":"Get the inventories of file/folder ids"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Json"}},"schemaId":"components/schemas/Json"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1inventories~1search/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Json"}}},{"code":"400"},{"code":"401"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inventory-api/getinventory"}],"panels":[]}]},"httpPath":"/inventories/search"},{"label":"Get vulnerability analysis details of an inventory","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/inventory-api/getvulnerabilityanalysis","routeSlug":"/swagger/inventory-api/getvulnerabilityanalysis","metadata":{"seo":{"title":"Get vulnerability analysis details of an inventory","description":"Get vulnerability analysis details of an inventory."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getVulnerabilityAnalysis","name":"Get vulnerability analysis details of an inventory","isWebhook":false,"pointer":"/paths/~1inventories~1{inventoryId}~1vulnerabilities~1analysis/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get vulnerability analysis details of an inventory","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get vulnerability analysis details of an inventory."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"inventoryId","in":"path","schemaId":"schema_58","description":"ID of the Inventory","required":true,"example":1}],"pointer":"/paths/~1inventories~1{inventoryId}~1vulnerabilities~1analysis/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"vulnerabilityName","in":"query","schemaId":"schema_57","description":"Name of the vulnerability"},{"name":"analysisState","in":"query","schemaId":"schema_94","description":"Analysis State."},{"name":"limit","in":"query","schemaId":"schema_73","description":"Page Size. Number Of Records to fetch per page"},{"name":"offset","in":"query","schemaId":"schema_74","description":"Page Number. Index of the page to start with(starts from 1)"}],"pointer":"/paths/~1inventories~1{inventoryId}~1vulnerabilities~1analysis/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/inventories/{inventoryId}/vulnerabilities/analysis","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"inventoryId","in":"path","required":true,"example":1,"schemaId":"schema_58"}],"query":[{"name":"vulnerabilityName","in":"query","schemaId":"schema_57"},{"name":"analysisState","in":"query","schemaId":"schema_94"},{"name":"limit","in":"query","schemaId":"schema_73"},{"name":"offset","in":"query","schemaId":"schema_74"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500"],"pointer":"/inventories/{inventoryId}/vulnerabilities/analysis","href":"inventory-api/getvulnerabilityanalysis","openApiOperationId":"getVulnerabilityAnalysis","summary":"Get vulnerability analysis details of an inventory"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VulnerabilityAnalysisSuppressionModel"}},"schemaId":"components/schemas/VulnerabilityAnalysisSuppressionModel"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1inventories~1{inventoryId}~1vulnerabilities~1analysis/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/VulnerabilityAnalysisSuppressionModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VulnerabilityAnalysisSuppressionModel"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inventory-api/getvulnerabilityanalysis"}],"panels":[]}]},"httpPath":"/inventories/{inventoryId}/vulnerabilities/analysis"},{"label":"Get vulnerability details of an inventory","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/inventory-api/getvulnerabilties_1","routeSlug":"/swagger/inventory-api/getvulnerabilties_1","metadata":{"seo":{"title":"Get vulnerability details of an inventory","description":"Get vulnerability details of an inventory."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getVulnerabilties_1","name":"Get vulnerability details of an inventory","isWebhook":false,"pointer":"/paths/~1inventories~1{inventoryId}~1vulnerabilities/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get vulnerability details of an inventory","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get vulnerability details of an inventory."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"inventoryId","in":"path","schemaId":"schema_62","description":"ID of the Inventory","required":true,"example":1}],"pointer":"/paths/~1inventories~1{inventoryId}~1vulnerabilities/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_73","description":"Page Size. Number Of Records to fetch per page"},{"name":"offset","in":"query","schemaId":"schema_74","description":"Page Number. Index of the page to start with(starts from 1)"}],"pointer":"/paths/~1inventories~1{inventoryId}~1vulnerabilities/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/inventories/{inventoryId}/vulnerabilities","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"inventoryId","in":"path","required":true,"example":1,"schemaId":"schema_62"}],"query":[{"name":"limit","in":"query","schemaId":"schema_73"},{"name":"offset","in":"query","schemaId":"schema_74"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/inventories/{inventoryId}/vulnerabilities","href":"inventory-api/getvulnerabilties_1","openApiOperationId":"getVulnerabilties_1","summary":"Get vulnerability details of an inventory"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1inventories~1{inventoryId}~1vulnerabilities/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inventory-api/getvulnerabilties_1"}],"panels":[]}]},"httpPath":"/inventories/{inventoryId}/vulnerabilities"},{"label":"Update notices text","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/inventory-api/noticestextinventory","routeSlug":"/swagger/inventory-api/noticestextinventory","metadata":{"seo":{"title":"Update notices text","description":"Update notices text for the given inventory"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"noticesTextInventory","name":"Update notices text","isWebhook":false,"pointer":"/paths/~1inventories~1{inventoryId}~1notices/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update notices text","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update notices text for the given inventory"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"inventoryId","in":"path","schemaId":"schema_62","description":"ID of the Inventory","required":true,"example":1}],"pointer":"/paths/~1inventories~1{inventoryId}~1notices/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"overwrite","in":"query","schemaId":"schema_59","description":"If true, overwrite notices text"}],"pointer":"/paths/~1inventories~1{inventoryId}~1notices/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/inventories/{inventoryId}/notices","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"inventoryId","in":"path","required":true,"example":1,"schemaId":"schema_62"}],"query":[{"name":"overwrite","in":"query","schemaId":"schema_59"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/inventories/{inventoryId}/notices","href":"inventory-api/noticestextinventory","openApiOperationId":"noticesTextInventory","summary":"Update notices text"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1inventories~1{inventoryId}~1notices/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inventory-api/noticestextinventory"}],"panels":[]}]},"httpPath":"/inventories/{inventoryId}/notices"},{"label":"Publish Inventory","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/inventory-api/publishinventory","routeSlug":"/swagger/inventory-api/publishinventory","metadata":{"seo":{"title":"Publish Inventory","description":"Publish an inventory for a given inventoryId"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"publishInventory","name":"Publish Inventory","isWebhook":false,"pointer":"/paths/~1inventories~1{inventoryId}~1publish/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Publish Inventory","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Publish an inventory for a given inventoryId"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"inventoryId","in":"path","schemaId":"schema_62","description":"ID of the Inventory","required":true,"example":1}],"pointer":"/paths/~1inventories~1{inventoryId}~1publish/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/inventories/{inventoryId}/publish","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"inventoryId","in":"path","required":true,"example":1,"schemaId":"schema_62"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/inventories/{inventoryId}/publish","href":"inventory-api/publishinventory","openApiOperationId":"publishInventory","summary":"Publish Inventory"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}},"schemaId":"schema_57"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1inventories~1{inventoryId}~1publish/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_57","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}}},{"code":"400"},{"code":"401"},{"code":"404"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inventory-api/publishinventory"}],"panels":[]}]},"httpPath":"/inventories/{inventoryId}/publish"},{"label":"Recall Inventory","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/inventory-api/recallinventory","routeSlug":"/swagger/inventory-api/recallinventory","metadata":{"seo":{"title":"Recall Inventory","description":"Recall an inventory for a given inventoryId"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"recallInventory","name":"Recall Inventory","isWebhook":false,"pointer":"/paths/~1inventories~1{inventoryId}~1recall/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Recall Inventory","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Recall an inventory for a given inventoryId"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"inventoryId","in":"path","schemaId":"schema_62","description":"ID of the Inventory","required":true,"example":1}],"pointer":"/paths/~1inventories~1{inventoryId}~1recall/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/inventories/{inventoryId}/recall","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"inventoryId","in":"path","required":true,"example":1,"schemaId":"schema_62"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/inventories/{inventoryId}/recall","href":"inventory-api/recallinventory","openApiOperationId":"recallInventory","summary":"Recall Inventory"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}},"schemaId":"schema_57"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1inventories~1{inventoryId}~1recall/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_57","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}}},{"code":"400"},{"code":"401"},{"code":"404"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inventory-api/recallinventory"}],"panels":[]}]},"httpPath":"/inventories/{inventoryId}/recall"},{"label":"inventory status","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/inventory-api/updateinventorystatus","routeSlug":"/swagger/inventory-api/updateinventorystatus","metadata":{"seo":{"title":"inventory status","description":"update an inventory status with DRAFT, APPROVED and REJECTED status.The approve/reject inventory affects Manual Review task only. Any changes made to Inventory will not affect Remediation and Miscellaneous tasks. On Approving Inventory, Inventory gets Approved and Manual review task will be closed with Approve status. On Rejecting Inventory, Inventory gets Rejected by creating an open Remediation task and the Manual review task will be closed with Reject status."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateInventoryStatus","name":"inventory status","isWebhook":false,"pointer":"/paths/~1inventories~1{inventoryId}~1status/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"inventory status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"update an inventory status with DRAFT, APPROVED and REJECTED status.The approve/reject inventory affects Manual Review task only. Any changes made to Inventory will not affect Remediation and Miscellaneous tasks. On Approving Inventory, Inventory gets Approved and Manual review task will be closed with Approve status. On Rejecting Inventory, Inventory gets Rejected by creating an open Remediation task and the Manual review task will be closed with Reject status."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"inventoryId","in":"path","schemaId":"schema_62","description":"ID of the Inventory","required":true,"example":1}],"pointer":"/paths/~1inventories~1{inventoryId}~1status/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"status","in":"query","schemaId":"schema_95","required":true}],"pointer":"/paths/~1inventories~1{inventoryId}~1status/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/inventories/{inventoryId}/status","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"inventoryId","in":"path","required":true,"example":1,"schemaId":"schema_62"}],"query":[{"name":"status","in":"query","required":true,"schemaId":"schema_95"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/inventories/{inventoryId}/status","href":"inventory-api/updateinventorystatus","openApiOperationId":"updateInventoryStatus","summary":"inventory status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1inventories~1{inventoryId}~1status/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inventory-api/updateinventorystatus"}],"panels":[]}]},"httpPath":"/inventories/{inventoryId}/status"}],"content":{"contentType":"group","meta":{"name":"Inventory API"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Inventory API","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/inventories/{inventoryId}/files","summary":"Add Files and/or Folders to Inventory","prefix":{"name":"put","color":"put"},"badges":[],"link":"/inventory-api/addfilestoinventory","deprecated":false},{"title":"/inventories","summary":"Create Inventory","prefix":{"name":"post","color":"post"},"badges":[],"link":"/inventory-api/createinventory","deprecated":false},{"title":"/inventories/{inventoryId}","summary":"Get details of an inventory","prefix":{"name":"get","color":"get"},"badges":[],"link":"/inventory-api/getinventorybyid","deprecated":false},{"title":"/inventories/{inventoryId}","summary":"Update Inventory","prefix":{"name":"put","color":"put"},"badges":[],"link":"/inventory-api/updateinventory","deprecated":false},{"title":"/inventories/{inventoryId}","summary":"Delete the inventory","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/inventory-api/deleteinventory","deprecated":false},{"title":"/inventories/{inventoryId}/history","summary":"Get history of an inventory","prefix":{"name":"get","color":"get"},"badges":[],"link":"/inventory-api/fetchhistory","deprecated":false},{"title":"/inventories/{inventoryId}/children","summary":"Get children of an inventory","prefix":{"name":"get","color":"get"},"badges":[],"link":"/inventory-api/fetchinventorychildren","deprecated":false},{"title":"/inventories/{inventoryId}/parents","summary":"Get parents of an inventory","prefix":{"name":"get","color":"get"},"badges":[],"link":"/inventory-api/fetchinventoryparents","deprecated":false},{"title":"/inventories/searchByDate","summary":"Get All Inventories by Date","prefix":{"name":"get","color":"get"},"badges":[],"link":"/inventory-api/getallprojectinventoriesbydate","deprecated":false},{"title":"/inventories/search","summary":"Get the inventories of file/folder ids","prefix":{"name":"get","color":"get"},"badges":[],"link":"/inventory-api/getinventory","deprecated":false},{"title":"/inventories/{inventoryId}/vulnerabilities/analysis","summary":"Get vulnerability analysis details of an inventory","prefix":{"name":"get","color":"get"},"badges":[],"link":"/inventory-api/getvulnerabilityanalysis","deprecated":false},{"title":"/inventories/{inventoryId}/vulnerabilities","summary":"Get vulnerability details of an inventory","prefix":{"name":"get","color":"get"},"badges":[],"link":"/inventory-api/getvulnerabilties_1","deprecated":false},{"title":"/inventories/{inventoryId}/notices","summary":"Update notices text","prefix":{"name":"put","color":"put"},"badges":[],"link":"/inventory-api/noticestextinventory","deprecated":false},{"title":"/inventories/{inventoryId}/publish","summary":"Publish Inventory","prefix":{"name":"put","color":"put"},"badges":[],"link":"/inventory-api/publishinventory","deprecated":false},{"title":"/inventories/{inventoryId}/recall","summary":"Recall Inventory","prefix":{"name":"put","color":"put"},"badges":[],"link":"/inventory-api/recallinventory","deprecated":false},{"title":"/inventories/{inventoryId}/status","summary":"inventory status","prefix":{"name":"put","color":"put"},"badges":[],"link":"/inventory-api/updateinventorystatus","deprecated":false}]}]}]}]}},{"type":"group","label":"inventoryWorkflow","link":"/swagger/inventoryworkflow","routeSlug":"/swagger/inventoryworkflow","items":[{"label":"Get workflow details for an inventory","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/inventoryworkflow/getworkflowbyinventoryid","routeSlug":"/swagger/inventoryworkflow/getworkflowbyinventoryid","metadata":{"seo":{"title":"Get workflow details for an inventory","description":"Get workflow details for an inventory"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWorkflowByInventoryId","name":"Get workflow details for an inventory","isWebhook":false,"pointer":"/paths/~1inventories~1{inventoryId}~1workflows/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get workflow details for an inventory","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get workflow details for an inventory"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"inventoryId","in":"path","schemaId":"schema_62","description":"ID of the Inventory","required":true,"example":1}],"pointer":"/paths/~1inventories~1{inventoryId}~1workflows/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/inventories/{inventoryId}/workflows","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"inventoryId","in":"path","required":true,"example":1,"schemaId":"schema_62"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/inventories/{inventoryId}/workflows","href":"inventoryworkflow/getworkflowbyinventoryid","openApiOperationId":"getWorkflowByInventoryId","summary":"Get workflow details for an inventory"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1inventories~1{inventoryId}~1workflows/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inventoryworkflow/getworkflowbyinventoryid"}],"panels":[]}]},"httpPath":"/inventories/{inventoryId}/workflows"},{"label":"workflows","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/inventoryworkflow/createworkflow","routeSlug":"/swagger/inventoryworkflow/createworkflow","metadata":{"seo":{"title":"workflows","description":"Create or update workflow for an inventory"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createWorkflow","name":"workflows","isWebhook":false,"pointer":"/paths/~1inventories~1{inventoryId}~1workflows/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"workflows","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create or update workflow for an inventory"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"inventoryId","in":"path","schemaId":"schema_58","description":"ID of the Inventory","required":true,"example":1}],"pointer":"/paths/~1inventories~1{inventoryId}~1workflows/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_96"}},"schemaId":"schema_96","pointer":"/paths/~1inventories~1{inventoryId}~1workflows/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/inventories/{inventoryId}/workflows","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"inventoryId","in":"path","required":true,"example":1,"schemaId":"schema_58"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_96"}},"responseCodes":["201","400","404","500"],"pointer":"/inventories/{inventoryId}/workflows","href":"inventoryworkflow/createworkflow","openApiOperationId":"createWorkflow","summary":"workflows"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"schema_96","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_96"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created"},{"code":"400","description":"Bad Request"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1inventories~1{inventoryId}~1workflows/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inventoryworkflow/createworkflow"}],"panels":[]}]},"httpPath":"/inventories/{inventoryId}/workflows"}],"content":{"contentType":"group","meta":{"name":"inventoryWorkflow"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"inventoryWorkflow","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/inventories/{inventoryId}/workflows","summary":"Get workflow details for an inventory","prefix":{"name":"get","color":"get"},"badges":[],"link":"/inventoryworkflow/getworkflowbyinventoryid","deprecated":false},{"title":"/inventories/{inventoryId}/workflows","summary":"workflows","prefix":{"name":"post","color":"post"},"badges":[],"link":"/inventoryworkflow/createworkflow","deprecated":false}]}]}]}]}},{"type":"group","label":"Jobs","link":"/swagger/jobs","routeSlug":"/swagger/jobs","items":[{"label":"Export project inventory to SBOM Insights","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/jobs/addexporttosbominsightstask","routeSlug":"/swagger/jobs/addexporttosbominsightstask","metadata":{"seo":{"title":"Export project inventory to SBOM Insights","description":"Export project to SBOM Insights operation will be added to queue. To get status of Export to SBOM Insights use jobs/{jobId} API"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addExportToSBOMInsightsTask","name":"Export project inventory to SBOM Insights","isWebhook":false,"pointer":"/paths/~1jobs~1sbomexport~1{projectId}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Export project inventory to SBOM Insights","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Export project to SBOM Insights operation will be added to queue. To get status of Export to SBOM Insights use jobs/{jobId} API"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_58","description":"ID of the Project","required":true,"example":1}],"pointer":"/paths/~1jobs~1sbomexport~1{projectId}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/jobs/sbomexport/{projectId}","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":1,"schemaId":"schema_58"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["202","400","401","404","500","503"],"pointer":"/jobs/sbomexport/{projectId}","href":"jobs/addexporttosbominsightstask","openApiOperationId":"addExportToSBOMInsightsTask","summary":"Export project inventory to SBOM Insights"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"},{"code":"503","description":"Service Unavailable"}],"pointer":"/paths/~1jobs~1sbomexport~1{projectId}/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/jobs/addexporttosbominsightstask"}],"panels":[]}]},"httpPath":"/jobs/sbomexport/{projectId}"},{"label":"Update project notices","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/jobs/addupdatenoticestask","routeSlug":"/swagger/jobs/addupdatenoticestask","metadata":{"seo":{"title":"Update project notices","description":"Update notices operation will be added to queue. To get status of update notices use jobs/{jobId} API"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addUpdateNoticesTask","name":"Update project notices","isWebhook":false,"pointer":"/paths/~1jobs~1notices~1{projectId}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update project notices","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update notices operation will be added to queue. To get status of update notices use jobs/{jobId} API"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_58","description":"ID of the Project","required":true,"example":1}],"pointer":"/paths/~1jobs~1notices~1{projectId}/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"overwriteAll","in":"query","schemaId":"schema_59","description":"If true, overwrite all notices text, else update only empty notices texts"}],"pointer":"/paths/~1jobs~1notices~1{projectId}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/jobs/notices/{projectId}","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":1,"schemaId":"schema_58"}],"query":[{"name":"overwriteAll","in":"query","schemaId":"schema_59"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["202","400","401","404","500","503"],"pointer":"/jobs/notices/{projectId}","href":"jobs/addupdatenoticestask","openApiOperationId":"addUpdateNoticesTask","summary":"Update project notices"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"},{"code":"503","description":"Service Unavailable"}],"pointer":"/paths/~1jobs~1notices~1{projectId}/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/jobs/addupdatenoticestask"}],"panels":[]}]},"httpPath":"/jobs/notices/{projectId}"},{"label":"Get Job details based on the jobId provided","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/jobs/getjobdetails","routeSlug":"/swagger/jobs/getjobdetails","metadata":{"seo":{"title":"Get Job details based on the jobId provided","description":"Returns Job details for a given JobId which is obtained from /jobs/all"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getJobDetails","name":"Get Job details based on the jobId provided","isWebhook":false,"pointer":"/paths/~1jobs~1{jobId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Job details based on the jobId provided","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns Job details for a given JobId which is obtained from /jobs/all"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jobId","in":"path","schemaId":"schema_62","description":"ID of the Job","required":true,"example":1}],"pointer":"/paths/~1jobs~1{jobId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/jobs/{jobId}","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"jobId","in":"path","required":true,"example":1,"schemaId":"schema_62"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/jobs/{jobId}","href":"jobs/getjobdetails","openApiOperationId":"getJobDetails","summary":"Get Job details based on the jobId provided"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobModel"}},"schemaId":"components/schemas/JobModel"},{"code":"400","description":"Bad request"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1jobs~1{jobId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/JobModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobModel"}}},{"code":"400"},{"code":"404"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/jobs/getjobdetails"}],"panels":[]}]},"httpPath":"/jobs/{jobId}"},{"label":"Get jobs details based on filters","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/jobs/getjobs","routeSlug":"/swagger/jobs/getjobs","metadata":{"seo":{"title":"Get jobs details based on filters","description":"Returns jobs in descending order with pagination based on jobType, status, projectId, triggeredBy, jobsHistoryInDays"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getJobs","name":"Get jobs details based on filters","isWebhook":false,"pointer":"/paths/~1jobs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get jobs details based on filters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns jobs in descending order with pagination based on jobType, status, projectId, triggeredBy, jobsHistoryInDays"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"jobType","in":"query","schemaId":"schema_57","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required param for jobType: Project Branching|Project Copy|Project Scan|Project Re-Scan|PDL Update|Project Deletion|Export to SBOM Insights|Update Notices|Project Import|Project Export|Remote Scan|Apply Policy - Global|Apply Policy - Project|Report - Audit Report|Report - Notices Report|Report - Project Report|Report - <Custom Report Name>"},"children":[]}]}]}]},{"name":"status","in":"query","schemaId":"schema_97"},{"name":"projectId","in":"query","schemaId":"schema_98","description":"Id of the project (Example: 10)"},{"name":"triggeredBy","in":"query","schemaId":"schema_57","description":"Login Name of the user (Example: admin)"},{"name":"jobsHistoryInDays","in":"query","schemaId":"schema_99","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Days in number. Get jobs in days. (Default=0, All the jobs will be fetched with other filters)"},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_100","description":"Page Size. Number Of Records to fetch per page"},{"name":"offset","in":"query","schemaId":"schema_70","description":"Page Number. Index of the page to start with(starts from 1)"}],"pointer":"/paths/~1jobs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/jobs","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[{"name":"jobType","in":"query","schemaId":"schema_57"},{"name":"status","in":"query","schemaId":"schema_97"},{"name":"projectId","in":"query","schemaId":"schema_98"},{"name":"triggeredBy","in":"query","schemaId":"schema_57"},{"name":"jobsHistoryInDays","in":"query","schemaId":"schema_99"},{"name":"limit","in":"query","schemaId":"schema_100"},{"name":"offset","in":"query","schemaId":"schema_70"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/jobs","href":"jobs/getjobs","openApiOperationId":"getJobs","summary":"Get jobs details based on filters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad request"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1jobs/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/jobs/getjobs"}],"panels":[]}]},"httpPath":"/jobs"}],"content":{"contentType":"group","meta":{"name":"Jobs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Jobs","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/jobs/sbomexport/{projectId}","summary":"Export project inventory to SBOM Insights","prefix":{"name":"post","color":"post"},"badges":[],"link":"/jobs/addexporttosbominsightstask","deprecated":false},{"title":"/jobs/notices/{projectId}","summary":"Update project notices","prefix":{"name":"post","color":"post"},"badges":[],"link":"/jobs/addupdatenoticestask","deprecated":false},{"title":"/jobs/{jobId}","summary":"Get Job details based on the jobId provided","prefix":{"name":"get","color":"get"},"badges":[],"link":"/jobs/getjobdetails","deprecated":false},{"title":"/jobs","summary":"Get jobs details based on filters","prefix":{"name":"get","color":"get"},"badges":[],"link":"/jobs/getjobs","deprecated":false}]}]}]}]}},{"type":"group","label":"ldap","link":"/swagger/ldap","routeSlug":"/swagger/ldap","items":[{"label":"Trigger ldap sync","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/ldap/triggerldapsync","routeSlug":"/swagger/ldap/triggerldapsync","metadata":{"seo":{"title":"Trigger ldap sync","description":"Trigger on demand ldap sync if already configured.Only the system admin has the permission to do this operation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"triggerLdapSync","name":"Trigger ldap sync","isWebhook":false,"pointer":"/paths/~1ldap~1sync/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Trigger ldap sync","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Trigger on demand ldap sync if already configured.Only the system admin has the permission to do this operation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ldap/sync","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","403","500","501","503"],"pointer":"/ldap/sync","href":"ldap/triggerldapsync","openApiOperationId":"triggerLdapSync","summary":"Trigger ldap sync"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK : LDAP sync triggered successfully"},{"code":"403","description":"FORBIDDEN : User does not have permission to perform this operation,only system admin can perform this operation. Please check and try again"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INTERNAL_SERVER_ERROR : Failed to trigger LDAP sync. Please contact your administrator."},"children":[]}]}]}]},{"code":"501","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOT_IMPLEMENTED : Code Insight is not configured with LDAP. Please contact your administrator"},"children":[]}]}]}]},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SERVICE_UNAVAILABLE : LDAP sync is already in progress. Please wait for sync to finish"},"children":[]}]}]}]}],"pointer":"/paths/~1ldap~1sync/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ldap/triggerldapsync"}],"panels":[]}]},"httpPath":"/ldap/sync"},{"label":"Update LDAP password","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/ldap/updateldappassword","routeSlug":"/swagger/ldap/updateldappassword","metadata":{"seo":{"title":"Update LDAP password","description":"Update the LDAP password used for authentication and user synchronization. Only system administrators have permission to perform this operation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateLdapPassword","name":"Update LDAP password","isWebhook":false,"pointer":"/paths/~1ldap~1password/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update LDAP password","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update the LDAP password used for authentication and user synchronization. Only system administrators have permission to perform this operation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LdapPasswordUpdateRequest"}},"schemaId":"components/schemas/LdapPasswordUpdateRequest","pointer":"/paths/~1ldap~1password/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/ldap/password","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LdapPasswordUpdateRequest"}},"responseCodes":["200","400","403","500","501"],"pointer":"/ldap/password","href":"ldap/updateldappassword","openApiOperationId":"updateLdapPassword","summary":"Update LDAP password"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"components/schemas/LdapPasswordUpdateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LdapPasswordUpdateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK : LDAP password updated successfully"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BAD_REQUEST : Invalid password or connection test failed"},"children":[]}]}]}]},{"code":"403","description":"FORBIDDEN : User does not have permission to perform this operation, only system admin can perform this operation. Please check and try again"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INTERNAL_SERVER_ERROR : Failed to update LDAP password. Please contact your administrator."},"children":[]}]}]}]},{"code":"501","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOT_IMPLEMENTED : Code Insight is not configured with LDAP. Please contact your administrator"},"children":[]}]}]}]}],"pointer":"/paths/~1ldap~1password/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ldap/updateldappassword"}],"panels":[]}]},"httpPath":"/ldap/password"}],"content":{"contentType":"group","meta":{"name":"ldap"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ldap","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ldap/sync","summary":"Trigger ldap sync","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ldap/triggerldapsync","deprecated":false},{"title":"/ldap/password","summary":"Update LDAP password","prefix":{"name":"put","color":"put"},"badges":[],"link":"/ldap/updateldappassword","deprecated":false}]}]}]}]}},{"type":"group","label":"license","link":"/swagger/license","routeSlug":"/swagger/license","items":[{"label":"License Lookup","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/license/licenselookup","routeSlug":"/swagger/license/licenselookup","metadata":{"seo":{"title":"License Lookup","description":"Returns id, name, priority, url, description, text, shortName and spdxIdentifier for a given license ID or license Name."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"licenseLookup","name":"License Lookup","isWebhook":false,"pointer":"/paths/~1license~1lookup/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"License Lookup","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns  id, name, priority, url, description, text, shortName and spdxIdentifier for a given license ID or license Name."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"licenseId","in":"query","schemaId":"schema_62","description":"ID of the license (Example: 1)"},{"name":"licenseName","in":"query","schemaId":"schema_57","description":"Full name of the license (Example: Apache License 1.1)"}],"pointer":"/paths/~1license~1lookup/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/license/lookup","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[{"name":"licenseId","in":"query","schemaId":"schema_62"},{"name":"licenseName","in":"query","schemaId":"schema_57"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/license/lookup","href":"license/licenselookup","openApiOperationId":"licenseLookup","summary":"License Lookup"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}},"schemaId":"schema_57"},{"code":"400","description":"Bad request"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1license~1lookup/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_57","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}}},{"code":"400"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/license/licenselookup"}],"panels":[]}]},"httpPath":"/license/lookup"},{"label":"Create a custom license","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/license/createlicenses","routeSlug":"/swagger/license/createlicenses","metadata":{"seo":{"title":"Create a custom license","description":"Creates a custom license"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createLicenses","name":"Create a custom license","isWebhook":false,"pointer":"/paths/~1licenses/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a custom license","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a custom license"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LicenseModel"}},"schemaId":"components/schemas/LicenseModel","pointer":"/paths/~1licenses/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create a custom license the name, shortName and licenseText is required."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only users with Library Manager permission can create custom licenses."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allowable values for familyName(Optional) are:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GNU LGPL 2.1 Style | Artistic License 1.0 Style | Proprietary Style | BSD 3-Clause Style |"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Apache 1.1 Style | CPL 1.0 Style | MIT Style | Public Domain Style | MPL 1.1 Style | MPL 1.0 Style | Academic Free License Style | Apache 2.0 Style | Sleepycat Style | EPL 1.0 Style | CDDL 1.0 Style | Commercial Style | GNU GPL 3 Style |"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GNU LGPL 2.0 Style | GNU LGPL 3.0 Style | GNU AGPL 3.0 Style | Ambiguous License Style | GNU GPL 2 Style | Artistic License 2.0 Style | BSD 2-Clause Style | GNU GPL 2 w/CPE Style | CDDL 1.1 Style | Apache 1.0 Style | BSD 4-Clause Style | GNU GPL 2+ Style |"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GNU GPL 3+ Style | GNU LGPL 2.1+ Style | GNU LGPL 3.0+ Style | GNU LGPL 2.0+ Style | MirOS Style | zlib Style | GNU GPL Style | GNU LGPL Style | GNU AGPL 3.0+ Style"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/licenses","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LicenseModel"}},"responseCodes":["201","400","500"],"pointer":"/licenses","href":"license/createlicenses","openApiOperationId":"createLicenses","summary":"Create a custom license"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"components/schemas/LicenseModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LicenseModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created"},{"code":"400","description":"Bad Request"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1licenses/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/license/createlicenses"}],"panels":[]}]},"httpPath":"/licenses"},{"label":"Edit Custom License","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/license/editcustomlicense","routeSlug":"/swagger/license/editcustomlicense","metadata":{"seo":{"title":"Edit Custom License","description":"Only users with Library Manager permission can edit a custom license."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"editCustomLicense","name":"Edit Custom License","isWebhook":false,"pointer":"/paths/~1licenses~1{licenseId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Edit Custom License","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Only users with Library Manager permission can edit a custom license."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"licenseId","in":"path","schemaId":"schema_62","description":"ID of License","required":true,"example":1}],"pointer":"/paths/~1licenses~1{licenseId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LicenseModel"}},"schemaId":"components/schemas/LicenseModel","pointer":"/paths/~1licenses~1{licenseId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/licenses/{licenseId}","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"licenseId","in":"path","required":true,"example":1,"schemaId":"schema_62"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LicenseModel"}},"responseCodes":["200","400","401","404","500"],"pointer":"/licenses/{licenseId}","href":"license/editcustomlicense","openApiOperationId":"editCustomLicense","summary":"Edit Custom License"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"components/schemas/LicenseModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LicenseModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1licenses~1{licenseId}/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/license/editcustomlicense"}],"panels":[]}]},"httpPath":"/licenses/{licenseId}"},{"label":"Delete a custom license","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/license/deletecustomlicense","routeSlug":"/swagger/license/deletecustomlicense","metadata":{"seo":{"title":"Delete a custom license","description":"Delete a custom license using the license ID. All existing inventory that uses this license will have its license changed to Unknown. You must have the Library Manager permission to delete a custom license."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCustomLicense","name":"Delete a custom license","isWebhook":false,"pointer":"/paths/~1licenses~1{licenseId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a custom license","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a custom license using the license ID. All existing inventory that uses this license will have its license changed to Unknown. You must have the Library Manager permission to delete a custom license."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"licenseId","in":"path","schemaId":"schema_62","description":"ID of the License","required":true,"example":1}],"pointer":"/paths/~1licenses~1{licenseId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/licenses/{licenseId}","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"licenseId","in":"path","required":true,"example":1,"schemaId":"schema_62"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/licenses/{licenseId}","href":"license/deletecustomlicense","openApiOperationId":"deleteCustomLicense","summary":"Delete a custom license"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1licenses~1{licenseId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/license/deletecustomlicense"}],"panels":[]}]},"httpPath":"/licenses/{licenseId}"},{"label":"Update Licenses External Id","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/license/updatelicenseexternalid","routeSlug":"/swagger/license/updatelicenseexternalid","metadata":{"seo":{"title":"Update Licenses External Id","description":"Update Licenses External Id. Only users with Library Manager permission can update the External Id of a license. The licenseId should be a valid license id and the externalId should not exceed 255 characters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateLicenseExternalId","name":"Update Licenses External Id","isWebhook":false,"pointer":"/paths/~1licenses~1{licenseId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Licenses External Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update Licenses External Id. \nOnly users with Library Manager permission can update the External Id of a license. \nThe licenseId should be a valid license id and the externalId should not exceed 255 characters."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"licenseId","in":"path","schemaId":"schema_62","description":"ID of the license","required":true,"example":1}],"pointer":"/paths/~1licenses~1{licenseId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LicenseUpdateModel"}},"schemaId":"components/schemas/LicenseUpdateModel","pointer":"/paths/~1licenses~1{licenseId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/licenses/{licenseId}","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"licenseId","in":"path","required":true,"example":1,"schemaId":"schema_62"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LicenseUpdateModel"}},"responseCodes":["200","400","404","500"],"pointer":"/licenses/{licenseId}","href":"license/updatelicenseexternalid","openApiOperationId":"updateLicenseExternalId","summary":"Update Licenses External Id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"components/schemas/LicenseUpdateModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LicenseUpdateModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1licenses~1{licenseId}/patch/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/license/updatelicenseexternalid"}],"panels":[]}]},"httpPath":"/licenses/{licenseId}"},{"label":"Get All Licenses","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/license/getalllicenses","routeSlug":"/swagger/license/getalllicenses","metadata":{"seo":{"title":"Get All Licenses","description":"Returns all license details. If onlyCustom is true, returns only custom licenses. Supports pagination with page and size parameters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllLicenses","name":"Get All Licenses","isWebhook":false,"pointer":"/paths/~1licenses~1listAll/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get All Licenses","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns all license details. If onlyCustom is true, returns only custom licenses. Supports pagination with page and size parameters."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"onlyCustom","in":"query","schemaId":"schema_59","description":"If true, returns only custom licenses","example":false},{"name":"page","in":"query","schemaId":"schema_61","description":"Page Number. Index of the page to start with(starts from 1)"},{"name":"size","in":"query","schemaId":"schema_101","description":"Page Size. Number Of Records to fetch per page"}],"pointer":"/paths/~1licenses~1listAll/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/licenses/listAll","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[{"name":"onlyCustom","in":"query","example":false,"schemaId":"schema_59"},{"name":"page","in":"query","schemaId":"schema_61"},{"name":"size","in":"query","schemaId":"schema_101"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/licenses/listAll","href":"license/getalllicenses","openApiOperationId":"getAllLicenses","summary":"Get All Licenses"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1licenses~1listAll/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/license/getalllicenses"}],"panels":[]}]},"httpPath":"/licenses/listAll"},{"label":"License lookup based on short name","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/license/licenselookupshortname","routeSlug":"/swagger/license/licenselookupshortname","metadata":{"seo":{"title":"License lookup based on short name","description":"Returns id, name, priority, url, description, text and spdxIdentifier for a given shortName."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"licenseLookupShortName","name":"License lookup based on short name","isWebhook":false,"pointer":"/paths/~1licenses~1{shortName}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"License lookup based on short name","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns  id, name, priority, url, description, text and spdxIdentifier for a given shortName."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"shortName","in":"path","schemaId":"schema_57","description":"Short name of the license","required":true}],"pointer":"/paths/~1licenses~1{shortName}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/licenses/{shortName}","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"shortName","in":"path","required":true,"schemaId":"schema_57"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/licenses/{shortName}","href":"license/licenselookupshortname","openApiOperationId":"licenseLookupShortName","summary":"License lookup based on short name"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1licenses~1{shortName}/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/license/licenselookupshortname"}],"panels":[]}]},"httpPath":"/licenses/{shortName}"}],"content":{"contentType":"group","meta":{"name":"license"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"license","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/license/lookup","summary":"License Lookup","prefix":{"name":"get","color":"get"},"badges":[],"link":"/license/licenselookup","deprecated":false},{"title":"/licenses","summary":"Create a custom license","prefix":{"name":"post","color":"post"},"badges":[],"link":"/license/createlicenses","deprecated":false},{"title":"/licenses/{licenseId}","summary":"Edit Custom License","prefix":{"name":"put","color":"put"},"badges":[],"link":"/license/editcustomlicense","deprecated":false},{"title":"/licenses/{licenseId}","summary":"Delete a custom license","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/license/deletecustomlicense","deprecated":false},{"title":"/licenses/{licenseId}","summary":"Update Licenses External Id","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/license/updatelicenseexternalid","deprecated":false},{"title":"/licenses/listAll","summary":"Get All Licenses","prefix":{"name":"get","color":"get"},"badges":[],"link":"/license/getalllicenses","deprecated":false},{"title":"/licenses/{shortName}","summary":"License lookup based on short name","prefix":{"name":"get","color":"get"},"badges":[],"link":"/license/licenselookupshortname","deprecated":false}]}]}]}]}},{"type":"group","label":"sourceCodeManagement","link":"/swagger/sourcecodemanagement","routeSlug":"/swagger/sourcecodemanagement","items":[{"label":"Perforce scmInstances","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/sourcecodemanagement/updateperforcescminstance","routeSlug":"/swagger/sourcecodemanagement/updateperforcescminstance","metadata":{"seo":{"title":"Perforce scmInstances","description":"Updates an instance of Perforce SCM."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatePerforceSCMInstance","name":"Perforce scmInstances","isWebhook":false,"pointer":"/paths/~1scmInstances~1Perforce/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Perforce scmInstances","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an instance of Perforce SCM."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"projectId","in":"query","schemaId":"schema_63","description":"ID of the project","required":true,"example":1},{"name":"instanceId","in":"query","schemaId":"schema_102","description":"ID of the SCM instance","required":true,"example":0}],"pointer":"/paths/~1scmInstances~1Perforce/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PerforceSCMModel"}},"schemaId":"components/schemas/PerforceSCMModel","pointer":"/paths/~1scmInstances~1Perforce/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/scmInstances/Perforce","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[{"name":"projectId","in":"query","required":true,"example":1,"schemaId":"schema_63"},{"name":"instanceId","in":"query","required":true,"example":0,"schemaId":"schema_102"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PerforceSCMModel"}},"responseCodes":["200","400","401","404","500"],"pointer":"/scmInstances/Perforce","href":"sourcecodemanagement/updateperforcescminstance","openApiOperationId":"updatePerforceSCMInstance","summary":"Perforce scmInstances"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"components/schemas/PerforceSCMModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PerforceSCMModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1scmInstances~1Perforce/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sourcecodemanagement/updateperforcescminstance"}],"panels":[]}]},"httpPath":"/scmInstances/Perforce"},{"label":"Perforce scmInstances","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/sourcecodemanagement/createperforcescminstance","routeSlug":"/swagger/sourcecodemanagement/createperforcescminstance","metadata":{"seo":{"title":"Perforce scmInstances","description":"Create a new instance of Perforce SCM.url - URL in the format: <protocol>:<host>:<port>/<depot>,or else configured P4PORT will be taken a default url.userName/password - userName/password or else configured P4USER/P4PASSWD will be taken a default.branchSpec - branchSpec(<Depot>/<ProjectPath>)changeListNum/label - changeListNum/label Or leave blank to sync to the head revision."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPerforceSCMInstance","name":"Perforce scmInstances","isWebhook":false,"pointer":"/paths/~1scmInstances~1Perforce/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Perforce scmInstances","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a new instance of Perforce SCM."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"url"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - URL in the format: <protocol>:<host>:<port>/<depot>,or else configured P4PORT will be taken a default url."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"userName/password"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - userName/password or else configured P4USER/P4PASSWD will be taken a default."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"branchSpec"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - branchSpec(<Depot>/<ProjectPath>)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"changeListNum/label"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - changeListNum/label Or leave blank to sync to the head revision."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"projectId","in":"query","schemaId":"schema_63","description":"ID of the project","required":true,"example":1}],"pointer":"/paths/~1scmInstances~1Perforce/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PerforceSCMModel"}},"schemaId":"components/schemas/PerforceSCMModel","pointer":"/paths/~1scmInstances~1Perforce/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/scmInstances/Perforce","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[{"name":"projectId","in":"query","required":true,"example":1,"schemaId":"schema_63"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PerforceSCMModel"}},"responseCodes":["201","400","401","404","500"],"pointer":"/scmInstances/Perforce","href":"sourcecodemanagement/createperforcescminstance","openApiOperationId":"createPerforceSCMInstance","summary":"Perforce scmInstances"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"components/schemas/PerforceSCMModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PerforceSCMModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1scmInstances~1Perforce/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sourcecodemanagement/createperforcescminstance"}],"panels":[]}]},"httpPath":"/scmInstances/Perforce"},{"label":"Git scmInstances","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/sourcecodemanagement/updategitscminstance","routeSlug":"/swagger/sourcecodemanagement/updategitscminstance","metadata":{"seo":{"title":"Git scmInstances","description":"Updates an instance of Git SCM.url* - Enter one repository URL and branch/ tag/ commit ID in individual fields or one or more repository URLs separated by comma.You can include a branch, tag, or commit ID notation as part of the URL.userName/password - userName/password for authenticated access to the repository. Leave blank for anonymous or SSH access.branch/commitId/tag - branch, tag or commit ID. Specify one of these values. Or leave blank to sync to the master branch.These three fields will be considered only when single URL is provided without branch/ tag/ commit ID properties in the URL.includeSubmodules - (Optional, Boolean, default: true) Controls whether submodules are included during sync.expansionLevel - (Optional, Integer, default: 1, values: 1/2/3) Control archive extraction depth: 1=None (no extraction), 2=Top-level archives only, 3=Recursive (nested archives).deleteArchiveAfterExpand - (Optional, Boolean, default: false) Delete archive files after extraction to save disk space. Note: This field is only applicable when expansionLevel is 2 or 3.archiveDirSuffix - (Optional, String, max: 20 chars) Suffix to be added to the expanded folder. Value cannot be more than 20 characters and cannot contain the following special characters: \\ / : * ? \" < > | \\0 (Example: _Expanded). Note: This field is only applicable when expansionLevel is 2 or 3."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateGITSCMInstance","name":"Git scmInstances","isWebhook":false,"pointer":"/paths/~1scmInstances~1Git/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Git scmInstances","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates an instance of Git SCM."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"url"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"* - Enter one repository URL and branch/ tag/ commit ID in individual fields or one or more repository URLs separated by comma."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can include a branch, tag, or commit ID notation as part of the URL."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"userName/password"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - userName/password for authenticated access to the repository. Leave blank for anonymous or SSH access."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"branch/commitId/tag"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - branch, tag or commit ID. Specify one of these values. Or leave blank to sync to the master branch."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These three fields will be considered only when single URL is provided without branch/ tag/ commit ID properties in the URL."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"includeSubmodules"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - (Optional, Boolean, default: true) Controls whether submodules are included during sync."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"expansionLevel"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - (Optional, Integer, default: 1, values: 1/2/3) Control archive extraction depth: 1=None (no extraction), 2=Top-level archives only, 3=Recursive (nested archives)."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"deleteArchiveAfterExpand"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - (Optional, Boolean, default: false) Delete archive files after extraction to save disk space. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: This field is only applicable when expansionLevel is 2 or 3."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"archiveDirSuffix"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - (Optional, String, max: 20 chars) Suffix to be added to the expanded folder. Value cannot be more than 20 characters and cannot contain the following special characters: \\ / : * ? \" < > | \\0 (Example: _Expanded). "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: This field is only applicable when expansionLevel is 2 or 3."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"projectId","in":"query","schemaId":"schema_63","description":"ID of the project","required":true,"example":1},{"name":"instanceId","in":"query","schemaId":"schema_102","description":"ID of the SCM instance","required":true,"example":0}],"pointer":"/paths/~1scmInstances~1Git/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GITSCMModel"}},"schemaId":"components/schemas/GITSCMModel","pointer":"/paths/~1scmInstances~1Git/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/scmInstances/Git","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[{"name":"projectId","in":"query","required":true,"example":1,"schemaId":"schema_63"},{"name":"instanceId","in":"query","required":true,"example":0,"schemaId":"schema_102"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GITSCMModel"}},"responseCodes":["200","400","401","404","500"],"pointer":"/scmInstances/Git","href":"sourcecodemanagement/updategitscminstance","openApiOperationId":"updateGITSCMInstance","summary":"Git scmInstances"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"components/schemas/GITSCMModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GITSCMModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1scmInstances~1Git/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sourcecodemanagement/updategitscminstance"}],"panels":[]}]},"httpPath":"/scmInstances/Git"},{"label":"Git scmInstances","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/sourcecodemanagement/creategitscminstance","routeSlug":"/swagger/sourcecodemanagement/creategitscminstance","metadata":{"seo":{"title":"Git scmInstances","description":"Create a new instance of Git SCM.url* - Enter one repository URL and branch/ tag/ commit ID in individual fields or one or more repository URLs separated by comma.You can include a branch, tag, or commit ID notation as part of the URL.userName/password - userName/password for authenticated access to the repository. Leave blank for anonymous or SSH access.branch/commitId/tag - branch, tag or commit ID. Specify one of these values. Or leave blank to sync to the master branch.These three fields will be considered only when single URL is provided without branch/ tag/ commit ID properties in the URL.includeSubmodules - (Optional, Boolean, default: true) Controls whether submodules are included during sync.expansionLevel - (Optional, Integer, default: 1, values: 1/2/3) Control archive extraction depth: 1=None (no extraction), 2=Top-level archives only, 3=Recursive (nested archives).deleteArchiveAfterExpand - (Optional, Boolean, default: false) Delete archive files after extraction to save disk space. Note: This field is only applicable when expansionLevel is 2 or 3.archiveDirSuffix - (Optional, String, max: 20 chars) Suffix to be added to the expanded folder. Value cannot be more than 20 characters and cannot contain the following special characters: \\ / : * ? \" < > | \\0 (Example: _Expanded). Note: This field is only applicable when expansionLevel is 2 or 3."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createGITSCMInstance","name":"Git scmInstances","isWebhook":false,"pointer":"/paths/~1scmInstances~1Git/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Git scmInstances","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a new instance of Git SCM."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"url"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"* - Enter one repository URL and branch/ tag/ commit ID in individual fields or one or more repository URLs separated by comma."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can include a branch, tag, or commit ID notation as part of the URL."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"userName/password"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - userName/password for authenticated access to the repository. Leave blank for anonymous or SSH access."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"branch/commitId/tag"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - branch, tag or commit ID. Specify one of these values. Or leave blank to sync to the master branch."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These three fields will be considered only when single URL is provided without branch/ tag/ commit ID properties in the URL."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"includeSubmodules"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - (Optional, Boolean, default: true) Controls whether submodules are included during sync."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"expansionLevel"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - (Optional, Integer, default: 1, values: 1/2/3) Control archive extraction depth: 1=None (no extraction), 2=Top-level archives only, 3=Recursive (nested archives)."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"deleteArchiveAfterExpand"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - (Optional, Boolean, default: false) Delete archive files after extraction to save disk space. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: This field is only applicable when expansionLevel is 2 or 3."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"archiveDirSuffix"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - (Optional, String, max: 20 chars) Suffix to be added to the expanded folder. Value cannot be more than 20 characters and cannot contain the following special characters: \\ / : * ? \" < > | \\0 (Example: _Expanded). "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: This field is only applicable when expansionLevel is 2 or 3."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"projectId","in":"query","schemaId":"schema_63","description":"ID of the project","required":true,"example":1}],"pointer":"/paths/~1scmInstances~1Git/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GITSCMModel"}},"schemaId":"components/schemas/GITSCMModel","pointer":"/paths/~1scmInstances~1Git/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/scmInstances/Git","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[{"name":"projectId","in":"query","required":true,"example":1,"schemaId":"schema_63"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GITSCMModel"}},"responseCodes":["201","400","401","404","500"],"pointer":"/scmInstances/Git","href":"sourcecodemanagement/creategitscminstance","openApiOperationId":"createGITSCMInstance","summary":"Git scmInstances"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"components/schemas/GITSCMModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GITSCMModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1scmInstances~1Git/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sourcecodemanagement/creategitscminstance"}],"panels":[]}]},"httpPath":"/scmInstances/Git"},{"label":"scmInstances","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/sourcecodemanagement/getscminstance","routeSlug":"/swagger/sourcecodemanagement/getscminstance","metadata":{"seo":{"title":"scmInstances","description":"Fetch details of scm instances of a project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSCMInstance","name":"scmInstances","isWebhook":false,"pointer":"/paths/~1scmInstances/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"scmInstances","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetch details of scm instances of a project."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"projectId","in":"query","schemaId":"schema_63","description":"ID of the project","required":true,"example":1},{"name":"scmType","in":"query","schemaId":"schema_103"},{"name":"instanceId","in":"query","schemaId":"schema_102","description":"ID of the SCM instance"}],"pointer":"/paths/~1scmInstances/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/scmInstances","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[{"name":"projectId","in":"query","required":true,"example":1,"schemaId":"schema_63"},{"name":"scmType","in":"query","schemaId":"schema_103"},{"name":"instanceId","in":"query","schemaId":"schema_102"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/scmInstances","href":"sourcecodemanagement/getscminstance","openApiOperationId":"getSCMInstance","summary":"scmInstances"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SCMModel"}},"schemaId":"components/schemas/SCMModel"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1scmInstances/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SCMModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SCMModel"}}},{"code":"400"},{"code":"401"},{"code":"404"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sourcecodemanagement/getscminstance"}],"panels":[]}]},"httpPath":"/scmInstances"},{"label":"scmInstances","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/sourcecodemanagement/testscminstanceconnection","routeSlug":"/swagger/sourcecodemanagement/testscminstanceconnection","metadata":{"seo":{"title":"scmInstances","description":"Test connection api for scm instances"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"testSCMInstanceConnection","name":"scmInstances","isWebhook":false,"pointer":"/paths/~1scmInstances/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"scmInstances","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Test connection api for scm instances"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"projectId","in":"query","schemaId":"schema_63","description":"ID of the project","required":true,"example":1},{"name":"scmType","in":"query","schemaId":"schema_104","required":true},{"name":"instanceId","in":"query","schemaId":"schema_102","description":"ID of the SCM instance","required":true,"example":0}],"pointer":"/paths/~1scmInstances/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/scmInstances","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[{"name":"projectId","in":"query","required":true,"example":1,"schemaId":"schema_63"},{"name":"scmType","in":"query","required":true,"schemaId":"schema_104"},{"name":"instanceId","in":"query","required":true,"example":0,"schemaId":"schema_102"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/scmInstances","href":"sourcecodemanagement/testscminstanceconnection","openApiOperationId":"testSCMInstanceConnection","summary":"scmInstances"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1scmInstances/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sourcecodemanagement/testscminstanceconnection"}],"panels":[]}]},"httpPath":"/scmInstances"},{"label":"scmInstances","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/sourcecodemanagement/deletescminstance","routeSlug":"/swagger/sourcecodemanagement/deletescminstance","metadata":{"seo":{"title":"scmInstances","description":"Deletes an instance of a particular SCMType."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteSCMInstance","name":"scmInstances","isWebhook":false,"pointer":"/paths/~1scmInstances/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"scmInstances","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes an instance of a particular SCMType."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"projectId","in":"query","schemaId":"schema_63","description":"ID of the project","required":true,"example":1},{"name":"scmType","in":"query","schemaId":"schema_104","required":true},{"name":"instanceId","in":"query","schemaId":"schema_102","description":"ID of the SCM instance","required":true,"example":0}],"pointer":"/paths/~1scmInstances/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/scmInstances","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[{"name":"projectId","in":"query","required":true,"example":1,"schemaId":"schema_63"},{"name":"scmType","in":"query","required":true,"schemaId":"schema_104"},{"name":"instanceId","in":"query","required":true,"example":0,"schemaId":"schema_102"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/scmInstances","href":"sourcecodemanagement/deletescminstance","openApiOperationId":"deleteSCMInstance","summary":"scmInstances"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1scmInstances/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sourcecodemanagement/deletescminstance"}],"panels":[]}]},"httpPath":"/scmInstances"},{"label":"Subversion scmInstances","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/sourcecodemanagement/updatesvnscminstance","routeSlug":"/swagger/sourcecodemanagement/updatesvnscminstance","metadata":{"seo":{"title":"Subversion scmInstances","description":"Updates an instance of Subversion SCM."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateSVNSCMInstance","name":"Subversion scmInstances","isWebhook":false,"pointer":"/paths/~1scmInstances~1Subversion/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subversion scmInstances","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an instance of Subversion SCM."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"projectId","in":"query","schemaId":"schema_63","description":"ID of the project","required":true,"example":1},{"name":"instanceId","in":"query","schemaId":"schema_102","description":"ID of the SCM instance","required":true,"example":0}],"pointer":"/paths/~1scmInstances~1Subversion/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubversionSCMModel"}},"schemaId":"components/schemas/SubversionSCMModel","pointer":"/paths/~1scmInstances~1Subversion/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/scmInstances/Subversion","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[{"name":"projectId","in":"query","required":true,"example":1,"schemaId":"schema_63"},{"name":"instanceId","in":"query","required":true,"example":0,"schemaId":"schema_102"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SubversionSCMModel"}},"responseCodes":["200","400","401","404","500"],"pointer":"/scmInstances/Subversion","href":"sourcecodemanagement/updatesvnscminstance","openApiOperationId":"updateSVNSCMInstance","summary":"Subversion scmInstances"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"components/schemas/SubversionSCMModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubversionSCMModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1scmInstances~1Subversion/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sourcecodemanagement/updatesvnscminstance"}],"panels":[]}]},"httpPath":"/scmInstances/Subversion"},{"label":"Subversion scmInstances","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/sourcecodemanagement/createsvnscminstance","routeSlug":"/swagger/sourcecodemanagement/createsvnscminstance","metadata":{"seo":{"title":"Subversion scmInstances","description":"Create a new instance of Subversion SCM.url* - URL in the format: <protocol>://<host>/<svnroot>/<repository>userName/password - userName/password or leave blank for anonymous connectionrevisionNumber - revision for which you want to create workspace and run scan on the same."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createSVNSCMInstance","name":"Subversion scmInstances","isWebhook":false,"pointer":"/paths/~1scmInstances~1Subversion/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subversion scmInstances","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a new instance of Subversion SCM."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"url"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"* - URL in the format: <protocol>://<host>/<svnroot>/<repository>"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"userName/password"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - userName/password or leave blank for anonymous connection"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"revisionNumber"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - revision for which you want to create workspace and run scan on the same."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"projectId","in":"query","schemaId":"schema_63","description":"ID of the project","required":true,"example":1}],"pointer":"/paths/~1scmInstances~1Subversion/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubversionSCMModel"}},"schemaId":"components/schemas/SubversionSCMModel","pointer":"/paths/~1scmInstances~1Subversion/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/scmInstances/Subversion","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[{"name":"projectId","in":"query","required":true,"example":1,"schemaId":"schema_63"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SubversionSCMModel"}},"responseCodes":["201","400","401","404","500"],"pointer":"/scmInstances/Subversion","href":"sourcecodemanagement/createsvnscminstance","openApiOperationId":"createSVNSCMInstance","summary":"Subversion scmInstances"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"components/schemas/SubversionSCMModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubversionSCMModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1scmInstances~1Subversion/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sourcecodemanagement/createsvnscminstance"}],"panels":[]}]},"httpPath":"/scmInstances/Subversion"},{"label":"TFS scmInstances","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/sourcecodemanagement/updatetfsscminstance","routeSlug":"/swagger/sourcecodemanagement/updatetfsscminstance","metadata":{"seo":{"title":"TFS scmInstances","description":"Updates an instance of TFS SCM."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateTFSSCMInstance","name":"TFS scmInstances","isWebhook":false,"pointer":"/paths/~1scmInstances~1TFS/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"TFS scmInstances","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an instance of TFS SCM."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"projectId","in":"query","schemaId":"schema_63","description":"ID of the project","required":true,"example":1},{"name":"instanceId","in":"query","schemaId":"schema_102","description":"ID of the SCM instance","required":true,"example":0}],"pointer":"/paths/~1scmInstances~1TFS/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TFSSCMModel"}},"schemaId":"components/schemas/TFSSCMModel","pointer":"/paths/~1scmInstances~1TFS/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/scmInstances/TFS","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[{"name":"projectId","in":"query","required":true,"example":1,"schemaId":"schema_63"},{"name":"instanceId","in":"query","required":true,"example":0,"schemaId":"schema_102"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TFSSCMModel"}},"responseCodes":["200","400","401","404","500"],"pointer":"/scmInstances/TFS","href":"sourcecodemanagement/updatetfsscminstance","openApiOperationId":"updateTFSSCMInstance","summary":"TFS scmInstances"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"components/schemas/TFSSCMModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TFSSCMModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1scmInstances~1TFS/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sourcecodemanagement/updatetfsscminstance"}],"panels":[]}]},"httpPath":"/scmInstances/TFS"},{"label":"TFS scmInstances","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/sourcecodemanagement/createtfsscminstance","routeSlug":"/swagger/sourcecodemanagement/createtfsscminstance","metadata":{"seo":{"title":"TFS scmInstances","description":"Create a new instance of TFS SCM.url* - URL in the below format:<protocol>:<host>:<port>/<tfsroot>/<collection>/<project>URL format for TFS 2016 and above:<protocol>:<host>:<port>/<collection>/<project>userName/password* - userName/password for authenticationchangeSet - changeset you wish to sync.If Changeset is not provided, latest revision will be synced unless Label is specified.label - Label you wish to sync. If Label is not provided, latest revision will be synced unless changeset is specified."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createTFSSCMInstance","name":"TFS scmInstances","isWebhook":false,"pointer":"/paths/~1scmInstances~1TFS/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"TFS scmInstances","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a new instance of TFS SCM."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"url"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"* - URL in the below format:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"<protocol>:<host>:<port>/<tfsroot>/<collection>/<project>"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL format for TFS 2016 and above:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"<protocol>:<host>:<port>/<collection>/<project>"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"userName/password"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"* - userName/password for authentication"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"changeSet"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - changeset you wish to sync.If Changeset is not provided, latest revision will be synced unless Label is specified."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"label"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Label you wish to sync. If Label is not provided, latest revision will be synced unless changeset is specified."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"projectId","in":"query","schemaId":"schema_63","description":"ID of the project","required":true,"example":1}],"pointer":"/paths/~1scmInstances~1TFS/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TFSSCMModel"}},"schemaId":"components/schemas/TFSSCMModel","pointer":"/paths/~1scmInstances~1TFS/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/scmInstances/TFS","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[{"name":"projectId","in":"query","required":true,"example":1,"schemaId":"schema_63"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TFSSCMModel"}},"responseCodes":["201","400","401","404","500"],"pointer":"/scmInstances/TFS","href":"sourcecodemanagement/createtfsscminstance","openApiOperationId":"createTFSSCMInstance","summary":"TFS scmInstances"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"components/schemas/TFSSCMModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TFSSCMModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1scmInstances~1TFS/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sourcecodemanagement/createtfsscminstance"}],"panels":[]}]},"httpPath":"/scmInstances/TFS"}],"content":{"contentType":"group","meta":{"name":"sourceCodeManagement"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"sourceCodeManagement","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/scmInstances/Perforce","summary":"Perforce scmInstances","prefix":{"name":"put","color":"put"},"badges":[],"link":"/sourcecodemanagement/updateperforcescminstance","deprecated":false},{"title":"/scmInstances/Perforce","summary":"Perforce scmInstances","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sourcecodemanagement/createperforcescminstance","deprecated":false},{"title":"/scmInstances/Git","summary":"Git scmInstances","prefix":{"name":"put","color":"put"},"badges":[],"link":"/sourcecodemanagement/updategitscminstance","deprecated":false},{"title":"/scmInstances/Git","summary":"Git scmInstances","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sourcecodemanagement/creategitscminstance","deprecated":false},{"title":"/scmInstances","summary":"scmInstances","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sourcecodemanagement/getscminstance","deprecated":false},{"title":"/scmInstances","summary":"scmInstances","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sourcecodemanagement/testscminstanceconnection","deprecated":false},{"title":"/scmInstances","summary":"scmInstances","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/sourcecodemanagement/deletescminstance","deprecated":false},{"title":"/scmInstances/Subversion","summary":"Subversion scmInstances","prefix":{"name":"put","color":"put"},"badges":[],"link":"/sourcecodemanagement/updatesvnscminstance","deprecated":false},{"title":"/scmInstances/Subversion","summary":"Subversion scmInstances","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sourcecodemanagement/createsvnscminstance","deprecated":false},{"title":"/scmInstances/TFS","summary":"TFS scmInstances","prefix":{"name":"put","color":"put"},"badges":[],"link":"/sourcecodemanagement/updatetfsscminstance","deprecated":false},{"title":"/scmInstances/TFS","summary":"TFS scmInstances","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sourcecodemanagement/createtfsscminstance","deprecated":false}]}]}]}]}},{"type":"group","label":"Policy API","link":"/swagger/policy-api","routeSlug":"/swagger/policy-api","items":[{"label":"Bulk Import Policy Licenses","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/policy-api/bulkimportlicenses","routeSlug":"/swagger/policy-api/bulkimportlicenses","metadata":{"seo":{"title":"Bulk Import Policy Licenses","description":"Imports multiple policy license rules from a CSV file into the specified policy profile."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bulkImportLicenses","name":"Bulk Import Policy Licenses","isWebhook":false,"pointer":"/paths/~1policies~1{policyId}~1bulkImport/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bulk Import Policy Licenses","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Imports multiple policy license rules from a CSV file into the specified policy profile."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CSV Format Requirements:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required Headers: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"License Short Name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Distribution Type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Linking"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Modified"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Action"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All rows are validated before applying any changes (atomic operation)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upsert semantics: updates existing combinations, adds new ones, preserves unmatched existing rows"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid Values:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Distribution Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Any, Internal, External, Hosted-Any, Hosted for External Use, Hosted for Internal Use"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Linking"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Any, Statically Linked, Dynamically Linked, Not Linked"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Modified"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Any, Yes, No"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Action"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Approve, Reject, No Action"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CSV Example:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"License Short Name,Distribution Type,Linking,Modified,Action\nApache-2.0,Any,Any,Any,Approve\nGPL-3.0,External,Dynamically Linked,No,Reject\nMIT,Internal,Any,Any,Approve\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"License Short Name,Distribution Type,Linking,Modified,Action\nApache-2.0,Any,Any,Any,Approve\nGPL-3.0,External,Dynamically Linked,No,Reject\nMIT,Internal,Any,Any,Approve\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication:"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires a valid JWT Bearer token with Policy Administrator permission."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Try it out is not available for this API."},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test using curl or Postman:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -H \"Authorization: Bearer {JWT_TOKEN}\" \\\n     -F file=@licenses.csv \\\n     http://localhost:8888/codeinsight/api/policies/{policyId}/bulkImport\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -H \"Authorization: Bearer {JWT_TOKEN}\" \\\n     -F file=@licenses.csv \\\n     http://localhost:8888/codeinsight/api/policies/{policyId}/bulkImport\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation Rules:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All license short names must exist in the reference data"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duplicate combinations within the CSV are rejected"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Empty rows are skipped"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If ANY validation error exists, NO changes are applied"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Details:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success: Returns count of imported/updated rules"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure: Returns detailed row-level validation errors"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"policyId","in":"path","schemaId":"schema_63","description":"ID of the policy profile to import licenses into","required":true,"example":1}],"pointer":"/paths/~1policies~1{policyId}~1bulkImport/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_105"}},"schemaId":"schema_105","pointer":"/paths/~1policies~1{policyId}~1bulkImport/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/policies/{policyId}/bulkImport","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"policyId","in":"path","required":true,"example":1,"schemaId":"schema_63"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_105"}},"responseCodes":["200","400","401","403","404","500"],"pointer":"/policies/{policyId}/bulkImport","href":"policy-api/bulkimportlicenses","openApiOperationId":"bulkImportLicenses","summary":"Bulk Import Policy Licenses"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"schema_105","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_105"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Import successful or validation errors returned","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PolicyLicenseImportResponse"}},"schemaId":"components/schemas/PolicyLicenseImportResponse"},{"code":"400","description":"Bad Request - Invalid file format or missing file"},{"code":"401","description":"Unauthorized - Invalid or missing JWT token"},{"code":"403","description":"Forbidden - User lacks Policy Administrator permission"},{"code":"404","description":"Not Found - Policy profile does not exist"},{"code":"500","description":"Internal Server Error - Unexpected server error"}],"pointer":"/paths/~1policies~1{policyId}~1bulkImport/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PolicyLicenseImportResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PolicyLicenseImportResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/policy-api/bulkimportlicenses"}],"panels":[]}]},"httpPath":"/policies/{policyId}/bulkImport"}],"content":{"contentType":"group","meta":{"name":"Policy API"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Policy API","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/policies/{policyId}/bulkImport","summary":"Bulk Import Policy Licenses","prefix":{"name":"post","color":"post"},"badges":[],"link":"/policy-api/bulkimportlicenses","deprecated":false}]}]}]}]}},{"type":"group","label":"Reports","link":"/swagger/reports","routeSlug":"/swagger/reports","items":[{"label":"Get Reports","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/reports/searchreports","routeSlug":"/swagger/reports/searchreports","metadata":{"seo":{"title":"Get Reports","description":"Get existing reports"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchReports","name":"Get Reports","isWebhook":false,"pointer":"/paths/~1reports/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Reports","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get existing reports"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"reportId","in":"query","schemaId":"schema_63","description":"ID of the Report to be used in search","example":1},{"name":"offset","in":"query","schemaId":"schema_76","description":"Index of the page to start with"},{"name":"limit","in":"query","schemaId":"schema_77","description":"Number Of Records to fetch"},{"name":"name","in":"query","schemaId":"schema_57","description":"Name of the Report to be used in search"},{"name":"path","in":"query","schemaId":"schema_57","description":"Path of the Script to be used in search"},{"name":"enabled","in":"query","schemaId":"schema_93","description":"Enabled status of the Report to be used in search"},{"name":"default","in":"query","schemaId":"schema_93","description":"Default status of the Report to be used in search"},{"name":"order","in":"query","schemaId":"schema_62","description":"Order of the Report to be used in search (Example: 1)"}],"pointer":"/paths/~1reports/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/reports","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[{"name":"reportId","in":"query","example":1,"schemaId":"schema_63"},{"name":"offset","in":"query","schemaId":"schema_76"},{"name":"limit","in":"query","schemaId":"schema_77"},{"name":"name","in":"query","schemaId":"schema_57"},{"name":"path","in":"query","schemaId":"schema_57"},{"name":"enabled","in":"query","schemaId":"schema_93"},{"name":"default","in":"query","schemaId":"schema_93"},{"name":"order","in":"query","schemaId":"schema_62"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/reports","href":"reports/searchreports","openApiOperationId":"searchReports","summary":"Get Reports"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1reports/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reports/searchreports"}],"panels":[]}]},"httpPath":"/reports"},{"label":"Update Report","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/reports/updatereport","routeSlug":"/swagger/reports/updatereport","metadata":{"seo":{"title":"Update Report","description":"Update existing report"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateReport","name":"Update Report","isWebhook":false,"pointer":"/paths/~1reports/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update existing report"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExtendedReportModel"}},"schemaId":"components/schemas/ExtendedReportModel","pointer":"/paths/~1reports/put/requestBody","description":"Update existing report."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/reports","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ExtendedReportModel"}},"responseCodes":["200","400","401","404","500"],"pointer":"/reports","href":"reports/updatereport","openApiOperationId":"updateReport","summary":"Update Report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"components/schemas/ExtendedReportModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExtendedReportModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1reports/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reports/updatereport"}],"panels":[]}]},"httpPath":"/reports"},{"label":"Create Report","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/reports/createreport","routeSlug":"/swagger/reports/createreport","metadata":{"seo":{"title":"Create Report","description":"Add new report. All the report options, if given will have datatype as String/text."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createReport","name":"Create Report","isWebhook":false,"pointer":"/paths/~1reports/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Add new report. All the report options, if given will have datatype as String/text."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReportModel"}},"schemaId":"components/schemas/ReportModel","pointer":"/paths/~1reports/post/requestBody","description":"Add new report."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/reports","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ReportModel"}},"responseCodes":["201","400","401","500"],"pointer":"/reports","href":"reports/createreport","openApiOperationId":"createReport","summary":"Create Report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"components/schemas/ReportModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReportModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1reports/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reports/createreport"}],"panels":[]}]},"httpPath":"/reports"},{"label":"Get Report By Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/reports/getreport","routeSlug":"/swagger/reports/getreport","metadata":{"seo":{"title":"Get Report By Id","description":"Get existing report by reportId"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getReport","name":"Get Report By Id","isWebhook":false,"pointer":"/paths/~1reports~1{reportId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Report By Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get existing report by reportId"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"reportId","in":"path","schemaId":"schema_64","required":true}],"pointer":"/paths/~1reports~1{reportId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/reports/{reportId}","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"reportId","in":"path","required":true,"schemaId":"schema_64"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/reports/{reportId}","href":"reports/getreport","openApiOperationId":"getReport","summary":"Get Report By Id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1reports~1{reportId}/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reports/getreport"}],"panels":[]}]},"httpPath":"/reports/{reportId}"},{"label":"Delete Report by Id","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/reports/deletereport","routeSlug":"/swagger/reports/deletereport","metadata":{"seo":{"title":"Delete Report by Id","description":"Delete the report by report id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteReport","name":"Delete Report by Id","isWebhook":false,"pointer":"/paths/~1reports~1{reportId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Report by Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete the report by report id"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"reportId","in":"path","schemaId":"schema_106","required":true}],"pointer":"/paths/~1reports~1{reportId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/reports/{reportId}","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"reportId","in":"path","required":true,"schemaId":"schema_106"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/reports/{reportId}","href":"reports/deletereport","openApiOperationId":"deleteReport","summary":"Delete Report by Id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1reports~1{reportId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reports/deletereport"}],"panels":[]}]},"httpPath":"/reports/{reportId}"}],"content":{"contentType":"group","meta":{"name":"Reports"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reports","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/reports","summary":"Get Reports","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reports/searchreports","deprecated":false},{"title":"/reports","summary":"Update Report","prefix":{"name":"put","color":"put"},"badges":[],"link":"/reports/updatereport","deprecated":false},{"title":"/reports","summary":"Create Report","prefix":{"name":"post","color":"post"},"badges":[],"link":"/reports/createreport","deprecated":false},{"title":"/reports/{reportId}","summary":"Get Report By Id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reports/getreport","deprecated":false},{"title":"/reports/{reportId}","summary":"Delete Report by Id","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/reports/deletereport","deprecated":false}]}]}]}]}},{"type":"group","label":"Rules","link":"/swagger/rules","routeSlug":"/swagger/rules","items":[{"label":"Get Rules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/rules/getrules","routeSlug":"/swagger/rules/getrules","metadata":{"seo":{"title":"Get Rules","description":"Get existing custom rules"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRules","name":"Get Rules","isWebhook":false,"pointer":"/paths/~1rules/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Rules","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get existing custom rules"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_76","description":"Index of the page to start with"},{"name":"limit","in":"query","schemaId":"schema_77","description":"Number Of Records to fetch"}],"pointer":"/paths/~1rules/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/rules","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[{"name":"offset","in":"query","schemaId":"schema_76"},{"name":"limit","in":"query","schemaId":"schema_77"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/rules","href":"rules/getrules","openApiOperationId":"getRules","summary":"Get Rules"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1rules/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rules/getrules"}],"panels":[]}]},"httpPath":"/rules"},{"label":"Update Rule","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/rules/updaterule","routeSlug":"/swagger/rules/updaterule","metadata":{"seo":{"title":"Update Rule","description":"Update existing rule."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateRule","name":"Update Rule","isWebhook":false,"pointer":"/paths/~1rules/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Rule","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update existing rule."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Value for detectionCriteria is an array of string Eg. detectionCriteria: [\"filepath1 or folderpath1\",\"filepath2 or folderpath2\"]."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameters fileInfo and ruleInfo are mutually exclusive."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only users with Library Manager role can update rules."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExtendedRuleModel"}},"schemaId":"components/schemas/ExtendedRuleModel","pointer":"/paths/~1rules/put/requestBody","description":"Update existing rule."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/rules","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ExtendedRuleModel"}},"responseCodes":["200","400","401","500"],"pointer":"/rules","href":"rules/updaterule","openApiOperationId":"updateRule","summary":"Update Rule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"components/schemas/ExtendedRuleModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExtendedRuleModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1rules/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rules/updaterule"}],"panels":[]}]},"httpPath":"/rules"},{"label":"Create Rule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/rules/createrule","routeSlug":"/swagger/rules/createrule","metadata":{"seo":{"title":"Create Rule","description":"Add new rule with either file info or rule info."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createRule","name":"Create Rule","isWebhook":false,"pointer":"/paths/~1rules/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Rule","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add new rule with either file info or rule info."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Value for detectionCriteria is an array of string Eg. detectionCriteria: [\"filepath1 or folderpath1\",\"filepath2 or folderpath2\"]."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameters fileInfo and ruleInfo are mutually exclusive."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only users with Library Manager role can create rules."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RuleModel"}},"schemaId":"components/schemas/RuleModel","pointer":"/paths/~1rules/post/requestBody","description":"Add new rule."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/rules","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RuleModel"}},"responseCodes":["201","400","401","500"],"pointer":"/rules","href":"rules/createrule","openApiOperationId":"createRule","summary":"Create Rule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"components/schemas/RuleModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RuleModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1rules/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rules/createrule"}],"panels":[]}]},"httpPath":"/rules"},{"label":"Get Rule By Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/rules/getrule","routeSlug":"/swagger/rules/getrule","metadata":{"seo":{"title":"Get Rule By Id","description":"Get existing rule by ruleId"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRule","name":"Get Rule By Id","isWebhook":false,"pointer":"/paths/~1rules~1{ruleId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Rule By Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get existing rule by ruleId"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ruleId","in":"path","schemaId":"schema_62","required":true}],"pointer":"/paths/~1rules~1{ruleId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/rules/{ruleId}","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"ruleId","in":"path","required":true,"schemaId":"schema_62"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/rules/{ruleId}","href":"rules/getrule","openApiOperationId":"getRule","summary":"Get Rule By Id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1rules~1{ruleId}/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rules/getrule"}],"panels":[]}]},"httpPath":"/rules/{ruleId}"},{"label":"Delete Rule","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/rules/deleterule","routeSlug":"/swagger/rules/deleterule","metadata":{"seo":{"title":"Delete Rule","description":"Delete existing rule. Only users with Library Manager role can delete rules."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteRule","name":"Delete Rule","isWebhook":false,"pointer":"/paths/~1rules~1{ruleId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Rule","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete existing rule. \n Only users with Library Manager role can delete rules."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ruleId","in":"path","schemaId":"schema_62","required":true}],"pointer":"/paths/~1rules~1{ruleId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/rules/{ruleId}","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"ruleId","in":"path","required":true,"schemaId":"schema_62"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/rules/{ruleId}","href":"rules/deleterule","openApiOperationId":"deleteRule","summary":"Delete Rule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1rules~1{ruleId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rules/deleterule"}],"panels":[]}]},"httpPath":"/rules/{ruleId}"},{"label":"Disable Rules","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/rules/disablerules","routeSlug":"/swagger/rules/disablerules","metadata":{"seo":{"title":"Disable Rules","description":"Disable multiple rules by their IDs. Disabled rules will not be applied during project scanning. Only users with Library Manager role can disable rules."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"disableRules","name":"Disable Rules","isWebhook":false,"pointer":"/paths/~1rules~1disable/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Disable Rules","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Disable multiple rules by their IDs. Disabled rules will not be applied during project scanning. Only users with Library Manager role can disable rules."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_107"}},"schemaId":"schema_107","pointer":"/paths/~1rules~1disable/put/requestBody","description":"List of rule IDs to disable"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/rules/disable","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_107"}},"responseCodes":["200","400","401","403","500"],"pointer":"/rules/disable","href":"rules/disablerules","openApiOperationId":"disableRules","summary":"Disable Rules"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"schema_107","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_107"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Rules disabled successfully"},{"code":"400","description":"Bad Request - Rule IDs cannot be empty"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden - Insufficient permissions"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1rules~1disable/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rules/disablerules"}],"panels":[]}]},"httpPath":"/rules/disable"},{"label":"Enable Rules","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/rules/enablerules","routeSlug":"/swagger/rules/enablerules","metadata":{"seo":{"title":"Enable Rules","description":"Enable multiple rules. Enabled rules will be applied during project scanning. Only users with Library Manager role can enable rules."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"enableRules","name":"Enable Rules","isWebhook":false,"pointer":"/paths/~1rules~1enable/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Enable Rules","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Enable multiple rules. Enabled rules will be applied during project scanning. Only users with Library Manager role can enable rules."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_107"}},"schemaId":"schema_107","pointer":"/paths/~1rules~1enable/put/requestBody","description":"List of rules ids to enable"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/rules/enable","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_107"}},"responseCodes":["200","400","401","403","500"],"pointer":"/rules/enable","href":"rules/enablerules","openApiOperationId":"enableRules","summary":"Enable Rules"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"schema_107","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_107"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Rules enabled successfully"},{"code":"400","description":"Bad Request - Rule data cannot be empty or invalid"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden - Insufficient permissions"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1rules~1enable/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rules/enablerules"}],"panels":[]}]},"httpPath":"/rules/enable"}],"content":{"contentType":"group","meta":{"name":"Rules"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Rules","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/rules","summary":"Get Rules","prefix":{"name":"get","color":"get"},"badges":[],"link":"/rules/getrules","deprecated":false},{"title":"/rules","summary":"Update Rule","prefix":{"name":"put","color":"put"},"badges":[],"link":"/rules/updaterule","deprecated":false},{"title":"/rules","summary":"Create Rule","prefix":{"name":"post","color":"post"},"badges":[],"link":"/rules/createrule","deprecated":false},{"title":"/rules/{ruleId}","summary":"Get Rule By Id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/rules/getrule","deprecated":false},{"title":"/rules/{ruleId}","summary":"Delete Rule","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/rules/deleterule","deprecated":false},{"title":"/rules/disable","summary":"Disable Rules","prefix":{"name":"put","color":"put"},"badges":[],"link":"/rules/disablerules","deprecated":false},{"title":"/rules/enable","summary":"Enable Rules","prefix":{"name":"put","color":"put"},"badges":[],"link":"/rules/enablerules","deprecated":false}]}]}]}]}},{"type":"group","label":"Scan profiles","link":"/swagger/scan-profiles","routeSlug":"/swagger/scan-profiles","items":[{"label":"Get DependencyScopes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/scan-profiles/getdependencyscopes","routeSlug":"/swagger/scan-profiles/getdependencyscopes","metadata":{"seo":{"title":"Get DependencyScopes","description":"Get DependencyScopes"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDependencyScopes","name":"Get DependencyScopes","isWebhook":false,"pointer":"/paths/~1profiles~1dependencyScope/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get DependencyScopes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get DependencyScopes"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/profiles/dependencyScope","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/profiles/dependencyScope","href":"scan-profiles/getdependencyscopes","openApiOperationId":"getDependencyScopes","summary":"Get DependencyScopes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1profiles~1dependencyScope/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scan-profiles/getdependencyscopes"}],"panels":[]}]},"httpPath":"/profiles/dependencyScope"},{"label":"Get profiles for project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/scan-profiles/getscanprofile","routeSlug":"/swagger/scan-profiles/getscanprofile","metadata":{"seo":{"title":"Get profiles for project","description":"Get profiles for project"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getScanProfile","name":"Get profiles for project","isWebhook":false,"pointer":"/paths/~1profiles~1{projectId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get profiles for project","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get profiles for project"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_75","required":true}],"pointer":"/paths/~1profiles~1{projectId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/profiles/{projectId}","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_75"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/profiles/{projectId}","href":"scan-profiles/getscanprofile","openApiOperationId":"getScanProfile","summary":"Get profiles for project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1profiles~1{projectId}/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scan-profiles/getscanprofile"}],"panels":[]}]},"httpPath":"/profiles/{projectId}"}],"content":{"contentType":"group","meta":{"name":"Scan profiles"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Scan profiles","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/profiles/dependencyScope","summary":"Get DependencyScopes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/scan-profiles/getdependencyscopes","deprecated":false},{"title":"/profiles/{projectId}","summary":"Get profiles for project","prefix":{"name":"get","color":"get"},"badges":[],"link":"/scan-profiles/getscanprofile","deprecated":false}]}]}]}]}},{"type":"group","label":"Task","link":"/swagger/task","routeSlug":"/swagger/task","items":[{"label":"Get Task Comments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/task/gettaskcomments","routeSlug":"/swagger/task/gettaskcomments","metadata":{"seo":{"title":"Get Task Comments","description":"Retrieve all comments for a specific task"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTaskComments","name":"Get Task Comments","isWebhook":false,"pointer":"/paths/~1tasks~1{taskId}~1comments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Task Comments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve all comments for a specific task"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"taskId","in":"path","schemaId":"schema_63","description":"ID of the task","required":true,"example":1}],"pointer":"/paths/~1tasks~1{taskId}~1comments/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_76","description":"Index of the page to start with"},{"name":"limit","in":"query","schemaId":"schema_108","description":"Number of records to fetch"}],"pointer":"/paths/~1tasks~1{taskId}~1comments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/tasks/{taskId}/comments","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"taskId","in":"path","required":true,"example":1,"schemaId":"schema_63"}],"query":[{"name":"offset","in":"query","schemaId":"schema_76"},{"name":"limit","in":"query","schemaId":"schema_108"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500"],"pointer":"/tasks/{taskId}/comments","href":"task/gettaskcomments","openApiOperationId":"getTaskComments","summary":"Get Task Comments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1tasks~1{taskId}~1comments/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/task/gettaskcomments"}],"panels":[]}]},"httpPath":"/tasks/{taskId}/comments"},{"label":"Add Task Comment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/task/addtaskcomment","routeSlug":"/swagger/task/addtaskcomment","metadata":{"seo":{"title":"Add Task Comment","description":"Add a new comment to a task"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addTaskComment","name":"Add Task Comment","isWebhook":false,"pointer":"/paths/~1tasks~1{taskId}~1comments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add Task Comment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Add a new comment to a task"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"taskId","in":"path","schemaId":"schema_63","description":"ID of the task","required":true,"example":1}],"pointer":"/paths/~1tasks~1{taskId}~1comments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TaskCommentModel"}},"schemaId":"components/schemas/TaskCommentModel","pointer":"/paths/~1tasks~1{taskId}~1comments/post/requestBody","description":"Comment to add"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/tasks/{taskId}/comments","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"taskId","in":"path","required":true,"example":1,"schemaId":"schema_63"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TaskCommentModel"}},"responseCodes":["201","400","401","403","404","500"],"pointer":"/tasks/{taskId}/comments","href":"task/addtaskcomment","openApiOperationId":"addTaskComment","summary":"Add Task Comment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"components/schemas/TaskCommentModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TaskCommentModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1tasks~1{taskId}~1comments/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/task/addtaskcomment"}],"panels":[]}]},"httpPath":"/tasks/{taskId}/comments"},{"label":"Assign Alm Issues","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/task/assignalmissuestotask","routeSlug":"/swagger/task/assignalmissuestotask","metadata":{"seo":{"title":"Assign Alm Issues","description":"Assign Alm Issues to task"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"assignAlmIssuesToTask","name":"Assign Alm Issues","isWebhook":false,"pointer":"/paths/~1tasks~1{taskId}~1issues/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Assign Alm Issues","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Assign Alm Issues to task"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"taskId","in":"path","schemaId":"schema_63","description":"ID of the task to be updated","required":true,"example":1}],"pointer":"/paths/~1tasks~1{taskId}~1issues/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AlmIssues"}},"schemaId":"components/schemas/AlmIssues","pointer":"/paths/~1tasks~1{taskId}~1issues/post/requestBody","description":"Map alm Issues to workflow task"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/tasks/{taskId}/issues","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"taskId","in":"path","required":true,"example":1,"schemaId":"schema_63"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AlmIssues"}},"responseCodes":["200","400","401","404","500"],"pointer":"/tasks/{taskId}/issues","href":"task/assignalmissuestotask","openApiOperationId":"assignAlmIssuesToTask","summary":"Assign Alm Issues"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"components/schemas/AlmIssues","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AlmIssues"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1tasks~1{taskId}~1issues/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/task/assignalmissuestotask"}],"panels":[]}]},"httpPath":"/tasks/{taskId}/issues"},{"label":"Close Task","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/task/closetask","routeSlug":"/swagger/task/closetask","metadata":{"seo":{"title":"Close Task","description":"Close Task"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"closeTask","name":"Close Task","isWebhook":false,"pointer":"/paths/~1tasks~1{taskId}~1close/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Close Task","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Close Task"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"taskId","in":"path","schemaId":"schema_63","description":"ID of the task to be closed","required":true,"example":1}],"pointer":"/paths/~1tasks~1{taskId}~1close/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"resolution","in":"query","schemaId":"schema_109","required":true},{"name":"comment","in":"query","schemaId":"schema_57","description":"Optional comment (max 1000 characters)"}],"pointer":"/paths/~1tasks~1{taskId}~1close/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/tasks/{taskId}/close","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"taskId","in":"path","required":true,"example":1,"schemaId":"schema_63"}],"query":[{"name":"resolution","in":"query","required":true,"schemaId":"schema_109"},{"name":"comment","in":"query","schemaId":"schema_57"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/tasks/{taskId}/close","href":"task/closetask","openApiOperationId":"closeTask","summary":"Close Task"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1tasks~1{taskId}~1close/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/task/closetask"}],"panels":[]}]},"httpPath":"/tasks/{taskId}/close"},{"label":"Create Task","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/task/createtask","routeSlug":"/swagger/task/createtask","metadata":{"seo":{"title":"Create Task","description":"Create Task"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createTask","name":"Create Task","isWebhook":false,"pointer":"/paths/~1tasks/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Task","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create Task"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"inventoryId","in":"query","schemaId":"schema_63","description":"ID of the inventory to be used to create the task","required":true,"example":1}],"pointer":"/paths/~1tasks/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WorkflowTaskModel"}},"schemaId":"components/schemas/WorkflowTaskModel","pointer":"/paths/~1tasks/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create new workflow task \t"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"priority"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" :\"LOW, MEDIUM, HIGH\""},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" : \"MISCELLANEOUS, MANUAL_INVENTORY_REVIEW, REMEDIATE_INVENTORY\""},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/tasks","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[{"name":"inventoryId","in":"query","required":true,"example":1,"schemaId":"schema_63"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WorkflowTaskModel"}},"responseCodes":["201","400","401","500"],"pointer":"/tasks","href":"task/createtask","openApiOperationId":"createTask","summary":"Create Task"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"components/schemas/WorkflowTaskModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WorkflowTaskModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1tasks/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/task/createtask"}],"panels":[]}]},"httpPath":"/tasks"},{"label":"Get Task","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/task/gettask","routeSlug":"/swagger/task/gettask","metadata":{"seo":{"title":"Get Task","description":"Get Task"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTask","name":"Get Task","isWebhook":false,"pointer":"/paths/~1tasks~1{taskId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Task","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get Task"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"taskId","in":"path","schemaId":"schema_63","description":"ID of the task to be fetched","required":true,"example":1}],"pointer":"/paths/~1tasks~1{taskId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/tasks/{taskId}","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"taskId","in":"path","required":true,"example":1,"schemaId":"schema_63"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/tasks/{taskId}","href":"task/gettask","openApiOperationId":"getTask","summary":"Get Task"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1tasks~1{taskId}/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/task/gettask"}],"panels":[]}]},"httpPath":"/tasks/{taskId}"},{"label":"Update Task","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/task/updatetask","routeSlug":"/swagger/task/updatetask","metadata":{"seo":{"title":"Update Task","description":"Update Task"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateTask","name":"Update Task","isWebhook":false,"pointer":"/paths/~1tasks~1{taskId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Task","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update Task"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"taskId","in":"path","schemaId":"schema_63","description":"ID of the task to be updated","required":true,"example":1}],"pointer":"/paths/~1tasks~1{taskId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExtendedWorkflowTaskModel"}},"schemaId":"components/schemas/ExtendedWorkflowTaskModel","pointer":"/paths/~1tasks~1{taskId}/put/requestBody","description":"Update existing workflow task \t\n priority :\"LOW, MEDIUM, HIGH\""}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/tasks/{taskId}","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"taskId","in":"path","required":true,"example":1,"schemaId":"schema_63"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ExtendedWorkflowTaskModel"}},"responseCodes":["200","400","401","404","500"],"pointer":"/tasks/{taskId}","href":"task/updatetask","openApiOperationId":"updateTask","summary":"Update Task"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"components/schemas/ExtendedWorkflowTaskModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExtendedWorkflowTaskModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1tasks~1{taskId}/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/task/updatetask"}],"panels":[]}]},"httpPath":"/tasks/{taskId}"},{"label":"Reassign Task","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/task/reassigntask","routeSlug":"/swagger/task/reassigntask","metadata":{"seo":{"title":"Reassign Task","description":"Reassign Task"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"reassignTask","name":"Reassign Task","isWebhook":false,"pointer":"/paths/~1tasks~1{taskId}~1reassign/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reassign Task","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Reassign Task"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"taskId","in":"path","schemaId":"schema_63","description":"ID of the task to be reassigned","required":true,"example":1}],"pointer":"/paths/~1tasks~1{taskId}~1reassign/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"ownerId","in":"query","schemaId":"schema_57","description":"ID / Name of the owner to whom the task needs to be reassigned (Example: admin)","required":true},{"name":"comment","in":"query","schemaId":"schema_57","description":"Optional comment (max 1000 characters)"}],"pointer":"/paths/~1tasks~1{taskId}~1reassign/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/tasks/{taskId}/reassign","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"taskId","in":"path","required":true,"example":1,"schemaId":"schema_63"}],"query":[{"name":"ownerId","in":"query","required":true,"schemaId":"schema_57"},{"name":"comment","in":"query","schemaId":"schema_57"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/tasks/{taskId}/reassign","href":"task/reassigntask","openApiOperationId":"reassignTask","summary":"Reassign Task"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1tasks~1{taskId}~1reassign/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/task/reassigntask"}],"panels":[]}]},"httpPath":"/tasks/{taskId}/reassign"},{"label":"Reopen Task","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/task/reopentask","routeSlug":"/swagger/task/reopentask","metadata":{"seo":{"title":"Reopen Task","description":"Reopen a closed task"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"reopenTask","name":"Reopen Task","isWebhook":false,"pointer":"/paths/~1tasks~1{taskId}~1reopen/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reopen Task","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Reopen a closed task"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"taskId","in":"path","schemaId":"schema_63","description":"ID of the task to be reopened","required":true,"example":1}],"pointer":"/paths/~1tasks~1{taskId}~1reopen/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"comment","in":"query","schemaId":"schema_57","description":"Optional comment (max 1000 characters)"}],"pointer":"/paths/~1tasks~1{taskId}~1reopen/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/tasks/{taskId}/reopen","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"taskId","in":"path","required":true,"example":1,"schemaId":"schema_63"}],"query":[{"name":"comment","in":"query","schemaId":"schema_57"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/tasks/{taskId}/reopen","href":"task/reopentask","openApiOperationId":"reopenTask","summary":"Reopen Task"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1tasks~1{taskId}~1reopen/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/task/reopentask"}],"panels":[]}]},"httpPath":"/tasks/{taskId}/reopen"},{"label":"Get Tasks based on the search Terms","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/task/searchtask","routeSlug":"/swagger/task/searchtask","metadata":{"seo":{"title":"Get Tasks based on the search Terms","description":"Return Tasks associated with the search term"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchTask","name":"Get Tasks based on the search Terms","isWebhook":false,"pointer":"/paths/~1tasks~1search/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Tasks based on the search Terms","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Return Tasks associated with the search term"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"projectId","in":"query","schemaId":"schema_63","description":"ID of the Project to be used in search","example":1},{"name":"inventoryId","in":"query","schemaId":"schema_63","description":"ID of the inventory to be used in search","example":1},{"name":"offset","in":"query","schemaId":"schema_76","description":"Index of the page to start with"},{"name":"limit","in":"query","schemaId":"schema_77","description":"Number Of Records to fetch"},{"name":"status","in":"query","schemaId":"schema_110"},{"name":"type","in":"query","schemaId":"schema_111"},{"name":"priority","in":"query","schemaId":"schema_112"}],"pointer":"/paths/~1tasks~1search/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/tasks/search","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[{"name":"projectId","in":"query","example":1,"schemaId":"schema_63"},{"name":"inventoryId","in":"query","example":1,"schemaId":"schema_63"},{"name":"offset","in":"query","schemaId":"schema_76"},{"name":"limit","in":"query","schemaId":"schema_77"},{"name":"status","in":"query","schemaId":"schema_110"},{"name":"type","in":"query","schemaId":"schema_111"},{"name":"priority","in":"query","schemaId":"schema_112"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/tasks/search","href":"task/searchtask","openApiOperationId":"searchTask","summary":"Get Tasks based on the search Terms"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1tasks~1search/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/task/searchtask"}],"panels":[]}]},"httpPath":"/tasks/search"}],"content":{"contentType":"group","meta":{"name":"Task"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Task","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/tasks/{taskId}/comments","summary":"Get Task Comments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/task/gettaskcomments","deprecated":false},{"title":"/tasks/{taskId}/comments","summary":"Add Task Comment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/task/addtaskcomment","deprecated":false},{"title":"/tasks/{taskId}/issues","summary":"Assign Alm Issues","prefix":{"name":"post","color":"post"},"badges":[],"link":"/task/assignalmissuestotask","deprecated":false},{"title":"/tasks/{taskId}/close","summary":"Close Task","prefix":{"name":"put","color":"put"},"badges":[],"link":"/task/closetask","deprecated":false},{"title":"/tasks","summary":"Create Task","prefix":{"name":"post","color":"post"},"badges":[],"link":"/task/createtask","deprecated":false},{"title":"/tasks/{taskId}","summary":"Get Task","prefix":{"name":"get","color":"get"},"badges":[],"link":"/task/gettask","deprecated":false},{"title":"/tasks/{taskId}","summary":"Update Task","prefix":{"name":"put","color":"put"},"badges":[],"link":"/task/updatetask","deprecated":false},{"title":"/tasks/{taskId}/reassign","summary":"Reassign Task","prefix":{"name":"put","color":"put"},"badges":[],"link":"/task/reassigntask","deprecated":false},{"title":"/tasks/{taskId}/reopen","summary":"Reopen Task","prefix":{"name":"put","color":"put"},"badges":[],"link":"/task/reopentask","deprecated":false},{"title":"/tasks/search","summary":"Get Tasks based on the search Terms","prefix":{"name":"get","color":"get"},"badges":[],"link":"/task/searchtask","deprecated":false}]}]}]}]}},{"type":"group","label":"Scan API","link":"/swagger/scan-api","routeSlug":"/swagger/scan-api","items":[{"label":"Project Scan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/scan-api/addprojectscantask","routeSlug":"/swagger/scan-api/addprojectscantask","metadata":{"seo":{"title":"Project Scan","description":"Initiates a scan for a given project, specified by the projectId. Returns the taskId corresponding to the scan task. The taskId can be used to check the scan status. Only Project Admin and Analyst can invoke a scan of a project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addProjectScanTask","name":"Project Scan","isWebhook":false,"pointer":"/paths/~1scanResource~1projectScan~1{projectId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Project Scan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Initiates a scan for a given project, specified by the projectId. Returns the taskId corresponding to the scan task. The taskId can be used to check the scan status. Only Project Admin and Analyst can invoke a scan of a project."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_62","description":"ID of the project","required":true,"example":1}],"pointer":"/paths/~1scanResource~1projectScan~1{projectId}/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fullRescan","in":"query","schemaId":"schema_93","description":"Irrespective of codebase changes, pass value as true to perform a full scan of the codebase"}],"pointer":"/paths/~1scanResource~1projectScan~1{projectId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_113"}},"schemaId":"schema_113","pointer":"/paths/~1scanResource~1projectScan~1{projectId}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/scanResource/projectScan/{projectId}","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":1,"schemaId":"schema_62"}],"query":[{"name":"fullRescan","in":"query","schemaId":"schema_93"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_113"}},"responseCodes":["200","400","409","503"],"pointer":"/scanResource/projectScan/{projectId}","href":"scan-api/addprojectscantask","openApiOperationId":"addProjectScanTask","summary":"Project Scan"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"schema_113","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_113"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_64"}},"schemaId":"schema_64"},{"code":"400","description":"Bad request: The project Id entered was not found"},{"code":"409","description":"Conflict: Project is already in queue or already being scanned"},{"code":"503","description":"Service Unavailable"}],"pointer":"/paths/~1scanResource~1projectScan~1{projectId}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_64","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_64"}}},{"code":"400"},{"code":"409"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scan-api/addprojectscantask"}],"panels":[]}]},"httpPath":"/scanResource/projectScan/{projectId}"}],"content":{"contentType":"group","meta":{"name":"Scan API"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Scan API","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/scanResource/projectScan/{projectId}","summary":"Project Scan","prefix":{"name":"post","color":"post"},"badges":[],"link":"/scan-api/addprojectscantask","deprecated":false}]}]}]}]}},{"type":"group","label":"licenseEvidences","link":"/swagger/licenseevidences","routeSlug":"/swagger/licenseevidences","items":[{"label":"List all user-defined license evidence rules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/licenseevidences/getall","routeSlug":"/swagger/licenseevidences/getall","metadata":{"seo":{"title":"List all user-defined license evidence rules","description":"Returns all user-defined license evidence rules."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAll","name":"List all user-defined license evidence rules","isWebhook":false,"pointer":"/paths/~1rules~1licenseEvidences/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all user-defined license evidence rules","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns all user-defined license evidence rules."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/rules/licenseEvidences","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","500"],"pointer":"/rules/licenseEvidences","href":"licenseevidences/getall","openApiOperationId":"getAll","summary":"List all user-defined license evidence rules"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1rules~1licenseEvidences/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/licenseevidences/getall"}],"panels":[]}]},"httpPath":"/rules/licenseEvidences"},{"label":"Create a user-defined license evidence rule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/licenseevidences/create","routeSlug":"/swagger/licenseevidences/create","metadata":{"seo":{"title":"Create a user-defined license evidence rule","description":"Creates a new rule mapping a license fragment to a license ID. Requires Library Manager permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create","name":"Create a user-defined license evidence rule","isWebhook":false,"pointer":"/paths/~1rules~1licenseEvidences/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a user-defined license evidence rule","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new rule mapping a license fragment to a license ID. Requires Library Manager permission."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserDefinedLicenseEvidenceRequest"}},"schemaId":"components/schemas/UserDefinedLicenseEvidenceRequest","pointer":"/paths/~1rules~1licenseEvidences/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/rules/licenseEvidences","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UserDefinedLicenseEvidenceRequest"}},"responseCodes":["201","400","403","500"],"pointer":"/rules/licenseEvidences","href":"licenseevidences/create","openApiOperationId":"create","summary":"Create a user-defined license evidence rule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"components/schemas/UserDefinedLicenseEvidenceRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserDefinedLicenseEvidenceRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created"},{"code":"400","description":"Bad Request"},{"code":"403","description":"Forbidden"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1rules~1licenseEvidences/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/licenseevidences/create"}],"panels":[]}]},"httpPath":"/rules/licenseEvidences"},{"label":"Get a user-defined license evidence rule by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/licenseevidences/getbyid","routeSlug":"/swagger/licenseevidences/getbyid","metadata":{"seo":{"title":"Get a user-defined license evidence rule by ID","description":"Returns the rule matching the given ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getById","name":"Get a user-defined license evidence rule by ID","isWebhook":false,"pointer":"/paths/~1rules~1licenseEvidences~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a user-defined license evidence rule by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the rule matching the given ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_62","required":true}],"pointer":"/paths/~1rules~1licenseEvidences~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/rules/licenseEvidences/{id}","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_62"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404","500"],"pointer":"/rules/licenseEvidences/{id}","href":"licenseevidences/getbyid","openApiOperationId":"getById","summary":"Get a user-defined license evidence rule by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1rules~1licenseEvidences~1{id}/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/licenseevidences/getbyid"}],"panels":[]}]},"httpPath":"/rules/licenseEvidences/{id}"},{"label":"Update a user-defined license evidence rule","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/licenseevidences/update","routeSlug":"/swagger/licenseevidences/update","metadata":{"seo":{"title":"Update a user-defined license evidence rule","description":"Updates an existing rule. Requires Library Manager permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update","name":"Update a user-defined license evidence rule","isWebhook":false,"pointer":"/paths/~1rules~1licenseEvidences~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a user-defined license evidence rule","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an existing rule. Requires Library Manager permission."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_62","required":true}],"pointer":"/paths/~1rules~1licenseEvidences~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserDefinedLicenseEvidenceRequest"}},"schemaId":"components/schemas/UserDefinedLicenseEvidenceRequest","pointer":"/paths/~1rules~1licenseEvidences~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/rules/licenseEvidences/{id}","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_62"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UserDefinedLicenseEvidenceRequest"}},"responseCodes":["200","400","403","404","500"],"pointer":"/rules/licenseEvidences/{id}","href":"licenseevidences/update","openApiOperationId":"update","summary":"Update a user-defined license evidence rule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"components/schemas/UserDefinedLicenseEvidenceRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserDefinedLicenseEvidenceRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1rules~1licenseEvidences~1{id}/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/licenseevidences/update"}],"panels":[]}]},"httpPath":"/rules/licenseEvidences/{id}"},{"label":"Delete a user-defined license evidence rule","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/licenseevidences/delete","routeSlug":"/swagger/licenseevidences/delete","metadata":{"seo":{"title":"Delete a user-defined license evidence rule","description":"Deletes the rule with the given ID. Requires Library Manager permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete","name":"Delete a user-defined license evidence rule","isWebhook":false,"pointer":"/paths/~1rules~1licenseEvidences~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a user-defined license evidence rule","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes the rule with the given ID. Requires Library Manager permission."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_62","required":true}],"pointer":"/paths/~1rules~1licenseEvidences~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/rules/licenseEvidences/{id}","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_62"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","403","404","500"],"pointer":"/rules/licenseEvidences/{id}","href":"licenseevidences/delete","openApiOperationId":"delete","summary":"Delete a user-defined license evidence rule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1rules~1licenseEvidences~1{id}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/licenseevidences/delete"}],"panels":[]}]},"httpPath":"/rules/licenseEvidences/{id}"}],"content":{"contentType":"group","meta":{"name":"licenseEvidences"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"licenseEvidences","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/rules/licenseEvidences","summary":"List all user-defined license evidence rules","prefix":{"name":"get","color":"get"},"badges":[],"link":"/licenseevidences/getall","deprecated":false},{"title":"/rules/licenseEvidences","summary":"Create a user-defined license evidence rule","prefix":{"name":"post","color":"post"},"badges":[],"link":"/licenseevidences/create","deprecated":false},{"title":"/rules/licenseEvidences/{id}","summary":"Get a user-defined license evidence rule by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/licenseevidences/getbyid","deprecated":false},{"title":"/rules/licenseEvidences/{id}","summary":"Update a user-defined license evidence rule","prefix":{"name":"put","color":"put"},"badges":[],"link":"/licenseevidences/update","deprecated":false},{"title":"/rules/licenseEvidences/{id}","summary":"Delete a user-defined license evidence rule","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/licenseevidences/delete","deprecated":false}]}]}]}]}},{"type":"group","label":"User API","link":"/swagger/user-api","routeSlug":"/swagger/user-api","items":[{"label":"activate User","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/user-api/activateuser","routeSlug":"/swagger/user-api/activateuser","metadata":{"seo":{"title":"activate User","description":"Activate a User"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"activateUser","name":"activate User","isWebhook":false,"pointer":"/paths/~1users~1{loginId}~1activate/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"activate User","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Activate a User"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"loginId","in":"path","schemaId":"schema_57","description":"loginId (Example: admin)","required":true}],"pointer":"/paths/~1users~1{loginId}~1activate/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/users/{loginId}/activate","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"loginId","in":"path","required":true,"schemaId":"schema_57"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/users/{loginId}/activate","href":"user-api/activateuser","openApiOperationId":"activateUser","summary":"activate User"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1users~1{loginId}~1activate/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-api/activateuser"}],"panels":[]}]},"httpPath":"/users/{loginId}/activate"},{"label":"Create User","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/user-api/createuser","routeSlug":"/swagger/user-api/createuser","metadata":{"seo":{"title":"Create User","description":"Creates a user"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createUser","name":"Create User","isWebhook":false,"pointer":"/paths/~1users/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create User","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a user"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserModel"}},"schemaId":"components/schemas/UserModel","pointer":"/paths/~1users/post/requestBody","description":"To create a user the login, First Name, Last Name, Email, Password, Question, Answer field is required."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/users","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UserModel"}},"responseCodes":["201","400","401","500"],"pointer":"/users","href":"user-api/createuser","openApiOperationId":"createUser","summary":"Create User"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"components/schemas/UserModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1users/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-api/createuser"}],"panels":[]}]},"httpPath":"/users"},{"label":"deactivate User","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/user-api/deactivateuser","routeSlug":"/swagger/user-api/deactivateuser","metadata":{"seo":{"title":"deactivate User","description":"Deactivate a User"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deactivateUser","name":"deactivate User","isWebhook":false,"pointer":"/paths/~1users~1{loginId}~1deactivate/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"deactivate User","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deactivate a User"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"loginId","in":"path","schemaId":"schema_57","description":"loginId (Example: admin)","required":true}],"pointer":"/paths/~1users~1{loginId}~1deactivate/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/users/{loginId}/deactivate","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"loginId","in":"path","required":true,"schemaId":"schema_57"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/users/{loginId}/deactivate","href":"user-api/deactivateuser","openApiOperationId":"deactivateUser","summary":"deactivate User"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1users~1{loginId}~1deactivate/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-api/deactivateuser"}],"panels":[]}]},"httpPath":"/users/{loginId}/deactivate"},{"label":"manage Permission","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/user-api/managepermission","routeSlug":"/swagger/user-api/managepermission","metadata":{"seo":{"title":"manage Permission","description":"Manage User Permission for the existing user in the system. This will remove the permission mapped earlier and the current request permissions will be considered always."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"managePermission","name":"manage Permission","isWebhook":false,"pointer":"/paths/~1users~1{loginId}~1permission/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"manage Permission","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Manage User Permission for the existing user in the system. This will remove the permission mapped earlier and the current request permissions will be considered always."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"loginId","in":"path","schemaId":"schema_57","description":"loginId (Example: admin)","required":true}],"pointer":"/paths/~1users~1{loginId}~1permission/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PermissionsWrapper"}},"schemaId":"components/schemas/PermissionsWrapper","pointer":"/paths/~1users~1{loginId}~1permission/put/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"list of permission is a required field. Allowable permission are system_admin, edit_policy, create_project, library_manager"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/users/{loginId}/permission","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"loginId","in":"path","required":true,"schemaId":"schema_57"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PermissionsWrapper"}},"responseCodes":["200","400","401","404"],"pointer":"/users/{loginId}/permission","href":"user-api/managepermission","openApiOperationId":"managePermission","summary":"manage Permission"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"components/schemas/PermissionsWrapper","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PermissionsWrapper"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1users~1{loginId}~1permission/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-api/managepermission"}],"panels":[]}]},"httpPath":"/users/{loginId}/permission"},{"label":"Search Users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/user-api/searchuser","routeSlug":"/swagger/user-api/searchuser","metadata":{"seo":{"title":"Search Users","description":"Search User By id or login"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchUser","name":"Search Users","isWebhook":false,"pointer":"/paths/~1users~1search/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search Users","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Search User By id or login"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"id","in":"query","schemaId":"schema_62","example":1},{"name":"login","in":"query","schemaId":"schema_57","example":"admin"},{"name":"email","in":"query","schemaId":"schema_57","example":"admin@gmail.com"}],"pointer":"/paths/~1users~1search/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/users/search","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[{"name":"id","in":"query","example":1,"schemaId":"schema_62"},{"name":"login","in":"query","example":"admin","schemaId":"schema_57"},{"name":"email","in":"query","example":"admin@gmail.com","schemaId":"schema_57"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/users/search","href":"user-api/searchuser","openApiOperationId":"searchUser","summary":"Search Users"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1users~1search/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-api/searchuser"}],"panels":[]}]},"httpPath":"/users/search"}],"content":{"contentType":"group","meta":{"name":"User API"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"User API","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/users/{loginId}/activate","summary":"activate User","prefix":{"name":"put","color":"put"},"badges":[],"link":"/user-api/activateuser","deprecated":false},{"title":"/users","summary":"Create User","prefix":{"name":"post","color":"post"},"badges":[],"link":"/user-api/createuser","deprecated":false},{"title":"/users/{loginId}/deactivate","summary":"deactivate User","prefix":{"name":"put","color":"put"},"badges":[],"link":"/user-api/deactivateuser","deprecated":false},{"title":"/users/{loginId}/permission","summary":"manage Permission","prefix":{"name":"put","color":"put"},"badges":[],"link":"/user-api/managepermission","deprecated":false},{"title":"/users/search","summary":"Search Users","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-api/searchuser","deprecated":false}]}]}]}]}},{"type":"group","label":"vulnerability","link":"/swagger/vulnerability","routeSlug":"/swagger/vulnerability","items":[{"label":"Get suppressed vulnerabilities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/vulnerability/getsuppressedvulnerability","routeSlug":"/swagger/vulnerability/getsuppressedvulnerability","metadata":{"seo":{"title":"Get suppressed vulnerabilities","description":"Get suppressed vulnerabilities based on componentId/vulnerabilityName or both, either of them is mandatory.Only the system administrator has the permission to do this operation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSuppressedVulnerability","name":"Get suppressed vulnerabilities","isWebhook":false,"pointer":"/paths/~1vulnerability~1suppress/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get suppressed vulnerabilities","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get suppressed vulnerabilities based on componentId/vulnerabilityName or both, either of them is mandatory.Only the system administrator has the permission to do this operation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"componentId","in":"query","schemaId":"schema_58","description":"ID of the Component"},{"name":"vulnerabilityName","in":"query","schemaId":"schema_57","description":"Name of the vulnerability"},{"name":"limit","in":"query","schemaId":"schema_73","description":"Page Size. Number Of Records to fetch per page"},{"name":"offset","in":"query","schemaId":"schema_74","description":"Page Number. Index of the page to start with(starts from 1)"}],"pointer":"/paths/~1vulnerability~1suppress/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/vulnerability/suppress","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[{"name":"componentId","in":"query","schemaId":"schema_58"},{"name":"vulnerabilityName","in":"query","schemaId":"schema_57"},{"name":"limit","in":"query","schemaId":"schema_73"},{"name":"offset","in":"query","schemaId":"schema_74"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/vulnerability/suppress","href":"vulnerability/getsuppressedvulnerability","openApiOperationId":"getSuppressedVulnerability","summary":"Get suppressed vulnerabilities"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SuppressedVulnerabilityModel"}},"schemaId":"components/schemas/SuppressedVulnerabilityModel"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1vulnerability~1suppress/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SuppressedVulnerabilityModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SuppressedVulnerabilityModel"}}},{"code":"400"},{"code":"401"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/vulnerability/getsuppressedvulnerability"}],"panels":[]}]},"httpPath":"/vulnerability/suppress"},{"label":"Suppress vulnerability","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/vulnerability/suppressvulnerability","routeSlug":"/swagger/vulnerability/suppressvulnerability","metadata":{"seo":{"title":"Suppress vulnerability","description":"Suppress vulnerability for component version(s). System administrator only has permission for global suppression, while Developer/Security contact have permission for project-specific suppression.Note: For GLOBAL level suppression, providing suppression details is not necessary. These details are only required for PROJECT level suppression and will be ignored if provided in the GLOBAL scope."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"suppressVulnerability","name":"Suppress vulnerability","isWebhook":false,"pointer":"/paths/~1vulnerability~1suppress/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Suppress vulnerability","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Suppress vulnerability for component version(s). System administrator only has permission for global suppression, while Developer/Security contact have permission for project-specific suppression."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GLOBAL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" level suppression, providing suppression details is not necessary. These details are only required for "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROJECT"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" level suppression and will be ignored if provided in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GLOBAL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scope."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default value for the Suppression Scope will be considered "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GLOBAL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if left empty."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VulnerabilitySuppressModel"}},"schemaId":"components/schemas/VulnerabilitySuppressModel","pointer":"/paths/~1vulnerability~1suppress/post/requestBody","description":"Input model to suppress vulnerability for component versions."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/vulnerability/suppress","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VulnerabilitySuppressModel"}},"responseCodes":["200","400","401","500"],"pointer":"/vulnerability/suppress","href":"vulnerability/suppressvulnerability","openApiOperationId":"suppressVulnerability","summary":"Suppress vulnerability"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"components/schemas/VulnerabilitySuppressModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VulnerabilitySuppressModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VulnerabilitySuppressModel"}},"schemaId":"components/schemas/VulnerabilitySuppressModel"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1vulnerability~1suppress/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/VulnerabilitySuppressModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VulnerabilitySuppressModel"}}},{"code":"400"},{"code":"401"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/vulnerability/suppressvulnerability"}],"panels":[]}]},"httpPath":"/vulnerability/suppress"},{"label":"Get vulnerability suppress details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/vulnerability/getsuppressedvulnerabilitydetails","routeSlug":"/swagger/vulnerability/getsuppressedvulnerabilitydetails","metadata":{"seo":{"title":"Get vulnerability suppress details","description":"Get vulnerability suppress details. Provide suppressId/versionId or both as inputs, either of them is mandatory.Only the system administrator has the permission to do this operation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSuppressedVulnerabilityDetails","name":"Get vulnerability suppress details","isWebhook":false,"pointer":"/paths/~1vulnerability~1suppress~1details/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get vulnerability suppress details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get vulnerability suppress details. Provide suppressId/versionId or both as inputs, either of them is mandatory.Only the system administrator has the permission to do this operation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"suppressId","in":"query","schemaId":"schema_58","description":"ID of suppression"},{"name":"componentVersionId","in":"query","schemaId":"schema_58","description":"Id of component version"},{"name":"limit","in":"query","schemaId":"schema_73","description":"Page Size. Number Of Records to fetch per page"},{"name":"offset","in":"query","schemaId":"schema_74","description":"Page Number. Index of the page to start with(starts from 1)"}],"pointer":"/paths/~1vulnerability~1suppress~1details/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/vulnerability/suppress/details","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[{"name":"suppressId","in":"query","schemaId":"schema_58"},{"name":"componentVersionId","in":"query","schemaId":"schema_58"},{"name":"limit","in":"query","schemaId":"schema_73"},{"name":"offset","in":"query","schemaId":"schema_74"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/vulnerability/suppress/details","href":"vulnerability/getsuppressedvulnerabilitydetails","openApiOperationId":"getSuppressedVulnerabilityDetails","summary":"Get vulnerability suppress details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VersionSuppressModel"}},"schemaId":"components/schemas/VersionSuppressModel"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1vulnerability~1suppress~1details/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/VersionSuppressModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VersionSuppressModel"}}},{"code":"400"},{"code":"401"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/vulnerability/getsuppressedvulnerabilitydetails"}],"panels":[]}]},"httpPath":"/vulnerability/suppress/details"},{"label":"UnSuppress vulnerability","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/vulnerability/unsuppressvulnerability","routeSlug":"/swagger/vulnerability/unsuppressvulnerability","metadata":{"seo":{"title":"UnSuppress vulnerability","description":"UnSuppress a vulnerability for given component versions. System administrator only has permission for Global un-suppression, while Developer/Security contact have permission for Project-specific un-suppression.Note: If a project ID is provided, the un-suppression occurs at the PROJECT level, otherwise, it happens at the GLOBAL level."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"unSuppressVulnerability","name":"UnSuppress vulnerability","isWebhook":false,"pointer":"/paths/~1vulnerability~1unSuppress/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"UnSuppress vulnerability","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UnSuppress a vulnerability for given component versions. System administrator only has permission for Global un-suppression, while Developer/Security contact have permission for Project-specific un-suppression."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If a project ID is provided, the un-suppression occurs at the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROJECT"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" level, otherwise, it happens at the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GLOBAL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" level."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VulnerabilityUnsuppressModel"}},"schemaId":"components/schemas/VulnerabilityUnsuppressModel","pointer":"/paths/~1vulnerability~1unSuppress/post/requestBody","description":"Input model to unSuppress vulnerability"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/vulnerability/unSuppress","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VulnerabilityUnsuppressModel"}},"responseCodes":["200","400","401","404","500"],"pointer":"/vulnerability/unSuppress","href":"vulnerability/unsuppressvulnerability","openApiOperationId":"unSuppressVulnerability","summary":"UnSuppress vulnerability"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"components/schemas/VulnerabilityUnsuppressModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VulnerabilityUnsuppressModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1vulnerability~1unSuppress/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/vulnerability/unsuppressvulnerability"}],"panels":[]}]},"httpPath":"/vulnerability/unSuppress"}],"content":{"contentType":"group","meta":{"name":"vulnerability"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"vulnerability","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/vulnerability/suppress","summary":"Get suppressed vulnerabilities","prefix":{"name":"get","color":"get"},"badges":[],"link":"/vulnerability/getsuppressedvulnerability","deprecated":false},{"title":"/vulnerability/suppress","summary":"Suppress vulnerability","prefix":{"name":"post","color":"post"},"badges":[],"link":"/vulnerability/suppressvulnerability","deprecated":false},{"title":"/vulnerability/suppress/details","summary":"Get vulnerability suppress details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/vulnerability/getsuppressedvulnerabilitydetails","deprecated":false},{"title":"/vulnerability/unSuppress","summary":"UnSuppress vulnerability","prefix":{"name":"post","color":"post"},"badges":[],"link":"/vulnerability/unsuppressvulnerability","deprecated":false}]}]}]}]}},{"type":"group","label":"Vulnerability Subscription API","link":"/swagger/vulnerability-subscription-api","routeSlug":"/swagger/vulnerability-subscription-api","items":[{"label":"Get Vulnerability Subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/vulnerability-subscription-api/getsubscriptionstate","routeSlug":"/swagger/vulnerability-subscription-api/getsubscriptionstate","metadata":{"seo":{"title":"Get Vulnerability Subscription","description":"Gets the current user's vulnerability alert subscription state for the specified project"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSubscriptionState","name":"Get Vulnerability Subscription","isWebhook":false,"pointer":"/paths/~1projects~1{projectId}~1vulnerability-subscription/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Vulnerability Subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets the current user's vulnerability alert subscription state for the specified project"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_62","description":"Project ID","required":true}],"pointer":"/paths/~1projects~1{projectId}~1vulnerability-subscription/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/projects/{projectId}/vulnerability-subscription","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_62"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/projects/{projectId}/vulnerability-subscription","href":"vulnerability-subscription-api/getsubscriptionstate","openApiOperationId":"getSubscriptionState","summary":"Get Vulnerability Subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Project Not Found"}],"pointer":"/paths/~1projects~1{projectId}~1vulnerability-subscription/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/vulnerability-subscription-api/getsubscriptionstate"}],"panels":[]}]},"httpPath":"/projects/{projectId}/vulnerability-subscription"},{"label":"Update Vulnerability Subscription","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/vulnerability-subscription-api/updatesubscriptionstate","routeSlug":"/swagger/vulnerability-subscription-api/updatesubscriptionstate","metadata":{"seo":{"title":"Update Vulnerability Subscription","description":"Updates the current user's vulnerability alert subscription state for the specified project"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateSubscriptionState","name":"Update Vulnerability Subscription","isWebhook":false,"pointer":"/paths/~1projects~1{projectId}~1vulnerability-subscription/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Vulnerability Subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates the current user's vulnerability alert subscription state for the specified project"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_62","description":"Project ID","required":true}],"pointer":"/paths/~1projects~1{projectId}~1vulnerability-subscription/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_113"}},"schemaId":"schema_113","pointer":"/paths/~1projects~1{projectId}~1vulnerability-subscription/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/projects/{projectId}/vulnerability-subscription","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_62"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_113"}},"responseCodes":["200","400","401","404"],"pointer":"/projects/{projectId}/vulnerability-subscription","href":"vulnerability-subscription-api/updatesubscriptionstate","openApiOperationId":"updateSubscriptionState","summary":"Update Vulnerability Subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"schemaId":"schema_113","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_113"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Project Not Found"}],"pointer":"/paths/~1projects~1{projectId}~1vulnerability-subscription/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/vulnerability-subscription-api/updatesubscriptionstate"}],"panels":[]}]},"httpPath":"/projects/{projectId}/vulnerability-subscription"},{"label":"Unsubscribe via Email Link","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/swagger/vulnerability-subscription-api/processunsubscribetoken","routeSlug":"/swagger/vulnerability-subscription-api/processunsubscribetoken","metadata":{"seo":{"title":"Unsubscribe via Email Link","description":"Processes a signed unsubscribe link from a vulnerability alert email"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"processUnsubscribeToken","name":"Unsubscribe via Email Link","isWebhook":false,"pointer":"/paths/~1projects~1vulnerability-unsubscribe/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unsubscribe via Email Link","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Processes a signed unsubscribe link from a vulnerability alert email"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"payload","in":"query","schemaId":"schema_57","description":"Signed unsubscribe payload"},{"name":"sig","in":"query","schemaId":"schema_57","description":"Signed unsubscribe payload signature"}],"pointer":"/paths/~1projects~1vulnerability-unsubscribe/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/projects/vulnerability-unsubscribe","servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"parameters":{"path":[],"query":[{"name":"payload","in":"query","schemaId":"schema_57"},{"name":"sig","in":"query","schemaId":"schema_57"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/projects/vulnerability-unsubscribe","href":"vulnerability-subscription-api/processunsubscribetoken","openApiOperationId":"processUnsubscribeToken","summary":"Unsubscribe via Email Link"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/swagger","description":"Mock server","isMockServer":true},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Unsubscribed successfully"},{"code":"400","description":"Invalid or expired unsubscribe link"}],"pointer":"/paths/~1projects~1vulnerability-unsubscribe/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/vulnerability-subscription-api/processunsubscribetoken"}],"panels":[]}]},"httpPath":"/projects/vulnerability-unsubscribe"}],"content":{"contentType":"group","meta":{"name":"Vulnerability Subscription API"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Vulnerability Subscription API","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/projects/{projectId}/vulnerability-subscription","summary":"Get Vulnerability Subscription","prefix":{"name":"get","color":"get"},"badges":[],"link":"/vulnerability-subscription-api/getsubscriptionstate","deprecated":false},{"title":"/projects/{projectId}/vulnerability-subscription","summary":"Update Vulnerability Subscription","prefix":{"name":"put","color":"put"},"badges":[],"link":"/vulnerability-subscription-api/updatesubscriptionstate","deprecated":false},{"title":"/projects/vulnerability-unsubscribe","summary":"Unsubscribe via Email Link","prefix":{"name":"get","color":"get"},"badges":[],"link":"/vulnerability-subscription-api/processunsubscribetoken","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/ComponentCPEModel":{"id":"components/schemas/ComponentCPEModel","kind":"json-schema","title":"ComponentCPEModel","data":{"type":"object","properties":{"cpeName":{"type":"string","description":"cpeName","example":"E.g.  cpe://a:gnome:gedit"},"cpeVendor":{"type":"string","description":"cpeVendor","example":"Vendor name"},"cpeProduct":{"type":"string","description":"cpeProduct","example":"Product name"}}}},"components/schemas/ComponentListModel":{"id":"components/schemas/ComponentListModel","kind":"json-schema","title":"ComponentListModel","data":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"description":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"},"forge":{"type":"string"},"versionList":{"type":"array","items":{"$ref":"#/components/schemas/VersionListModel"}},"licenseList":{"type":"array","items":{"$ref":"#/components/schemas/LicenseListModel"}},"cpeList":{"type":"array","items":{"$ref":"#/components/schemas/ComponentCPEModel"}}}}},"components/schemas/LicenseListModel":{"id":"components/schemas/LicenseListModel","kind":"json-schema","title":"LicenseListModel","data":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"url":{"type":"string"},"priority":{"type":"string"},"externalId":{"type":"string"}}}},"components/schemas/VersionListModel":{"id":"components/schemas/VersionListModel","kind":"json-schema","title":"VersionListModel","data":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"custom":{"type":"boolean"},"purl":{"type":"string"},"versionReleaseDate":{"type":"string"}}}},"components/schemas/VersionModel":{"id":"components/schemas/VersionModel","kind":"json-schema","title":"VersionModel","data":{"type":"object","properties":{"name":{"type":"string","description":"name"},"vulnerabilitySummary":{"type":"array","items":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}}}}}}},"components/schemas/ComponentModel":{"id":"components/schemas/ComponentModel","kind":"json-schema","title":"ComponentModel","data":{"required":["name","title","url"],"type":"object","properties":{"name":{"maxLength":127,"minLength":0,"pattern":"^[a-zA-Z0-9\\.\\_\\-]+$","type":"string","description":"name","example":"Comp1"},"title":{"maxLength":255,"minLength":0,"type":"string","description":"title","example":"Component1"},"url":{"maxLength":2400,"minLength":0,"pattern":"(NA|^https?:\\/\\/(www\\.)?[-a-zA-Z0-9@:%._\\+~#=]{2,256}\\.[a-z]{2,6}\\b([-a-zA-Z0-9@:%_\\+.~#?&\\/\\/=]*))","type":"string","description":"url","example":"http://abc@xyz.com | NA"},"description":{"maxLength":65535,"minLength":0,"type":"string","description":"description","example":"This is a custom component."},"encryption":{"pattern":"YES|NO","type":"string","description":"encryption","example":"E.g. YES | default: NO","enum":["YES","NO"]},"forgeId":{"minimum":1,"type":"integer","description":"forgeId","format":"int32"},"purl":{"maxLength":2400,"minLength":0,"pattern":"(^$|^(?i:NA|N/A)$|^pkg:[a-zA-Z0-9\\+\\-\\.]+\\/.*)","type":"string","description":"purl","example":"pkg:maven/org.apache/commons-lang3 | N/A | NA"}}}},"components/schemas/ComponentLicenseModel":{"id":"components/schemas/ComponentLicenseModel","kind":"json-schema","title":"ComponentLicenseModel","data":{"required":["licenseText","name","shortName"],"type":"object","properties":{"name":{"maxLength":127,"minLength":0,"type":"string","description":"name","example":"General Public License"},"shortName":{"maxLength":255,"minLength":0,"type":"string","description":"shortName","example":"GPL"},"licenseText":{"maxLength":16777215,"minLength":0,"type":"string","description":"licenseText","example":"License Text"},"priority":{"pattern":"P1|P2|P3","type":"string","description":"priority","example":"E.g. P1 | P2 | P3 | default: P3","enum":["P1","P2","P3"]},"url":{"maxLength":2400,"minLength":0,"pattern":"(^https?:\\/\\/(www\\.)?[-a-zA-Z0-9@:%._\\+~#=]{2,256}\\.[a-z]{2,6}\\b([-a-zA-Z0-9@:%_\\+.~#?&\\/\\/=]*))","type":"string","description":"url","example":"https://abc.xyz"},"description":{"maxLength":65535,"minLength":0,"type":"string","description":"description","example":"License description"},"familyName":{"type":"string","description":"familyName","example":"License family"},"externalId":{"type":"string","description":"externalId","example":"External License Id Eg: 156"}}}},"components/schemas/ExtendedComponentModel":{"id":"components/schemas/ExtendedComponentModel","kind":"json-schema","title":"ExtendedComponentModel","data":{"required":["name","title","url"],"type":"object","properties":{"name":{"maxLength":127,"minLength":0,"pattern":"^[a-zA-Z0-9\\.\\_\\-]+$","type":"string","description":"name","example":"Comp1"},"title":{"maxLength":255,"minLength":0,"type":"string","description":"title","example":"Component1"},"url":{"maxLength":2400,"minLength":0,"pattern":"(NA|^https?:\\/\\/(www\\.)?[-a-zA-Z0-9@:%._\\+~#=]{2,256}\\.[a-z]{2,6}\\b([-a-zA-Z0-9@:%_\\+.~#?&\\/\\/=]*))","type":"string","description":"url","example":"http://abc@xyz.com | NA"},"description":{"maxLength":65535,"minLength":0,"type":"string","description":"description","example":"This is a custom component."},"encryption":{"pattern":"YES|NO","type":"string","description":"encryption","example":"E.g. YES | default: NO","enum":["YES","NO"]},"forgeId":{"minimum":1,"type":"integer","description":"forgeId","format":"int32"},"purl":{"maxLength":2400,"minLength":0,"pattern":"(^$|^(?i:NA|N/A)$|^pkg:[a-zA-Z0-9\\+\\-\\.]+\\/.*)","type":"string","description":"purl","example":"pkg:maven/org.apache/commons-lang3 | N/A | NA"},"id":{"type":"integer","format":"int64"},"forge":{"type":"string"},"versionList":{"type":"array","items":{"$ref":"#/components/schemas/VersionModel"}},"licenseList":{"type":"array","items":{"$ref":"#/components/schemas/ComponentLicenseModel"}},"componentCPEList":{"type":"array","items":{"$ref":"#/components/schemas/ComponentCPEModel"}},"createdBy":{"type":"string"},"createdOn":{"type":"string"},"updatedBy":{"type":"string"},"updatedOn":{"type":"string"}}}},"components/schemas/EmailPasswordUpdateRequest":{"id":"components/schemas/EmailPasswordUpdateRequest","kind":"json-schema","title":"EmailPasswordUpdateRequest","data":{"required":["password"],"type":"object","properties":{"password":{"type":"string","description":"New SMTP email password","example":"newSecurePassword123"}},"description":"Request body for updating SMTP email password"}},"components/schemas/FolderModel":{"id":"components/schemas/FolderModel","kind":"json-schema","title":"FolderModel","data":{"required":["name"],"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"type":"string","description":"name","example":"SCA"},"parentFolderId":{"minimum":1,"type":"integer","description":"parentFolderId","format":"int32","example":1}}}},"components/schemas/InventoryFilesModel":{"id":"components/schemas/InventoryFilesModel","kind":"json-schema","title":"InventoryFilesModel","data":{"type":"object","properties":{"filePaths":{"type":"array","description":"filePaths","items":{"type":"string","description":"filePaths"}},"folderPaths":{"type":"array","description":"folderPaths","items":{"type":"string","description":"folderPaths"}},"markAssociatedFilesAsReviewed":{"type":"boolean","description":"markAssociatedFilesAsReviewed","example":false}}}},"components/schemas/CreateInventoryModel":{"id":"components/schemas/CreateInventoryModel","kind":"json-schema","title":"CreateInventoryModel","data":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"type":"string","description":"name","example":"maven-artifact 3.6.1 (Apache-2.0)"},"description":{"type":"string","description":"description","example":"Sources: scm:git:https://git-wip-us.apache.org/repos/asf/maven.git"},"url":{"pattern":"(@)?(href=')?(HREF=')?(HREF=\")?(href=\")?(http://)?(https://)?[a-zA-Z_0-9\\-]+(\\.\\w[a-zA-Z_0-9\\-\\/]+)+(/[@#&!~:\\n\\-=?\\+\\%\\/\\.\\w]+)?","type":"string","description":"url","example":"https://repo1.maven.org/maven2/org/apache/maven/maven-artifact"},"priority":{"pattern":"P1|P2|P3|P4","type":"string","description":"priority","example":"P1 | P2 | P3 | P4","enum":["P1","P2","P3","P4"]},"disclosed":{"pattern":"YES|NO","type":"string","description":"disclosed","example":"YES | NO","enum":["YES","NO"]},"distribution":{"pattern":"UNKNOWN|INTERNAL|EXTERNAL|HOSTED_ANY|HOSTED_INTERNAL|HOSTED_EXTERNAL","type":"string","description":"distribution","example":"UNKNOWN | INTERNAL | EXTERNAL | HOSTED_ANY | HOSTED_INTERNAL | HOSTED_EXTERNAL","enum":["UNKNOWN","INTERNAL","EXTERNAL","HOSTED_ANY","HOSTED_INTERNAL","HOSTED_EXTERNAL"]},"partOfProduct":{"pattern":"UNKNOWN|YES|NO","type":"string","description":"partOfProduct","example":"UNKNOWN | YES | NO","enum":["UNKNOWN","YES","NO"]},"linking":{"pattern":"UNKNOWN|NOT_LINKED|STATIC|DYNAMIC","type":"string","description":"linking","example":"UNKNOWN | NOT_LINKED | STATIC | DYNAMIC","enum":["UNKNOWN","NOT_LINKED","STATIC","DYNAMIC"]},"modified":{"pattern":"UNKNOWN|YES|NO","type":"string","description":"modified","example":"UNKNOWN | YES | NO","enum":["UNKNOWN","YES","NO"]},"encryption":{"pattern":"UNKNOWN|YES|NO","type":"string","description":"encryption","example":"UNKNOWN | YES | NO","enum":["UNKNOWN","YES","NO"]},"auditorReviewNotes":{"type":"string","description":"auditorReviewNotes"},"noticeText":{"type":"string","description":"noticeText"},"usageGuidance":{"type":"string","description":"usageGuidance"},"remediationNotes":{"type":"string","description":"remediationNotes"},"confidenceLevel":{"pattern":"HIGH|MEDIUM|LOW","type":"string","description":"confidenceLevel","example":"HIGH | MEDIUM | LOW default: HIGH","enum":["HIGH","MEDIUM","LOW"]},"inventoryType":{"pattern":"COMPONENT|LICENSE|WORK_IN_PROGRESS","type":"string","description":"inventoryType","example":"COMPONENT | LICENSE | WORK_IN_PROGRESS"},"component":{"$ref":"#/components/schemas/component"},"licenseId":{"type":"string","description":"licenseId","example":"158"},"rememberLicense":{"pattern":"GLOBAL|INVENTORY","type":"string","description":"rememberLicense","example":"GLOBAL | INVENTORY default: INVENTORY"},"workflowURL":{"type":"string","description":"workflowURL","example":"SVM-123 | https://www.example.com | default: None"},"eccn":{"maxLength":255,"minLength":0,"type":"string","description":"eccn","example":"5A002.a.1"},"invProvenanceId":{"minimum":1,"type":"integer","description":"invProvenanceId","format":"int32","example":1},"customFields":{"type":"array","description":"customFields","items":{"$ref":"#/components/schemas/CustomFieldModel"}}},"description":"inventoryModel"}},"components/schemas/CustomFieldModel":{"id":"components/schemas/CustomFieldModel","kind":"json-schema","title":"CustomFieldModel","data":{"required":["id","value"],"type":"object","properties":{"id":{"minimum":1,"type":"integer","description":"id","format":"int32","example":1},"value":{"type":"string","description":"value","example":"Value for custom field"}},"description":"customFields"}},"components/schemas/ProjectInventoryModel":{"id":"components/schemas/ProjectInventoryModel","kind":"json-schema","title":"ProjectInventoryModel","data":{"required":["projectId"],"type":"object","properties":{"projectId":{"minimum":1,"type":"integer","description":"projectId","format":"int32","example":1},"inventoryModel":{"$ref":"#/components/schemas/CreateInventoryModel"}}}},"components/schemas/component":{"id":"components/schemas/component","kind":"json-schema","title":"component","data":{"required":["id","licenseId","versionId"],"type":"object","properties":{"id":{"type":"string","description":"id","example":"58316"},"versionId":{"type":"string","description":"versionId","example":"3704669"},"licenseId":{"type":"string","description":"licenseId","example":"158"},"licenseExpression":{"type":"string","description":"licenseExpression","example":"7 OR 20"}},"description":"component"}},"components/schemas/Json":{"id":"components/schemas/Json","kind":"json-schema","title":"Json","data":{"type":"object"}},"components/schemas/VexAnalysisModel":{"id":"components/schemas/VexAnalysisModel","kind":"json-schema","title":"VexAnalysisModel","data":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"state":{"type":"string"},"justification":{"type":"string"},"response":{"type":"string"},"detail":{"type":"string"},"firstIssued":{"type":"string"},"firstIssuedBy":{"type":"string"},"lastUpdated":{"type":"string"},"lastUpdatedBy":{"type":"string"}}}},"components/schemas/VulnerabilityAnalysisSuppressionModel":{"id":"components/schemas/VulnerabilityAnalysisSuppressionModel","kind":"json-schema","title":"VulnerabilityAnalysisSuppressionModel","data":{"type":"object","properties":{"inventoryId":{"type":"integer","format":"int32"},"analyzedVulnerabilities":{"type":"array","items":{"$ref":"#/components/schemas/VulnerabilityModel"}}}}},"components/schemas/VulnerabilityModel":{"id":"components/schemas/VulnerabilityModel","kind":"json-schema","title":"VulnerabilityModel","data":{"type":"object","properties":{"vulnerabilityId":{"type":"integer","format":"int64"},"vulnerabilityName":{"type":"string"},"componentVersionId":{"type":"integer","format":"int64"},"analysis":{"$ref":"#/components/schemas/VexAnalysisModel"},"suppression":{"$ref":"#/components/schemas/VulnerabilitySuppressionModel"},"suppressed":{"type":"boolean"}}}},"components/schemas/VulnerabilitySuppressionModel":{"id":"components/schemas/VulnerabilitySuppressionModel","kind":"json-schema","title":"VulnerabilitySuppressionModel","data":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"suppressedDate":{"type":"string"},"suppressedBy":{"type":"string"}}}},"components/schemas/InventoryModel":{"id":"components/schemas/InventoryModel","kind":"json-schema","title":"InventoryModel","data":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"type":"string","description":"name","example":"maven-artifact 3.6.1 (Apache-2.0)"},"description":{"type":"string","description":"description","example":"Sources: scm:git:https://git-wip-us.apache.org/repos/asf/maven.git"},"url":{"pattern":"(@)?(href=')?(HREF=')?(HREF=\")?(href=\")?(http://)?(https://)?[a-zA-Z_0-9\\-]+(\\.\\w[a-zA-Z_0-9\\-\\/]+)+(/[@#&!~:\\n\\-=?\\+\\%\\/\\.\\w]+)?","type":"string","description":"url","example":"https://repo1.maven.org/maven2/org/apache/maven/maven-artifact"},"priority":{"pattern":"P1|P2|P3|P4","type":"string","description":"priority","example":"P1 | P2 | P3 | P4","enum":["P1","P2","P3","P4"]},"disclosed":{"pattern":"YES|NO","type":"string","description":"disclosed","example":"YES | NO","enum":["YES","NO"]},"distribution":{"pattern":"UNKNOWN|INTERNAL|EXTERNAL|HOSTED_ANY|HOSTED_INTERNAL|HOSTED_EXTERNAL","type":"string","description":"distribution","example":"UNKNOWN | INTERNAL | EXTERNAL | HOSTED_ANY | HOSTED_INTERNAL | HOSTED_EXTERNAL","enum":["UNKNOWN","INTERNAL","EXTERNAL","HOSTED_ANY","HOSTED_INTERNAL","HOSTED_EXTERNAL"]},"partOfProduct":{"pattern":"UNKNOWN|YES|NO","type":"string","description":"partOfProduct","example":"UNKNOWN | YES | NO","enum":["UNKNOWN","YES","NO"]},"linking":{"pattern":"UNKNOWN|NOT_LINKED|STATIC|DYNAMIC","type":"string","description":"linking","example":"UNKNOWN | NOT_LINKED | STATIC | DYNAMIC","enum":["UNKNOWN","NOT_LINKED","STATIC","DYNAMIC"]},"modified":{"pattern":"UNKNOWN|YES|NO","type":"string","description":"modified","example":"UNKNOWN | YES | NO","enum":["UNKNOWN","YES","NO"]},"encryption":{"pattern":"UNKNOWN|YES|NO","type":"string","description":"encryption","example":"UNKNOWN | YES | NO","enum":["UNKNOWN","YES","NO"]},"auditorReviewNotes":{"type":"string","description":"auditorReviewNotes"},"noticeText":{"type":"string","description":"noticeText"},"usageGuidance":{"type":"string","description":"usageGuidance"},"remediationNotes":{"type":"string","description":"remediationNotes"},"confidenceLevel":{"pattern":"HIGH|MEDIUM|LOW","type":"string","description":"confidenceLevel","example":"HIGH | MEDIUM | LOW default: HIGH","enum":["HIGH","MEDIUM","LOW"]},"inventoryType":{"pattern":"COMPONENT|LICENSE|WORK_IN_PROGRESS","type":"string","description":"inventoryType","example":"COMPONENT | LICENSE | WORK_IN_PROGRESS"},"component":{"$ref":"#/components/schemas/component"},"licenseId":{"type":"string","description":"licenseId","example":"158"},"rememberLicense":{"pattern":"GLOBAL|INVENTORY","type":"string","description":"rememberLicense","example":"GLOBAL | INVENTORY default: INVENTORY"},"workflowURL":{"type":"string","description":"workflowURL","example":"SVM-123 | https://www.example.com | default: None"},"eccn":{"maxLength":255,"minLength":0,"type":"string","description":"eccn","example":"5A002.a.1"},"invProvenanceId":{"minimum":1,"type":"integer","description":"invProvenanceId","format":"int32","example":1},"customFields":{"type":"array","description":"customFields","items":{"$ref":"#/components/schemas/CustomFieldModel"}},"copyrights":{"type":"array","description":"copyrights","items":{"type":"string","description":"copyrights"}}}}},"components/schemas/InventoryWorkflow":{"id":"components/schemas/InventoryWorkflow","kind":"json-schema","title":"InventoryWorkflow","data":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}},"components/schemas/JobModel":{"id":"components/schemas/JobModel","kind":"json-schema","title":"JobModel","data":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"jobType":{"type":"string","description":"Job type","enum":["Project Branching","Project Copy","Project Scan","Project Re-Scan","PDL Update","Data Garbage Collection","Audit Report","Notices Report","Project Report","Custom Report"]},"project":{"$ref":"#/components/schemas/Project"},"server":{"$ref":"#/components/schemas/Server"},"status":{"type":"string","description":"status of the Job","enum":["NEW","ACTIVE","CANCELED","COMPLETED","FAILED","SCHEDULED","TERMINATED","WAITING_ON_UPDATE"]},"triggeredBy":{"$ref":"#/components/schemas/TriggeredBy"},"queuedOn":{"type":"string","description":"queuedOn","example":"2017-10-24 13:04:26.0"},"activatedOn":{"type":"string","description":"activatedOn","example":"2017-10-24 13:04:26.0"},"completedOn":{"type":"string","description":"completedOn","example":"2017-10-24 13:04:26.0"},"jobDetails":{"type":"string"},"error":{"type":"string"}}}},"components/schemas/Project":{"id":"components/schemas/Project","kind":"json-schema","title":"Project","data":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"}}}},"components/schemas/Server":{"id":"components/schemas/Server","kind":"json-schema","title":"Server","data":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"aliasName":{"type":"string"}}}},"components/schemas/TriggeredBy":{"id":"components/schemas/TriggeredBy","kind":"json-schema","title":"TriggeredBy","data":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"user":{"type":"string"}}}},"components/schemas/LdapPasswordUpdateRequest":{"id":"components/schemas/LdapPasswordUpdateRequest","kind":"json-schema","title":"LdapPasswordUpdateRequest","data":{"required":["password"],"type":"object","properties":{"password":{"type":"string","description":"New LDAP password","example":"newSecurePassword123"}},"description":"Request body for updating LDAP password"}},"components/schemas/LicenseModel":{"id":"components/schemas/LicenseModel","kind":"json-schema","title":"LicenseModel","data":{"type":"object","properties":{"name":{"maxLength":127,"minLength":0,"type":"string","description":"name","example":"General Public License"},"shortName":{"maxLength":255,"minLength":0,"type":"string","description":"shortName","example":"GPL"},"licenseText":{"maxLength":16777215,"minLength":0,"type":"string","description":"licenseText","example":"License Text"},"priority":{"pattern":"P1|P2|P3","type":"string","description":"priority","example":"E.g. P1 | P2 | P3 | default: P3","enum":["P1","P2","P3"]},"url":{"maxLength":2400,"minLength":0,"pattern":"(^https?:\\/\\/(www\\.)?[-a-zA-Z0-9@:%._\\+~#=]{2,256}\\.[a-z]{2,6}\\b([-a-zA-Z0-9@:%_\\+.~#?&\\/\\/=]*))","type":"string","description":"url","example":"https://abc.xyz"},"description":{"maxLength":65535,"minLength":0,"type":"string","description":"description","example":"License description"},"familyName":{"type":"string","description":"familyName","example":"License family"},"externalId":{"type":"string","description":"externalId","example":"External License Id Eg: 156"}}}},"components/schemas/LicenseUpdateModel":{"id":"components/schemas/LicenseUpdateModel","kind":"json-schema","title":"LicenseUpdateModel","data":{"type":"object","properties":{"externalId":{"type":"string","description":"externalId","example":"External License Id Eg:156"}}}},"components/schemas/PerforceSCMModel":{"id":"components/schemas/PerforceSCMModel","kind":"json-schema","title":"PerforceSCMModel","data":{"type":"object","properties":{"url":{"maxLength":2400,"minLength":0,"type":"string","description":"url"},"userName":{"maxLength":255,"minLength":0,"type":"string","description":"userName","example":"abc"},"password":{"maxLength":255,"minLength":0,"type":"string","description":"password","example":"abc"},"branchSpec":{"maxLength":255,"minLength":0,"type":"string","description":"branchSpec"},"changeListNum":{"maxLength":255,"minLength":0,"type":"string","description":"changeListNum"},"label":{"maxLength":255,"minLength":0,"type":"string","description":"label"}}}},"components/schemas/PolicyLicenseImportError":{"id":"components/schemas/PolicyLicenseImportError","kind":"json-schema","title":"PolicyLicenseImportError","data":{"type":"object","properties":{"rowNumber":{"type":"integer","description":"Row number in CSV file (1-indexed, excluding header)","format":"int32","example":5},"column":{"type":"string","description":"Name of the column where the error occurred","example":"License Short Name"},"message":{"type":"string","description":"Error message describing the validation failure","example":"Unknown license short name: InvalidLicense"}},"description":"Validation error details for a specific CSV row"}},"components/schemas/PolicyLicenseImportResponse":{"id":"components/schemas/PolicyLicenseImportResponse","kind":"json-schema","title":"PolicyLicenseImportResponse","data":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the import operation was successful","example":true},"message":{"type":"string","description":"Descriptive message about the import result","example":"Import completed successfully."},"successCount":{"type":"integer","description":"Number of license rules successfully imported or updated","format":"int32","example":42},"errorCount":{"type":"integer","description":"Number of validation errors encountered","format":"int32","example":0},"errors":{"type":"array","description":"List of validation errors (row-level details)","items":{"$ref":"#/components/schemas/PolicyLicenseImportError"}}},"description":"Response model for policy license bulk import operation"}},"components/schemas/FormDataContentDisposition":{"id":"components/schemas/FormDataContentDisposition","kind":"json-schema","title":"FormDataContentDisposition","data":{"type":"object","properties":{"type":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}},"fileName":{"type":"string"},"creationDate":{"type":"string","format":"date-time"},"modificationDate":{"type":"string","format":"date-time"},"readDate":{"type":"string","format":"date-time"},"size":{"type":"integer","format":"int64"},"name":{"type":"string"}}}},"components/schemas/CreateProjectModel":{"id":"components/schemas/CreateProjectModel","kind":"json-schema","title":"CreateProjectModel","data":{"required":["projectName"],"type":"object","properties":{"projectName":{"type":"string","description":"projectName","example":"eportal"},"projectType":{"type":"string","description":"projectType","example":"INVENTORY_ONLY | default: STANDARD","enum":["INVENTORY_ONLY","STANDARD"]},"description":{"type":"string","description":"description","example":"description"},"projectFolderName":{"type":"string","description":"projectFolderName","example":"eportal-v1"},"policyProfileName":{"type":"string","description":"policyProfileName","example":"Default License Policy Profile"},"scanProfileName":{"type":"string","description":"scanProfileName","example":"Basic Scan - Without CL | default: Standard Scan Profile","enum":["Basic Scan Profile (Without CL)","Standard Scan Profile","Comprehensive Scan Profile"]},"ownerLogin":{"type":"string","description":"ownerLogin","example":"admin"},"risk":{"type":"string","description":"risk","example":"HIGH | default: MEDIUM","enum":["HIGH","MEDIUM","LOW"]},"privateProject":{"type":"string","description":"privateProject","example":"false"},"eccn":{"type":"string","description":"eccn","example":"5D002"},"autoPublish":{"type":"string","description":"autoPublish","example":"true"},"markAssociatedFilesAsReviewed":{"type":"string","description":"markAssociatedFilesAsReviewed","example":"true"}}}},"components/schemas/Component":{"id":"components/schemas/Component","kind":"json-schema","title":"Component","data":{"type":"object","properties":{"flagMask":{"type":"integer","format":"int32"},"popularity":{"type":"integer","format":"int32"},"sourceRepoUrl":{"type":"string"},"modified":{"type":"boolean"},"title":{"type":"string"},"description":{"type":"string"},"name":{"type":"string"},"id":{"type":"integer","format":"int64"},"default":{"type":"boolean"},"displayName":{"type":"string"},"url":{"type":"string"},"versions":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/ComponentVersion"}},"createdBy":{"type":"string"},"licenses":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/License"}},"componentForge":{"$ref":"#/components/schemas/ComponentForge"},"componentCPEs":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/ComponentCPELib"}},"sortedVersions":{"type":"array","items":{"$ref":"#/components/schemas/ComponentVersion"}},"custom":{"type":"boolean"},"externalId":{"type":"string"},"updatedBy":{"type":"string"},"encryption":{"type":"boolean"},"registeredDate":{"type":"string","format":"date-time"},"lastUpdateDate":{"type":"string","format":"date-time"},"sortedLicenses":{"type":"array","items":{"$ref":"#/components/schemas/License"}},"type":{"type":"string","enum":["Component","Component Version","Website","Publication"]}}}},"components/schemas/ComponentCPEKey":{"id":"components/schemas/ComponentCPEKey","kind":"json-schema","title":"ComponentCPEKey","data":{"type":"object","properties":{"component":{"$ref":"#/components/schemas/ComponentImpl"},"cpeName":{"type":"string"}}}},"components/schemas/ComponentCPELib":{"id":"components/schemas/ComponentCPELib","kind":"json-schema","title":"ComponentCPELib","data":{"type":"object","properties":{"cpeKey":{"$ref":"#/components/schemas/ComponentCPEKey"},"id":{"type":"integer","format":"int64"},"cpeVendor":{"type":"string"},"cpeProduct":{"type":"string"},"deprecated":{"type":"boolean"},"deleted":{"type":"boolean"},"custom":{"type":"boolean"}}}},"components/schemas/ComponentForge":{"id":"components/schemas/ComponentForge","kind":"json-schema","title":"ComponentForge","data":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"displayName":{"type":"string"},"url":{"type":"string"},"deprecated":{"type":"boolean"},"createDate":{"type":"string","format":"date-time"},"updateDate":{"type":"string","format":"date-time"},"data":{"type":"string"}}}},"components/schemas/ComponentImpl":{"id":"components/schemas/ComponentImpl","kind":"json-schema","title":"ComponentImpl","data":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"description":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"},"sourceRepoUrl":{"type":"string"},"encryption":{"type":"boolean"},"flagMask":{"type":"integer","format":"int32"},"modified":{"type":"boolean"},"externalId":{"type":"string"},"lastUpdateDate":{"type":"string","format":"date-time"},"popularity":{"type":"integer","format":"int32"},"registeredDate":{"type":"string","format":"date-time"},"deprecated":{"type":"boolean"},"componentForge":{"$ref":"#/components/schemas/ComponentForge"},"createdBy":{"type":"string"},"libVersions":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/ComponentVersionLib"}},"customVersions":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/ComponentVersionCustom"}},"licenses":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/License"}},"componentCPEs":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/ComponentCPELib"}},"suppressedVulnerabilities":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/VulnerabilitySuppressEntity"}},"type":{"type":"string","enum":["Component","Component Version","Website","Publication"]},"default":{"type":"boolean"},"displayName":{"type":"string"},"versions":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/ComponentVersion"}},"sortedVersions":{"type":"array","items":{"$ref":"#/components/schemas/ComponentVersion"}},"custom":{"type":"boolean"},"updatedBy":{"type":"string"},"sortedLicenses":{"type":"array","items":{"$ref":"#/components/schemas/License"}}}}},"components/schemas/ComponentVersion":{"id":"components/schemas/ComponentVersion","kind":"json-schema","title":"ComponentVersion","data":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"type":{"type":"string","enum":["Component","Component Version","Website","Publication"]},"displayName":{"type":"string"},"deprecated":{"type":"boolean"},"customVulnerabilities":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/VulnerabilityCustom"}},"licenses":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/License"}},"component":{"$ref":"#/components/schemas/ComponentImpl"},"vulnerabilities":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/Vulnerability"}},"versionName":{"type":"string"},"purl":{"type":"string"},"releaseDate":{"type":"string","format":"date-time"},"versionLicenses":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/License"}},"custom":{"type":"boolean"},"sortedLicenses":{"type":"array","items":{"$ref":"#/components/schemas/License"}},"displayVersionName":{"type":"string"}}}},"components/schemas/ComponentVersionCustom":{"id":"components/schemas/ComponentVersionCustom","kind":"json-schema","title":"ComponentVersionCustom","data":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"versionName":{"type":"string"},"component":{"$ref":"#/components/schemas/ComponentImpl"},"versionLicenses":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/License"}},"purl":{"type":"string"},"releaseDate":{"type":"string","format":"date-time"},"customVulnerabilities":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/VulnerabilityCustom"}},"libVulnerabilities":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/VulnerabilityLib"}},"type":{"type":"string","enum":["Component","Component Version","Website","Publication"]},"displayName":{"type":"string"},"deprecated":{"type":"boolean"},"licenses":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/License"}},"vulnerabilities":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/Vulnerability"}},"custom":{"type":"boolean"},"sortedLicenses":{"type":"array","items":{"$ref":"#/components/schemas/License"}},"displayVersionName":{"type":"string"}}}},"components/schemas/ComponentVersionLib":{"id":"components/schemas/ComponentVersionLib","kind":"json-schema","title":"ComponentVersionLib","data":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"versionName":{"type":"string"},"flagMask":{"type":"integer","format":"int32"},"releaseDate":{"type":"string","format":"date-time"},"modified":{"type":"boolean"},"custom":{"type":"boolean"},"externalId":{"type":"string"},"deprecated":{"type":"boolean"},"component":{"$ref":"#/components/schemas/ComponentImpl"},"purl":{"type":"string"},"flavors":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/ComponentVersionMetaData"}},"libVulnerabilities":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/VulnerabilityLib"}},"libAddVulnerabilities":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/VulnerabilityLib"}},"customVulnerabilities":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/VulnerabilityCustom"}},"versionLicenses":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/License"}},"type":{"type":"string","enum":["Component","Component Version","Website","Publication"]},"default":{"type":"boolean"},"displayName":{"type":"string"},"versionLabels":{"type":"array","items":{"type":"string"}},"licenses":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/License"}},"vulnerabilities":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/Vulnerability"}},"sortedLicenses":{"type":"array","items":{"$ref":"#/components/schemas/License"}},"displayVersionName":{"type":"string"}}}},"components/schemas/ComponentVersionMetaData":{"id":"components/schemas/ComponentVersionMetaData","kind":"json-schema","title":"ComponentVersionMetaData","data":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"componentVersion":{"$ref":"#/components/schemas/ComponentVersion"},"flavor":{"type":"string"}}}},"components/schemas/InventoryAlert":{"id":"components/schemas/InventoryAlert","kind":"json-schema","title":"InventoryAlert","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/InventoryAlertId"},"inventory":{"$ref":"#/components/schemas/InventoryGroupImpl"},"vulnerabilityAlert":{"$ref":"#/components/schemas/VulnerabilityAlert"},"priority":{"type":"string","format":"byte"},"closed":{"type":"boolean"},"closedBy":{"$ref":"#/components/schemas/User"},"closedDate":{"type":"string","format":"date-time"},"suppressClosed":{"type":"boolean"},"unsuppressCreated":{"type":"boolean"},"reason":{"type":"string","enum":["SUPPRESSED","UNSUPPRESSED","MANUAL_UPDATE"]}}}},"components/schemas/InventoryAlertId":{"id":"components/schemas/InventoryAlertId","kind":"json-schema","title":"InventoryAlertId","data":{"type":"object","properties":{"alertId":{"type":"integer","format":"int32"},"inventoryId":{"type":"integer","format":"int32"}}}},"components/schemas/InventoryFlexField":{"id":"components/schemas/InventoryFlexField","kind":"json-schema","title":"InventoryFlexField","data":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"inventoryId":{"type":"integer","format":"int32"},"flexField1":{"type":"string"},"flexField2":{"type":"string"},"flexField3":{"type":"string"},"flexField4":{"type":"string"},"flexField5":{"type":"string"},"flexField6":{"type":"string"},"flexField7":{"type":"string"},"flexField8":{"type":"string"},"flexField9":{"type":"string"},"flexField10":{"type":"string"},"flexField11":{"type":"string"},"flexField12":{"type":"string"},"flexField13":{"type":"string"},"flexField14":{"type":"string"},"flexField15":{"type":"string"}}}},"components/schemas/InventoryGroup":{"id":"components/schemas/InventoryGroup","kind":"json-schema","title":"InventoryGroup","data":{"type":"object","properties":{"licenseDetectionMethod":{"type":"string","format":"byte"},"vulnerabilityAlerts":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/InventoryAlert"}},"autoDetectionNotes":{"type":"string","description":"detection notes","example":"Note"},"associatedLicense":{"$ref":"#/components/schemas/License"},"rejectedByUpdate":{"type":"boolean"},"userUpdatedStatus":{"type":"string"},"description":{"type":"string","description":"Description","example":"Description"},"name":{"type":"string","description":"Inventory group name","example":"git"},"priority":{"$ref":"#/components/schemas/PicklistValue"},"id":{"type":"integer","description":"Inventory group id","format":"int32","example":1},"owner":{"type":"string","description":"Owner","example":"antlr"},"url":{"type":"string","description":"Url","example":"http://www.antlr.org"},"status":{"type":"string","enum":["UNUSED0","UNUSED1","UNUSED2","UNUSED3","DRAFT","READY_TO_REVIEW","APPROVED","REJECTED"]},"publishedDate":{"type":"string","description":"publishedOn","format":"date-time"},"parentGroupId":{"type":"integer","format":"int32"},"systemGenerated":{"type":"boolean","description":"System generated","example":true},"autoStatus":{"type":"string","enum":["DRAFT","PUBLISHED","NEEDS_REVIEW"]},"statusPolicyId":{"type":"integer","format":"int32"},"repoTitle":{"type":"string","writeOnly":true},"priorityId":{"type":"integer","format":"int32"},"usageText":{"type":"string","description":"get usage text","example":"usage"},"projectId":{"type":"integer","description":"Project Id","format":"int32","example":1},"published":{"type":"boolean","description":"is published","example":true},"inventoryType":{"type":"string","enum":["Work in Progress","Component","Material from Website","Material from Publication","License Only"]},"modified":{"type":"string","description":"modified","example":"Unknown","enum":["No","Yes","Unknown"]},"linking":{"type":"string","description":"link type","example":"Unknown","enum":["Unknown","Not Linked","Statically Linked","Dynamically Linked"]},"eccn":{"type":"string"},"partOfProduct":{"type":"string","description":"part of product","example":"Unknown","enum":["No","Yes","Unknown"]},"distributed":{"type":"string","description":"distribution type","example":"Unknown","enum":["Unknown","Internal","External","Hosted-Any","Hosted for Internal Use","Hosted for External Use"]},"confidence":{"type":"string","description":"Confidence","example":"1","enum":["HIGHEST","HIGH","MEDIUM","LOW"]},"disclosed":{"type":"boolean","description":"is Disclosed","example":true},"encrypted":{"type":"string","description":"encryption","example":"Unknown","enum":["No","Yes","Unknown"]},"noticeText":{"type":"string","description":"Notices text","example":"Notice text"},"copyrightText":{"type":"string"},"repositoryItem":{"$ref":"#/components/schemas/RepositoryItem"},"provenanceId":{"type":"integer","format":"int32"},"createDate":{"type":"string","description":"Create on","format":"date-time"},"updateDate":{"type":"string","description":"updatedOn","format":"date-time"},"fileCount":{"type":"integer","description":"File count","format":"int32","example":2000},"dependencyScope":{"type":"string"},"links":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/InventoryLink"}},"license":{"$ref":"#/components/schemas/License"},"auditorReviewNotes":{"type":"string","description":"audit notes","example":"good to go"},"remediationNotes":{"type":"string","description":"Remediation notes","example":"update this immediately"},"workflowURL":{"type":"string"},"skipVulnerabilities":{"type":"boolean","writeOnly":true},"associatedComponent":{"$ref":"#/components/schemas/Component"},"associatedComponentVersion":{"$ref":"#/components/schemas/ComponentVersion"},"closedVulnerabilityAlerts":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/InventoryAlert"}},"openVulnerabilityAlerts":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/InventoryAlert"}},"asFoundLicenseText":{"type":"string","description":"As found license text","example":"Sample from file LICENSE.txt in file ePortal-2.0"}}}},"components/schemas/InventoryGroupImpl":{"id":"components/schemas/InventoryGroupImpl","kind":"json-schema","title":"InventoryGroupImpl","data":{"type":"object","properties":{"id":{"type":"integer","description":"Inventory group id","format":"int32","example":1},"name":{"type":"string","description":"Inventory group name","example":"git"},"description":{"type":"string","description":"Description","example":"Description"},"owner":{"type":"string","description":"Owner","example":"antlr"},"projectId":{"type":"integer","description":"Project Id","format":"int32","example":1},"systemGenerated":{"type":"boolean","description":"System generated","example":true},"createDate":{"type":"string","description":"Create on","format":"date-time"},"updateDate":{"type":"string","description":"updatedOn","format":"date-time"},"publishedDate":{"type":"string","description":"publishedOn","format":"date-time"},"autoStatus":{"type":"string","enum":["DRAFT","PUBLISHED","NEEDS_REVIEW"]},"repositoryItem":{"$ref":"#/components/schemas/RepositoryItemImpl"},"license":{"$ref":"#/components/schemas/License"},"auditorReviewNotes":{"type":"string","description":"audit notes","example":"good to go"},"remediationNotes":{"type":"string","description":"Remediation notes","example":"update this immediately"},"autoDetectionNotes":{"type":"string","description":"detection notes","example":"Note"},"url":{"type":"string","description":"Url","example":"http://www.antlr.org"},"asFoundLicenseText":{"type":"string","description":"As found license text","example":"Sample from file LICENSE.txt in file ePortal-2.0"},"status":{"type":"string","enum":["UNUSED0","UNUSED1","UNUSED2","UNUSED3","DRAFT","READY_TO_REVIEW","APPROVED","REJECTED"]},"statusPolicyId":{"type":"integer","format":"int32"},"priority":{"$ref":"#/components/schemas/PicklistValue"},"priorityId":{"type":"integer","format":"int32"},"published":{"type":"boolean","description":"is published","example":true},"disclosed":{"type":"boolean","description":"is Disclosed","example":true},"modified":{"type":"string","description":"modified","example":"Unknown","enum":["No","Yes","Unknown"]},"usageText":{"type":"string","description":"get usage text","example":"usage"},"noticeText":{"type":"string","description":"Notices text","example":"Notice text"},"fileCount":{"type":"integer","description":"File count","format":"int32","example":2000},"parentGroupId":{"type":"integer","format":"int32"},"rejectedByUpdate":{"type":"boolean"},"confidence":{"type":"string","description":"Confidence","example":"1","enum":["HIGHEST","HIGH","MEDIUM","LOW"]},"partOfProduct":{"type":"string","description":"part of product","example":"Unknown","enum":["No","Yes","Unknown"]},"linking":{"type":"string","description":"link type","example":"Unknown","enum":["Unknown","Not Linked","Statically Linked","Dynamically Linked"]},"workflowURL":{"type":"string"},"eccn":{"type":"string"},"provenanceId":{"type":"integer","format":"int32"},"skipVulnerabilities":{"type":"boolean","writeOnly":true},"links":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/InventoryLink"}},"flexFields":{"type":"array","items":{"$ref":"#/components/schemas/InventoryFlexField"}},"customFieldModelList":{"type":"array","writeOnly":true,"items":{"$ref":"#/components/schemas/CustomFieldModel"}},"dependencyScope":{"type":"string"},"userUpdatedStatus":{"type":"string"},"cvvMD5":{"type":"string"},"licenseDetectionMethod":{"type":"string","format":"byte"},"copyrightText":{"type":"string"},"vulnerabilityAlerts":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/InventoryAlert"}},"associatedLicense":{"$ref":"#/components/schemas/License"},"repoTitle":{"type":"string","writeOnly":true},"inventoryType":{"type":"string","enum":["Work in Progress","Component","Material from Website","Material from Publication","License Only"]},"distributed":{"type":"string","description":"distribution type","example":"Unknown","enum":["Unknown","Internal","External","Hosted-Any","Hosted for Internal Use","Hosted for External Use"]},"encrypted":{"type":"string","description":"encryption","example":"Unknown","enum":["No","Yes","Unknown"]},"associatedComponent":{"$ref":"#/components/schemas/Component"},"associatedComponentVersion":{"$ref":"#/components/schemas/ComponentVersion"},"closedVulnerabilityAlerts":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/InventoryAlert"}},"openVulnerabilityAlerts":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/InventoryAlert"}}}}},"components/schemas/InventoryLink":{"id":"components/schemas/InventoryLink","kind":"json-schema","title":"InventoryLink","data":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"linkType":{"type":"string","enum":["BUNDLED","DEPENDENCY","POSSIBLY_RELATED"]},"parent":{"$ref":"#/components/schemas/InventoryGroupImpl"},"child":{"$ref":"#/components/schemas/InventoryGroupImpl"}}}},"components/schemas/Item":{"id":"components/schemas/Item","kind":"json-schema","title":"Item","data":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"type":{"type":"string","enum":["Component","Component Version","Website","Publication"]},"displayName":{"type":"string"}}}},"components/schemas/License":{"id":"components/schemas/License","kind":"json-schema","title":"License","data":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"shortName":{"type":"string"},"description":{"type":"string"},"text":{"type":"string"},"url":{"type":"string"},"category":{"type":"string","enum":["Category 1","Category 2","Category 3","Category 4","Category 5"]},"notes":{"type":"string"},"iconUrl":{"type":"string"},"flagMask":{"type":"integer","format":"int32"},"modified":{"type":"boolean"},"custom":{"type":"boolean"},"externalId":{"type":"string"},"family":{"type":"boolean"},"parentId":{"type":"integer","format":"int64"},"addToPalamidaCL":{"type":"boolean"},"author":{"type":"string"},"dfsgCompatible":{"type":"boolean"},"familyName":{"type":"string"},"deprecated":{"type":"boolean"},"noticeAttributionStatements":{"type":"string"},"noticeCopyrightStatements":{"type":"string"},"osiLicenseCategory":{"type":"string"},"osiLicenseName":{"type":"string"},"patentLicenseGrant":{"type":"boolean"},"publishedDate":{"type":"string","format":"date-time"},"publisher":{"type":"string"},"spdxLicenseIdentifier":{"type":"string"},"spdxLicenseName":{"type":"string"},"userUpdated":{"type":"boolean"},"version":{"type":"string"},"priority":{"type":"integer","format":"int32"},"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"updatedBy":{"type":"string"},"updatedOn":{"type":"string","format":"date-time"},"components":{"uniqueItems":true,"type":"array","items":{"type":"object"}},"componentVersions":{"uniqueItems":true,"type":"array","items":{"type":"object"}},"obligations":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/LicenseObligation"}},"obligationDetails":{"$ref":"#/components/schemas/LicenseObligationDetails"},"default":{"type":"boolean"},"displayName":{"type":"string"},"categoryByText":{"type":"string","writeOnly":true},"abbrevName":{"type":"string"},"commercial":{"type":"boolean"},"copyleft":{"type":"boolean"},"screenText":{"type":"string"},"screenName":{"type":"string"},"spdxNameOrName":{"type":"string"},"osiapproved":{"type":"boolean"},"gplv3Compatible":{"type":"boolean"},"gplv2Compatible":{"type":"boolean"},"freeSoftwareLicense":{"type":"boolean"},"spdxIdentifierOrName":{"type":"string"}},"description":"License","example":1}},"components/schemas/LicenseExpression":{"id":"components/schemas/LicenseExpression","kind":"json-schema","title":"LicenseExpression","data":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"licenseExpression":{"type":"string"},"userGenerated":{"type":"boolean"},"createdBy":{"type":"string"},"createdDate":{"type":"string","format":"date-time"},"updatedBy":{"type":"string"},"updatedDate":{"type":"string","format":"date-time"}}}},"components/schemas/LicenseObligation":{"id":"components/schemas/LicenseObligation","kind":"json-schema","title":"LicenseObligation","data":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"instruction":{"type":"string"},"type":{"$ref":"#/components/schemas/ObligationType"},"required":{"type":"boolean"},"priority":{"$ref":"#/components/schemas/ObligationPriority"},"organization":{"$ref":"#/components/schemas/ObligationOrganization"},"triggerAction":{"$ref":"#/components/schemas/ObligationTriggerAction"},"licenseTextSection":{"type":"string"},"licenseTextFragment":{"type":"string"}}}},"components/schemas/LicenseObligationDetails":{"id":"components/schemas/LicenseObligationDetails","kind":"json-schema","title":"LicenseObligationDetails","data":{"required":["license"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"canDo":{"type":"string"},"mustDo":{"type":"string"},"cannotDo":{"type":"string"},"license":{"$ref":"#/components/schemas/License"}}}},"components/schemas/ObligationOrganization":{"id":"components/schemas/ObligationOrganization","kind":"json-schema","title":"ObligationOrganization","data":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"}}}},"components/schemas/ObligationPriority":{"id":"components/schemas/ObligationPriority","kind":"json-schema","title":"ObligationPriority","data":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"}}}},"components/schemas/ObligationTriggerAction":{"id":"components/schemas/ObligationTriggerAction","kind":"json-schema","title":"ObligationTriggerAction","data":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"}}}},"components/schemas/ObligationType":{"id":"components/schemas/ObligationType","kind":"json-schema","title":"ObligationType","data":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"}}}},"components/schemas/Password":{"id":"components/schemas/Password","kind":"json-schema","title":"Password","data":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"password":{"type":"string"},"createDate":{"type":"string","format":"date-time"},"user":{"$ref":"#/components/schemas/User"}}}},"components/schemas/PicklistValue":{"id":"components/schemas/PicklistValue","kind":"json-schema","title":"PicklistValue","data":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["INVENTORY_STATUS","INVENTORY_PRIORITY"]},"name":{"type":"string"},"description":{"type":"string"},"isDefault":{"type":"boolean"}}}},"components/schemas/RepositoryItem":{"id":"components/schemas/RepositoryItem","kind":"json-schema","title":"RepositoryItem","data":{"type":"object","properties":{"title":{"type":"string"},"id":{"type":"integer","format":"int32"},"item":{"$ref":"#/components/schemas/Item"},"componentVersion":{"$ref":"#/components/schemas/ComponentVersion"},"inUse":{"type":"boolean"},"component":{"$ref":"#/components/schemas/Component"},"createDate":{"type":"string","format":"date-time"},"updateDate":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"license":{"$ref":"#/components/schemas/License"},"licenseId":{"type":"integer","format":"int64","writeOnly":true},"licenseExpressionId":{"type":"integer","format":"int64"},"licenseExpression":{"$ref":"#/components/schemas/LicenseExpression"}}}},"components/schemas/RepositoryItemImpl":{"id":"components/schemas/RepositoryItemImpl","kind":"json-schema","title":"RepositoryItemImpl","data":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"component":{"$ref":"#/components/schemas/ComponentImpl"},"componentVersion":{"$ref":"#/components/schemas/ComponentVersion"},"license":{"$ref":"#/components/schemas/License"},"licenseId":{"type":"integer","format":"int64"},"inUse":{"type":"boolean"},"createDate":{"type":"string","format":"date-time"},"updateDate":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"},"autoDetectionNotes":{"type":"string"},"notes":{"type":"string"},"description":{"type":"string"},"licenseExpressionId":{"type":"integer","format":"int64"},"licenseExpression":{"$ref":"#/components/schemas/LicenseExpression"},"item":{"$ref":"#/components/schemas/Item"}}}},"components/schemas/User":{"id":"components/schemas/User","kind":"json-schema","title":"User","data":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"externalId":{"type":"string"},"login":{"type":"string"},"password":{"type":"string"},"firstName":{"type":"string"},"middleName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"jobTitle":{"type":"string"},"telephone":{"type":"string"},"fax":{"type":"string"},"location":{"type":"string"},"businessUnit":{"type":"string"},"question":{"type":"string"},"answer":{"type":"string"},"createDate":{"type":"string","format":"date-time"},"updateDate":{"type":"string","format":"date-time"},"userStatus":{"$ref":"#/components/schemas/UserStatus"},"state":{"type":"string","enum":["UNUSED","ACTIVE","INACTIVE"]},"passwords":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/Password"}},"permissions":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/UserPermission"}},"lockedPermissions":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/UserPermission"}},"userLists":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/UserList"}},"userRole":{"$ref":"#/components/schemas/UserRole"},"ldapAuthenicated":{"type":"boolean"},"displayName":{"type":"string"},"lastUpdatedDate":{"type":"string","format":"date-time"},"displayNameWithLogin":{"type":"string"}}}},"components/schemas/UserList":{"id":"components/schemas/UserList","kind":"json-schema","title":"UserList","data":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"},"ldapPopulated":{"type":"boolean"},"owner":{"$ref":"#/components/schemas/User"},"users":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/User"}},"subUserList":{"uniqueItems":true,"type":"array","writeOnly":true,"items":{"$ref":"#/components/schemas/UserList"}},"permissions":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/UserPermission"}},"allUsers":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/User"}}}}},"components/schemas/UserPermission":{"id":"components/schemas/UserPermission","kind":"json-schema","title":"UserPermission","data":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"scope":{"type":"string"},"description":{"type":"string"}}}},"components/schemas/UserRole":{"id":"components/schemas/UserRole","kind":"json-schema","title":"UserRole","data":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"}}}},"components/schemas/UserStatus":{"id":"components/schemas/UserStatus","kind":"json-schema","title":"UserStatus","data":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"code":{"type":"integer","format":"int32"},"name":{"type":"string"}}}},"components/schemas/Vulnerability":{"id":"components/schemas/Vulnerability","kind":"json-schema","title":"Vulnerability","data":{"type":"object","properties":{"description":{"type":"string"},"name":{"type":"string"},"id":{"type":"integer","format":"int64"},"children":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/Vulnerability"}},"severity":{"type":"string"},"source":{"type":"string"},"url":{"type":"string"},"originalReleaseDate":{"type":"string","format":"date-time"},"vulnerabilityReferences":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/VulnerabilityReferencesEntity"}},"vulnerabilityCWE":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/VulnerabilityCweEntity"}},"shallowCopy":{"$ref":"#/components/schemas/Vulnerability"},"kev":{"type":"boolean"},"lastRevisedDate":{"type":"string","format":"date-time"},"registry":{"$ref":"#/components/schemas/VulnerabilityRegistry"},"score":{"type":"number"},"cvssv2Score":{"type":"number"},"cvssv2Severity":{"type":"string"},"cvssv3Score":{"type":"number"},"cvssv2Vector":{"type":"string"},"cvssv4Score":{"type":"number"},"cvssv3Vector":{"type":"string"},"cvssv4Vector":{"type":"string"},"cvssv4Severity":{"type":"string"},"epssScore":{"type":"number"},"epssPercentile":{"type":"number"},"cvssv3Severity":{"type":"string"},"severityAsInteger":{"type":"integer","format":"int32"}}}},"components/schemas/VulnerabilityAlert":{"id":"components/schemas/VulnerabilityAlert","kind":"json-schema","title":"VulnerabilityAlert","data":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"createDate":{"type":"string","format":"date-time"},"owner":{"$ref":"#/components/schemas/User"},"vulnerability":{"$ref":"#/components/schemas/VulnerabilityLib"},"updateId":{"type":"integer","format":"int64"},"inventoryAlerts":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/InventoryAlert"}}}}},"components/schemas/VulnerabilityCustom":{"id":"components/schemas/VulnerabilityCustom","kind":"json-schema","title":"VulnerabilityCustom","data":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"description":{"type":"string"},"cvssv2Score":{"type":"number"},"cvssv2Severity":{"type":"string"},"cvssv3Score":{"type":"number"},"cvssv3Severity":{"type":"string"},"cvssv4Score":{"type":"number"},"cvssv4Severity":{"type":"string"},"url":{"type":"string"},"lastRevisedDate":{"type":"string","format":"date-time"},"originalReleaseDate":{"type":"string","format":"date-time"},"source":{"type":"string"},"registry":{"$ref":"#/components/schemas/VulnerabilityRegistry"},"customComponentVersions":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/ComponentVersionCustom"}},"libComponentVersions":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/ComponentVersionLib"}},"children":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/Vulnerability"}},"severity":{"type":"string"},"vulnerabilityReferences":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/VulnerabilityReferencesEntity"}},"vulnerabilityCWE":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/VulnerabilityCweEntity"}},"kev":{"type":"boolean"},"score":{"type":"number"},"cvssv2Vector":{"type":"string"},"cvssv3Vector":{"type":"string"},"cvssv4Vector":{"type":"string"},"epssScore":{"type":"number"},"epssPercentile":{"type":"number"},"severityAsInteger":{"type":"integer","format":"int32"},"shallowCopy":{"$ref":"#/components/schemas/Vulnerability"}}}},"components/schemas/VulnerabilityCweEntity":{"id":"components/schemas/VulnerabilityCweEntity","kind":"json-schema","title":"VulnerabilityCweEntity","data":{"type":"object","properties":{"name":{"type":"string"},"title":{"type":"string"}}}},"components/schemas/VulnerabilityLib":{"id":"components/schemas/VulnerabilityLib","kind":"json-schema","title":"VulnerabilityLib","data":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"description":{"type":"string"},"cvssv2Score":{"type":"number"},"cvssv2Severity":{"type":"string"},"cvssv3Score":{"type":"number"},"cvssv3Severity":{"type":"string"},"cvssv4Score":{"type":"number"},"cvssv4Severity":{"type":"string"},"url":{"type":"string"},"custom":{"type":"boolean"},"lastRevisedDate":{"type":"string","format":"date-time"},"originalReleaseDate":{"type":"string","format":"date-time"},"source":{"type":"string"},"registry":{"$ref":"#/components/schemas/VulnerabilityRegistry"},"deprecated":{"type":"boolean"},"customComponentVersions":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/ComponentVersionCustom"}},"libComponentVersions":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/ComponentVersionLib"}},"children":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/Vulnerability"}},"cvssv2Vector":{"type":"string"},"cvssv3Vector":{"type":"string"},"cvssv4Vector":{"type":"string"},"epssScore":{"type":"number"},"epssPercentile":{"type":"number"},"vulnerabilityCWE":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/VulnerabilityCweEntity"}},"vulnerabilityReferences":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/VulnerabilityReferencesEntity"}},"kev":{"type":"boolean"},"severity":{"type":"string"},"score":{"type":"number"},"severityAsInteger":{"type":"integer","format":"int32"},"shallowCopy":{"$ref":"#/components/schemas/Vulnerability"}}}},"components/schemas/VulnerabilityReferencesEntity":{"id":"components/schemas/VulnerabilityReferencesEntity","kind":"json-schema","title":"VulnerabilityReferencesEntity","data":{"type":"object","properties":{"url":{"type":"string"}}}},"components/schemas/VulnerabilityRegistry":{"id":"components/schemas/VulnerabilityRegistry","kind":"json-schema","title":"VulnerabilityRegistry","data":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"},"url":{"type":"string"}}}},"components/schemas/VulnerabilitySuppressEntity":{"id":"components/schemas/VulnerabilitySuppressEntity","kind":"json-schema","title":"VulnerabilitySuppressEntity","data":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"componentId":{"type":"integer","format":"int64"},"componentName":{"type":"string"},"vulnerabilityId":{"type":"integer","format":"int64"},"vulnerabilityName":{"type":"string"},"versionScope":{"type":"string","enum":["SPECIFIC_VERSIONS","ALL_CURRENT_VERSIONS"]},"suppressedVersions":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/VulnerabilitySuppressedVersionEntity"}},"createdDate":{"type":"string","format":"date-time"},"updatedDate":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"}}}},"components/schemas/VulnerabilitySuppressedVersionEntity":{"id":"components/schemas/VulnerabilitySuppressedVersionEntity","kind":"json-schema","title":"VulnerabilitySuppressedVersionEntity","data":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"versionId":{"type":"integer","format":"int64"},"versionName":{"type":"string"},"reason":{"type":"string","enum":["FALSE_POSITIVE","REMEDIATED","OTHER"]},"remarks":{"type":"string"},"status":{"type":"string","enum":["Suppress","UnSuppress"]},"suppressEntity":{"$ref":"#/components/schemas/VulnerabilitySuppressEntity"},"createdDate":{"type":"string","format":"date-time"},"updatedDate":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"suppressionScope":{"type":"integer","format":"int32"}}}},"components/schemas/ReportsModel":{"id":"components/schemas/ReportsModel","kind":"json-schema","title":"ReportsModel","data":{"type":"object","properties":{"otherProjectId":{"type":"integer","description":"otherProjectId","format":"int32","example":1},"options":{"type":"object","additionalProperties":{"type":"string","description":"options"},"description":"options"}}}},"components/schemas/ProjectRoleModel":{"id":"components/schemas/ProjectRoleModel","kind":"json-schema","title":"ProjectRoleModel","data":{"type":"object","properties":{"ownerId":{"type":"string","description":"ownerId","example":"admin"},"securityContactId":{"type":"string","description":"securityContactId","example":"admin"},"developerContactId":{"type":"string","description":"developerContactId","example":"admin"},"legalContactId":{"type":"string","description":"legalContactId","example":"admin"},"userRoles":{"$ref":"#/components/schemas/usersRole"},"legalContact":{"type":"string","writeOnly":true}}}},"components/schemas/usersRole":{"id":"components/schemas/usersRole","kind":"json-schema","title":"usersRole","data":{"required":["roleId","users"],"type":"object","properties":{"roleId":{"type":"string","description":"roleId","example":"ANALYST"},"users":{"type":"array","description":"users","items":{"type":"string","description":"users"}}}}},"components/schemas/ProjectModel":{"id":"components/schemas/ProjectModel","kind":"json-schema","title":"ProjectModel","data":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"name","example":"eportal"},"description":{"type":"string","description":"description","example":"description"},"folderName":{"type":"string","description":"folderName","example":"Projects"},"policyProfileName":{"type":"string","description":"policyProfileName","example":"Default License Policy Profile"},"scanProfileName":{"type":"string","description":"scanProfileName","example":"Basic Scan Profile (Without CL)"},"autoPublish":{"type":"boolean","description":"autoPublish","example":true},"markAssociatedFilesAsReviewed":{"type":"boolean","description":"markAssociatedFilesAsReviewed","example":true},"owner":{"type":"string","description":"owner","example":"admin"},"risk":{"pattern":"HIGH|MEDIUM|LOW","type":"string","description":"risk","example":"HIGH | default: MEDIUM","enum":["HIGH","MEDIUM","LOW"]},"privateProject":{"type":"boolean","description":"privateProject","example":false},"scanServerAlias":{"type":"string","description":"scanServerAlias","example":"null"},"deleteEmptyInventory":{"type":"boolean","description":"deleteEmptyInventory","example":false},"doNotPublishInventoryUnknownLicense":{"type":"boolean","description":"doNotPublishInventoryUnknownLicense","example":true},"folderId":{"type":"integer","format":"int32","example":1},"expandJarArchives":{"type":"boolean","description":"expandJarArchives","example":false},"eccn":{"maxLength":256,"minLength":0,"type":"string","description":"eccn","example":"5D002"},"customFields":{"type":"array","description":"customFields","items":{"$ref":"#/components/schemas/CustomFieldModel"}}}}},"components/schemas/ExtendedProjectModel":{"id":"components/schemas/ExtendedProjectModel","kind":"json-schema","title":"ExtendedProjectModel","data":{"type":"object","properties":{"name":{"type":"string","description":"name","example":"eportal"},"description":{"type":"string","description":"description","example":"description"},"folderName":{"type":"string","description":"folderName","example":"Projects"},"policyProfileName":{"type":"string","description":"policyProfileName","example":"Default License Policy Profile"},"scanProfileName":{"type":"string","description":"scanProfileName","example":"Basic Scan Profile (Without CL)"},"autoPublish":{"type":"boolean","description":"autoPublish","example":true},"markAssociatedFilesAsReviewed":{"type":"boolean","description":"markAssociatedFilesAsReviewed","example":true},"owner":{"type":"string","description":"owner","example":"admin"},"risk":{"pattern":"HIGH|MEDIUM|LOW","type":"string","description":"risk","example":"HIGH | default: MEDIUM","enum":["HIGH","MEDIUM","LOW"]},"privateProject":{"type":"boolean","description":"privateProject","example":false},"deleteEmptyInventory":{"type":"boolean","description":"deleteEmptyInventory","example":false},"doNotPublishInventoryUnknownLicense":{"type":"boolean","description":"doNotPublishInventoryUnknownLicense","example":true},"folderId":{"type":"integer","format":"int32","example":1},"expandJarArchives":{"type":"boolean","description":"expandJarArchives","example":false},"eccn":{"maxLength":256,"minLength":0,"type":"string","description":"eccn","example":"5D002"},"customFields":{"type":"array","description":"customFields","items":{"$ref":"#/components/schemas/CustomFieldModel"}}}}},"components/schemas/ProjectContact":{"id":"components/schemas/ProjectContact","kind":"json-schema","title":"ProjectContact","data":{"required":["contact"],"type":"object","properties":{"contact":{"type":"string","description":"contact","example":"admin"}}}},"components/schemas/ReportCriteriaModel":{"id":"components/schemas/ReportCriteriaModel","kind":"json-schema","title":"ReportCriteriaModel","data":{"required":["description","label","name","order","type"],"type":"object","properties":{"name":{"type":"string","description":"name","example":"Name of the Report Parameter"},"label":{"maxLength":120,"minLength":0,"type":"string","description":"label","example":"Display Name of the Report Parameter"},"description":{"maxLength":300,"minLength":0,"type":"string","description":"description","example":"Description of the Report Parameter"},"type":{"type":"string","description":"type","example":"Type of the Report Parameter"},"defaultValue":{"type":"string","description":"defaultValue","example":"Default value of the Report Parameter"},"required":{"type":"boolean","description":"required","example":false},"order":{"minimum":1,"type":"integer","description":"order","format":"int32","example":4}}}},"components/schemas/ReportModel":{"id":"components/schemas/ReportModel","kind":"json-schema","title":"ReportModel","data":{"required":["name","order","path"],"type":"object","properties":{"name":{"type":"string","description":"name","example":"Name of the report"},"path":{"type":"string","description":"path","example":"Path of the report"},"enabled":{"type":"boolean","description":"enabled","example":true},"order":{"minimum":1,"type":"integer","description":"order","format":"int32","example":4},"enableProjectPicker":{"type":"boolean","description":"enableProjectPicker","example":false},"reportOptions":{"type":"array","items":{"$ref":"#/components/schemas/ReportCriteriaModel"}}}}},"components/schemas/ExtendedReportModel":{"id":"components/schemas/ExtendedReportModel","kind":"json-schema","title":"ExtendedReportModel","data":{"required":["name","order","path"],"type":"object","properties":{"id":{"type":"integer","description":"id","format":"int32","example":1},"name":{"type":"string","description":"name","example":"Name of the report"},"path":{"type":"string","description":"path","example":"Path of the report"},"enabled":{"type":"boolean","description":"enabled","example":true},"order":{"minimum":1,"type":"integer","description":"order","format":"int32","example":4},"enableProjectPicker":{"type":"boolean","description":"enableProjectPicker","example":false},"reportOptions":{"type":"array","items":{"$ref":"#/components/schemas/ReportCriteriaModel"}}}}},"components/schemas/FileInfo":{"id":"components/schemas/FileInfo","kind":"json-schema","title":"FileInfo","data":{"required":["md5","name"],"type":"object","properties":{"name":{"type":"string","description":"name","example":"fileName"},"md5":{"type":"string","description":"md5","example":"md5"}},"description":"fileInfo"}},"components/schemas/RuleInfo":{"id":"components/schemas/RuleInfo","kind":"json-schema","title":"RuleInfo","data":{"required":["detectionCriteria","detectionType"],"type":"object","properties":{"detectionType":{"type":"string","description":"detectionType","example":"filePath"},"detectionCriteria":{"type":"array","description":"detectionCriteria","example":"[filepath]","items":{"type":"string","description":"detectionCriteria","example":"[filepath]"}}},"description":"ruleInfo"}},"components/schemas/RuleModel":{"id":"components/schemas/RuleModel","kind":"json-schema","title":"RuleModel","data":{"required":["componentId","licenseId","versionId"],"type":"object","properties":{"inventoryName":{"type":"string","description":"inventoryName","example":"Custom Inventory Name"},"componentId":{"minimum":1,"type":"integer","description":"componentId","format":"int64","example":1},"versionId":{"minimum":1,"type":"integer","description":"versionId","format":"int64","example":1},"licenseId":{"type":"integer","description":"licenseId","format":"int64","example":1},"licenseExpression":{"type":"string","description":"License expression string","example":"7 OR 20"},"licenseIds":{"type":"array","description":"List of license IDs in the expression","example":[7,20],"items":{"type":"integer","description":"List of license IDs in the expression","format":"int64"}},"description":{"type":"string","description":"description","example":"description"},"url":{"maxLength":2400,"minLength":0,"pattern":"(NA|^https?:\\/\\/(www\\.)?[-a-zA-Z0-9@:%._\\+~#=]{2,256}\\.[a-z]{2,6}\\b([-a-zA-Z0-9@:%_\\+.~#?&\\/\\/=]*))","type":"string","description":"url","example":"https://www.flexera.com/"},"noticesText":{"type":"string","description":"noticesText","example":"Sample Notices Text"},"auditNotes":{"type":"string","description":"auditNotes","example":"Sample Audit Notes"},"asFoundLicenseText":{"type":"string","description":"asFoundLicenseText","example":"Sample from file LICENSE.txt in file @file in the materials"},"fileInfo":{"type":"array","description":"fileInfo","items":{"$ref":"#/components/schemas/FileInfo"}},"ruleInfo":{"type":"array","description":"ruleInfo","items":{"$ref":"#/components/schemas/RuleInfo"}}}}},"components/schemas/ExtendedRuleModel":{"id":"components/schemas/ExtendedRuleModel","kind":"json-schema","title":"ExtendedRuleModel","data":{"required":["componentId","licenseId","versionId"],"type":"object","properties":{"id":{"type":"integer","description":"id","format":"int64","example":1},"inventoryName":{"type":"string","description":"inventoryName","example":"Custom Inventory Name"},"componentId":{"minimum":1,"type":"integer","description":"componentId","format":"int64","example":1},"versionId":{"minimum":1,"type":"integer","description":"versionId","format":"int64","example":1},"licenseId":{"type":"integer","description":"licenseId","format":"int64","example":1},"licenseExpression":{"type":"string","description":"License expression string","example":"7 OR 20"},"licenseIds":{"type":"array","description":"List of license IDs in the expression","example":[7,20],"items":{"type":"integer","description":"List of license IDs in the expression","format":"int64"}},"description":{"type":"string","description":"description","example":"description"},"url":{"maxLength":2400,"minLength":0,"pattern":"(NA|^https?:\\/\\/(www\\.)?[-a-zA-Z0-9@:%._\\+~#=]{2,256}\\.[a-z]{2,6}\\b([-a-zA-Z0-9@:%_\\+.~#?&\\/\\/=]*))","type":"string","description":"url","example":"https://www.flexera.com/"},"noticesText":{"type":"string","description":"noticesText","example":"Sample Notices Text"},"auditNotes":{"type":"string","description":"auditNotes","example":"Sample Audit Notes"},"asFoundLicenseText":{"type":"string","description":"asFoundLicenseText","example":"Sample from file LICENSE.txt in file @file in the materials"},"fileInfo":{"type":"array","description":"fileInfo","items":{"$ref":"#/components/schemas/FileInfo"}},"ruleInfo":{"type":"array","description":"ruleInfo","items":{"$ref":"#/components/schemas/RuleInfo"}}}}},"components/schemas/GITSCMModel":{"id":"components/schemas/GITSCMModel","kind":"json-schema","title":"GITSCMModel","data":{"required":["url"],"type":"object","properties":{"url":{"maxLength":65535,"minLength":0,"type":"string","description":"url","example":"E.g. https://host.xz/path/to/repo.git or https://host.xz/path/to/repo.git~~branch1 or user@host:path/repo.git>>cmID123 or https://host.xz/path/to/repo.git^^tag1.1 or https://host.xz/path/to/repo.git~~branch1**FolderA or user@host:path/repo.git>>cmID123**FolderB or https://host.xz/path/to/repo.git^^tag1.1**FolderC or https://host.xz/path/to/repo.git**FolderD"},"userName":{"maxLength":255,"minLength":0,"type":"string","description":"userName","example":"abc"},"password":{"maxLength":255,"minLength":0,"type":"string","description":"password","example":"abc"},"branch":{"maxLength":255,"minLength":0,"type":"string","description":"branch","example":"master"},"commitId":{"maxLength":255,"minLength":0,"type":"string","description":"commitId"},"tag":{"maxLength":255,"minLength":0,"type":"string","description":"tag"},"deleteArchiveAfterExpand":{"type":"boolean","description":"deleteArchiveAfterExpand","example":true,"default":false},"expansionLevel":{"type":"integer","description":"expansionLevel","format":"int32","example":2,"enum":[1,2,3],"default":1},"archiveDirSuffix":{"maxLength":20,"minLength":0,"type":"string","description":"archiveDirSuffix","example":"_Expanded"},"includeSubmodules":{"type":"boolean","description":"Include submodules during sync.","example":true,"default":true}}}},"components/schemas/SCMModel":{"id":"components/schemas/SCMModel","kind":"json-schema","title":"SCMModel","data":{"type":"object","properties":{"propertyList":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"}}},"scmtype":{"type":"string"}}}},"components/schemas/SubversionSCMModel":{"id":"components/schemas/SubversionSCMModel","kind":"json-schema","title":"SubversionSCMModel","data":{"required":["url"],"type":"object","properties":{"url":{"maxLength":2400,"minLength":0,"type":"string","description":"url"},"userName":{"maxLength":255,"minLength":0,"type":"string","description":"userName","example":"abc"},"password":{"maxLength":255,"minLength":0,"type":"string","description":"password","example":"abc"},"revisionNumber":{"maxLength":255,"minLength":0,"type":"string","description":"revisionNumber"}}}},"components/schemas/TFSSCMModel":{"id":"components/schemas/TFSSCMModel","kind":"json-schema","title":"TFSSCMModel","data":{"required":["password","url","username"],"type":"object","properties":{"url":{"maxLength":2400,"minLength":0,"type":"string","description":"url"},"username":{"maxLength":255,"minLength":0,"type":"string","description":"userName","example":"abc"},"password":{"maxLength":255,"minLength":0,"type":"string","description":"password","example":"abc"},"changeSet":{"maxLength":255,"minLength":0,"type":"string","description":"changeSet"},"label":{"maxLength":255,"minLength":0,"type":"string","description":"label"}}}},"components/schemas/TaskCommentModel":{"id":"components/schemas/TaskCommentModel","kind":"json-schema","title":"TaskCommentModel","data":{"required":["commentText"],"type":"object","properties":{"commentText":{"maxLength":1000,"minLength":1,"type":"string"}}}},"components/schemas/AlmIssues":{"id":"components/schemas/AlmIssues","kind":"json-schema","title":"AlmIssues","data":{"required":["ids"],"type":"object","properties":{"ids":{"type":"array","description":"almIssueId","items":{"type":"integer","description":"almIssueId","format":"int32"}}}}},"components/schemas/WorkflowTaskModel":{"id":"components/schemas/WorkflowTaskModel","kind":"json-schema","title":"WorkflowTaskModel","data":{"type":"object","properties":{"owner":{"type":"string","description":"owner","example":"admin"},"summary":{"type":"string","description":"summary","example":"Summary for the task"},"priority":{"type":"string","description":"priority","example":"MEDIUM","enum":["LOW","MEDIUM","HIGH"]},"type":{"type":"string","description":"type","example":"MISCELLANEOUS","enum":["MISCELLANEOUS","MANUAL_INVENTORY_REVIEW","REMEDIATE_INVENTORY"]},"details":{"type":"string","description":"details","example":"Details of the task"}}}},"components/schemas/ExtendedWorkflowTaskModel":{"id":"components/schemas/ExtendedWorkflowTaskModel","kind":"json-schema","title":"ExtendedWorkflowTaskModel","data":{"type":"object","properties":{"summary":{"type":"string","description":"summary","example":"Summary for the task"},"priority":{"type":"string","description":"priority","example":"MEDIUM","enum":["LOW","MEDIUM","HIGH"]},"details":{"type":"string","description":"details","example":"Details of the task"}}}},"components/schemas/UserDefinedLicenseEvidenceRequest":{"id":"components/schemas/UserDefinedLicenseEvidenceRequest","kind":"json-schema","title":"UserDefinedLicenseEvidenceRequest","data":{"required":["licenseFragment","licenseId"],"type":"object","properties":{"licenseFragment":{"type":"string","description":"Exact text fragment to match in scanned files","example":"MIT License"},"licenseId":{"type":"integer","description":"ID of the license to associate with matched files","format":"int64","example":42}},"description":"Request body for a user-defined license evidence rule"}},"components/schemas/UserModel":{"id":"components/schemas/UserModel","kind":"json-schema","title":"UserModel","data":{"required":["answer","email","firstName","lastName","login","password","question"],"type":"object","properties":{"login":{"maxLength":60,"minLength":1,"type":"string","description":"login","example":"admin"},"firstName":{"maxLength":60,"minLength":1,"type":"string","description":"firstName","example":"John"},"lastName":{"maxLength":60,"minLength":1,"type":"string","description":"lastName","example":"Miller"},"email":{"pattern":"^(.+)@(.+)$","type":"string","description":"email","example":"john@yahoomail.com"},"password":{"pattern":"(?=.*[0-9])(?=.*[a-z])(?=.*[A-Z])(?=\\S+$).{8,}","type":"string","description":"password","example":"Password123"},"question":{"maxLength":300,"minLength":3,"type":"string","description":"question","example":"What is your best friend name?"},"answer":{"maxLength":2147483647,"minLength":3,"type":"string","description":"answer","example":"Jim"}}}},"components/schemas/PermissionsWrapper":{"id":"components/schemas/PermissionsWrapper","kind":"json-schema","title":"PermissionsWrapper","data":{"required":["permissions"],"type":"object","properties":{"permissions":{"type":"array","description":"permissions","items":{"type":"string","description":"permissions"}}}}},"components/schemas/SuppressedVulnerabilityModel":{"id":"components/schemas/SuppressedVulnerabilityModel","kind":"json-schema","title":"SuppressedVulnerabilityModel","data":{"type":"object","properties":{"itemNumber":{"type":"integer","format":"int32"},"suppressId":{"type":"integer","format":"int64"},"suppressionScope":{"type":"string"},"vulnerabilityId":{"type":"integer","format":"int64"},"vulnerabilityName":{"type":"string"},"componentId":{"type":"integer","format":"int64"},"componentName":{"type":"string"},"suppressedBy":{"type":"string"},"suppressedDate":{"type":"string"},"suppressionDetails":{"type":"array","items":{"$ref":"#/components/schemas/SuppressionDetailsResponseModel"}},"componentVersionIds":{"type":"array","items":{"type":"integer","format":"int64"}}}}},"components/schemas/SuppressionDetailsResponseModel":{"id":"components/schemas/SuppressionDetailsResponseModel","kind":"json-schema","title":"SuppressionDetailsResponseModel","data":{"type":"object","properties":{"projectId":{"type":"integer","format":"int32"},"state":{"type":"string"},"justification":{"type":"string"},"response":{"type":"string"}}}},"components/schemas/VersionSuppressModel":{"id":"components/schemas/VersionSuppressModel","kind":"json-schema","title":"VersionSuppressModel","data":{"type":"object","properties":{"suppressId":{"type":"integer","format":"int64"},"vulnerabilityName":{"type":"string"},"componentName":{"type":"string"},"versionId":{"type":"integer","format":"int64"},"versionName":{"type":"string"},"suppressedReason":{"type":"string"},"suppressedRemarks":{"type":"string"},"suppressedBy":{"type":"string"},"suppressedDate":{"type":"string"}}}},"components/schemas/SuppressionDetails":{"id":"components/schemas/SuppressionDetails","kind":"json-schema","title":"SuppressionDetails","data":{"required":["justification","response","state"],"type":"object","properties":{"projectId":{"type":"integer","description":"projectId","format":"int32","example":123},"state":{"type":"string","description":"state","example":"RESOLVED|RESOLVED_WITH_PEDIGREE|EXPLOITABLE|IN_TRIAGE|FALSE_POSITIVE"},"justification":{"type":"string","description":"justification","example":"CODE_NOT_PRESENT|CODE_NOT_REACHABLE|REQUIRES_CONFIGURATION|REQUIRES_DEPENDENCY|REQUIRES_ENVIRONMENT|PROTECTED_BY_COMPILER|PROTECTED_AT_RUNTIME|PROTECTED_AT_PERIMETER|PROTECTED_BY_MITIGATING_CONTROL"},"response":{"type":"string","description":"response","example":"CAN_NOT_FIX|WILL_NOT_FIX|UPDATE|ROLLBACK|WORKAROUND_AVAILABLE"}},"description":"suppressionDetails"}},"components/schemas/VulnerabilitySuppressModel":{"id":"components/schemas/VulnerabilitySuppressModel","kind":"json-schema","title":"VulnerabilitySuppressModel","data":{"required":["componentId","reason","remarks","suppressionScope","versionScope","vulnerabilityName"],"type":"object","properties":{"componentId":{"minimum":1,"type":"integer","description":"componentId","format":"int64","example":1},"versionIds":{"uniqueItems":true,"type":"array","description":"versionIds","items":{"type":"integer","description":"versionIds","format":"int64"}},"vulnerabilityName":{"type":"string","description":"vulnerabilityName","example":"Vulnerability Name"},"reason":{"type":"string","description":"reason","example":"FALSE_POSITIVE|REMEDIATED|OTHER"},"remarks":{"maxLength":255,"minLength":0,"type":"string","description":"remarks","example":"Remarks to Suppress Vulnerability"},"versionScope":{"pattern":"SPECIFIC_VERSIONS|ALL_CURRENT_VERSIONS","type":"string","description":"versionScope","example":"SPECIFIC_VERSIONS|ALL_CURRENT_VERSIONS"},"suppressionScope":{"pattern":"GLOBAL|PROJECT","type":"string","description":"suppressionScope","example":"GLOBAL|PROJECT"},"suppressionDetails":{"$ref":"#/components/schemas/SuppressionDetails"}}}},"components/schemas/VulnerabilityUnsuppressModel":{"id":"components/schemas/VulnerabilityUnsuppressModel","kind":"json-schema","title":"VulnerabilityUnsuppressModel","data":{"required":["componentId","remarks","vulnerabilityName"],"type":"object","properties":{"vulnerabilityName":{"type":"string","description":"vulnerabilityName","example":"Vulnerability Name"},"componentId":{"minimum":1,"type":"integer","description":"componentId","format":"int64","example":1},"versionIds":{"uniqueItems":true,"type":"array","description":"versionIds","items":{"type":"integer","description":"versionIds","format":"int64"}},"remarks":{"maxLength":255,"minLength":0,"type":"string","description":"remarks","example":"Remarks to Unsuppress Vulnerability"},"projectId":{"minimum":1,"type":"integer","description":"projectId","format":"int32","example":1}}}},"components/schemas/ProjectImportModel":{"id":"components/schemas/ProjectImportModel","kind":"json-schema","title":"ProjectImportModel","data":{"required":["addFilesToInventory","markFilesAsReviewed"],"type":"object","properties":{"createEmptyInventory":{"type":"boolean","description":"createEmptyInventory","example":false},"overwriteInventoryNotes":{"type":"boolean","description":"overwriteInventoryNotes","example":true},"addFilesToInventory":{"type":"boolean","description":"addFilesToInventory","example":true},"inventoryFileMatchingCriteria":{"pattern":"COMPLETE_FILEPATH|PARTIAL_FILEPATH|FILENAME|MD5|MD5_AND_FILENAME|MD5_AND_COMPLETE_FILEPATH|MD5_AND_PARTIAL_FILEPATH","type":"string","description":"inventoryFileMatchingCriteria","example":"COMPLETE_FILEPATH"},"inventoryDirectoryDepth":{"maximum":20,"minimum":1,"type":"integer","description":"inventoryDirectoryDepth","format":"int32"},"markFilesAsReviewed":{"type":"boolean","description":"markFilesAsReviewed","example":true},"reviewFileMatchingCriteria":{"pattern":"COMPLETE_FILEPATH|PARTIAL_FILEPATH|FILENAME|MD5|MD5_AND_FILENAME|MD5_AND_COMPLETE_FILEPATH|MD5_AND_PARTIAL_FILEPATH","type":"string","description":"reviewFileMatchingCriteria","example":"MD5_AND_COMPLETE_FILEPATH"},"reviewDirectoryDepth":{"maximum":20,"minimum":1,"type":"integer","description":"reviewDirectoryDepth","format":"int32"},"resetInventoryUsage":{"type":"boolean","description":"resetInventoryUsage","example":true}}}},"schema_57":{"kind":"json-schema","data":{"type":"string"},"id":"schema_57"},"schema_58":{"kind":"json-schema","data":{"minimum":1,"exclusiveMinimum":false,"type":"integer","format":"int64"},"id":"schema_58"},"schema_59":{"kind":"json-schema","data":{"type":"boolean","default":false},"id":"schema_59"},"schema_60":{"kind":"json-schema","data":{"type":"integer","format":"int64","default":100},"id":"schema_60"},"schema_61":{"kind":"json-schema","data":{"type":"integer","format":"int64","default":1},"id":"schema_61"},"schema_62":{"kind":"json-schema","data":{"type":"integer","format":"int64"},"id":"schema_62"},"schema_63":{"kind":"json-schema","data":{"minimum":1,"type":"integer","format":"int64"},"id":"schema_63"},"schema_64":{"kind":"json-schema","data":{"type":"integer","format":"int32"},"id":"schema_64"},"schema_65":{"kind":"json-schema","data":{"type":"string","format":"binary","readOnly":true,"default":""},"id":"schema_65"},"schema_66":{"kind":"json-schema","data":{"pattern":"NAME|URL|CPE|FORGE","type":"string","enum":["NAME","URL","CPE","FORGE"],"default":"NAME"},"id":"schema_66"},"schema_67":{"kind":"json-schema","data":{"type":"string","enum":["ALL_TERMS","ANY_TERM","BEGINS_WITH","EXACT_MATCH"]},"id":"schema_67"},"schema_68":{"kind":"json-schema","data":{"pattern":"SourceForge|Apache|MySQL AB|Java.net|GNU|Free Software Directory|CodePlex|Savannah|Google Code|Hackage|NuGet Gallery|npm|CentOS Project|PyPI|Google's Maven Repository|Clojars|Ibiblio Maven2|Packagist|GitHub|RubyGems|crates.io|CRAN|CPAN|Fedora Koji|GitLab|Conan","type":"string","enum":["SourceForge","Apache","MySQL AB","Java.net","GNU","Free Software Directory","CodePlex","Savannah","Google Code","Hackage","NuGet Gallery","npm","CentOS Project","PyPI","Google's Maven Repository","Clojars","Ibiblio Maven2","Packagist","GitHub","RubyGems","crates.io","CRAN","CPAN","Fedora Koji","GitLab","Conan"]},"id":"schema_68"},"schema_69":{"kind":"json-schema","data":{"minimum":1,"exclusiveMinimum":false,"type":"integer","format":"int32","default":100},"id":"schema_69"},"schema_70":{"kind":"json-schema","data":{"minimum":1,"exclusiveMinimum":false,"type":"integer","format":"int32","default":1},"id":"schema_70"},"schema_71":{"kind":"json-schema","data":{"type":"boolean","default":true},"id":"schema_71"},"schema_72":{"kind":"json-schema","data":{"type":"string","enum":["V2","V3","ANY"]},"id":"schema_72"},"schema_73":{"kind":"json-schema","data":{"minimum":1,"exclusiveMinimum":false,"type":"integer","format":"int64","default":25},"id":"schema_73"},"schema_74":{"kind":"json-schema","data":{"minimum":1,"exclusiveMinimum":false,"type":"integer","format":"int64","default":1},"id":"schema_74"},"schema_75":{"kind":"json-schema","data":{"minimum":1,"type":"integer","format":"int32"},"id":"schema_75"},"schema_76":{"kind":"json-schema","data":{"minimum":1,"type":"integer","format":"int64","default":1},"id":"schema_76"},"schema_77":{"kind":"json-schema","data":{"minimum":1,"type":"integer","format":"int64","default":25},"id":"schema_77"},"schema_78":{"kind":"json-schema","data":{"type":"string","default":"All"},"id":"schema_78"},"schema_79":{"kind":"json-schema","data":{"type":"string","enum":["READY_TO_REVIEW","DRAFT","APPROVED","REJECTED"]},"id":"schema_79"},"schema_80":{"kind":"json-schema","data":{"type":"string","enum":["OPEN","CLOSED","ANY"]},"id":"schema_80"},"schema_81":{"kind":"json-schema","data":{"type":"string","enum":["new","scheduled","active","waiting on update","waiting on library refresh","canceled","terminated","failed","completed"]},"id":"schema_81"},"schema_82":{"kind":"json-schema","data":{"type":"boolean","readOnly":true},"id":"schema_82"},"schema_83":{"kind":"json-schema","data":{"type":"array","items":{"type":"integer","format":"int32"}},"id":"schema_83"},"schema_84":{"kind":"json-schema","data":{"pattern":"ANALYST|REVIEWER|OBSERVER|PROJECT_ADMIN","type":"string","enum":["ANALYST","REVIEWER","OBSERVER","PROJECT_ADMIN"],"default":"ANALYST"},"id":"schema_84"},"schema_85":{"kind":"json-schema","data":{"type":"string","format":"boolean","default":"false"},"id":"schema_85"},"schema_86":{"kind":"json-schema","data":{"type":"string","enum":["PUBLISHED","UNPUBLISHED","ALL"],"default":"PUBLISHED"},"id":"schema_86"},"schema_87":{"kind":"json-schema","data":{"type":"string","enum":["Not Started","Analysis In Progress","Analysis Completed","Project Completed"],"default":"Not Started"},"id":"schema_87"},"schema_88":{"kind":"json-schema","data":{"type":"string","enum":["Update Status Only","Lock Child Projects","Unlock Child Projects"],"default":"Update Status Only"},"id":"schema_88"},"schema_89":{"kind":"json-schema","data":{"type":"object","properties":{"projectId":{"type":"integer","format":"int32"},"reportId":{"type":"integer","format":"int32"},"file":{"$ref":"#/components/schemas/FormDataContentDisposition"}}},"id":"schema_89"},"schema_90":{"kind":"json-schema","data":{"minimum":1,"exclusiveMinimum":false,"type":"integer","format":"int32"},"id":"schema_90"},"schema_91":{"kind":"json-schema","data":{"type":"object","properties":{"File to import":{"type":"object"},"Project Import Model":{"$ref":"#/components/schemas/ProjectImportModel"}}},"id":"schema_91"},"schema_92":{"kind":"json-schema","data":{"type":"object","properties":{"Sbom File to import":{"type":"object"},"sbomFile":{"$ref":"#/components/schemas/FormDataContentDisposition"},"Delete SBOM bucket":{"type":"string"}}},"id":"schema_92"},"schema_93":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_93"},"schema_94":{"kind":"json-schema","data":{"pattern":"ANY|SUPPRESSED|UNSUPPRESSED","type":"string","enum":["ANY","SUPPRESSED","UNSUPPRESSED"],"default":"ANY"},"id":"schema_94"},"schema_95":{"kind":"json-schema","data":{"pattern":"DRAFT|APPROVED|REJECTED","type":"string","enum":["DRAFT","APPROVED","REJECTED"],"default":"DRAFT"},"id":"schema_95"},"schema_96":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/InventoryWorkflow"}},"id":"schema_96"},"schema_97":{"kind":"json-schema","data":{"type":"string","enum":["New","Active","Canceled","Completed","Failed","Scheduled","Terminated","Waiting on update"]},"id":"schema_97"},"schema_98":{"kind":"json-schema","data":{"minimum":0,"exclusiveMinimum":false,"type":"integer","format":"int32"},"id":"schema_98"},"schema_99":{"kind":"json-schema","data":{"maximum":3650,"exclusiveMaximum":false,"minimum":0,"exclusiveMinimum":false,"type":"integer","format":"int32","default":0},"id":"schema_99"},"schema_100":{"kind":"json-schema","data":{"minimum":1,"exclusiveMinimum":false,"type":"integer","format":"int32","default":25},"id":"schema_100"},"schema_101":{"kind":"json-schema","data":{"type":"integer","format":"int64","default":25},"id":"schema_101"},"schema_102":{"kind":"json-schema","data":{"minimum":0,"type":"integer","format":"int64"},"id":"schema_102"},"schema_103":{"kind":"json-schema","data":{"type":"string","enum":["GIT","TFS","PERFORCE","SUBVERSION"]},"id":"schema_103"},"schema_104":{"kind":"json-schema","data":{"type":"string","enum":["GIT","TFS","PERFORCE","SUBVERSION"],"default":"GIT"},"id":"schema_104"},"schema_105":{"kind":"json-schema","data":{"required":["file"],"type":"object","properties":{"file":{"$ref":"#/components/schemas/FormDataContentDisposition"}}},"id":"schema_105"},"schema_106":{"kind":"json-schema","data":{"type":"integer","format":"int32","default":0},"id":"schema_106"},"schema_107":{"kind":"json-schema","data":{"type":"array","items":{"type":"integer","format":"int64"}},"id":"schema_107"},"schema_108":{"kind":"json-schema","data":{"minimum":1,"type":"integer","format":"int64","default":50},"id":"schema_108"},"schema_109":{"kind":"json-schema","data":{"pattern":"CLOSED|APPROVED|REJECTED","type":"string","enum":["CLOSED","APPROVED","REJECTED"],"default":"CLOSED"},"id":"schema_109"},"schema_110":{"kind":"json-schema","data":{"type":"string","description":"Status of the Task to be used in search","enum":["OPEN","CLOSED","ALL"],"default":"ALL"},"id":"schema_110"},"schema_111":{"kind":"json-schema","data":{"pattern":"MISCELLANEOUS|MANUAL_INVENTORY_REVIEW|REMEDIATE_INVENTORY|ALL","type":"string","description":"Type of the Task to be used in search","enum":["MISCELLANEOUS","MANUAL_INVENTORY_REVIEW","REMEDIATE_INVENTORY","ALL"],"default":"ALL"},"id":"schema_111"},"schema_112":{"kind":"json-schema","data":{"type":"string","description":"Priority of the Task to be used in search","enum":["LOW","MEDIUM","HIGH","ALL"],"default":"ALL"},"id":"schema_112"},"schema_113":{"kind":"json-schema","data":{"type":"object","additionalProperties":{"type":"string"}},"id":"schema_113"}},"exampleStore":{},"securitySchemeStore":{"bearerAuth":{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}},"servers":[{"url":"/_mock/swagger","isMockServer":true,"description":"Mock server"},{"url":"/codeinsight/api","description":"Code Insight REST API Server"}]},"options":{"hideSidebar":true,"mockServer":{"url":"/_mock/swagger","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/swagger.json?download"},{"url":"/_bundle/swagger.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Code Insight REST API Documentation","description":"The Code Insight REST APIs provide a standardized interface for interacting with the application.\n\nAn authorization JWT token must be included in the HTTP Authorization header using the Bearer schema.\nThe token can be obtained from the Code Insight Web UI under the Preferences menu. \nTo set the token, click the **Authorize** button below on the right, enter the JWT token in the **Value** field, then click Authorize and close the dialog. Once authorized, the token will be automatically included in the HTTP Authorization header for all API requests made through the Swagger UI.\n\n**Note:** If accessing the REST APIs through external tools such as **curl** or **Postman**, include the token manually in the HTTP header using the following format:\n`Authorization: Bearer JWT_TOKEN`. _*\"Bearer\" must precede the actual JWT token value.*_\n"}},"baseSlug":"/swagger","routesMapping":{}}