Fetching the status of the signing request

Before you begin

Configure the signing policy with relevant details, ensuring mapping to the enrolled certificate (also identified as the signing key on the signing policy page).
Make sure you have the Sign ID of the signing request for which you intend to check the status.

Request Structure


Endpoint:	`/code-signing-fetch-status-sync-requests`
Type:	`GET`
Sample URL:	`https://<IP/HostName/TenantName>:<GWPORT>/avxapi/code-signing-fetch-status-sync-requests?gwsource=api&signId=<signId>` To understand the elements of the sample URL, click here.
Headers:
Content-Type:	application/json

Table 1. **Input Parameters**
Name	Description
sessionId `Header`	(Mandatory) After successfully logging in, a unique identifier assigned to a user's session after successful authentication. The session ID remains valid until it expires. The session ID is a string value. Example: "a1b2c3d4e5f6"
username `Header`	(Mandatory) AppViewX login username, represented as a string value. Example: "User"
password `Header`	(Mandatory) AppViewX login username, represented as a string value. Example: "AppViewX@123"
signId Query Params `String`	(Mandatory) Enter the Sign ID received after signing the code. Example: "65c47fa41112f940dab1cb12"

Response Structure

Status Code: 200 OK
Message: Successful
Headers:
- Content-Type: application/json

Table 2. **Response Parameters**
Name	Description
response	Contains the response attributes for the fetch status sync requests.
message	Success message or failure description in case of error.
appStatusCode	Application specific status code for the response. Will be non-null for failure response.
tags	More info in case of failure response.

Status Codes


HTTP Code	appStatusCode	Response Message
200 OK	null	Successful
400 Bad Request	CODE_SIGNING_0105	SIGN_ID Not present.
400 Bad Request	CODE_SIGNING_0102	Data not present for given signId.
403 Forbidden	CODE_SIGNING_00109	Permissions are not there to fetch status for given signId.
500 Internal Server Error	CODE_SIGNING_0101	Error in Fetching the status for the requested SignId.
500 Internal Server Error	CODE_SIGNING_0103	Fetching Encoded Sign Data Failed.

Sample Request/Response

Use Case

To fetch the status of the signing request.

Request URL

https://<IP/HostName/TenantName>:<GWPORT>/avxapi/code-signing-fetch-status-sync-requests?gwsource=api&signId=<signId>

Request Payload

NA

Sample Response 1

{
    "response": {
        "status": "Inprogress",
        "noOfInProgressRequests": 1,
        "failedDueToTimeoutError": false
    },
    "message": null,
    "appStatusCode": null,
    "tags": null,
    "headers": null
}

Sample Response 2

{
"response": {
"encodedHashData": "Get-PSDrive\r\n# SIG # Begin signature block\r\n# MIIWUAYJKoZIhvcNAQcCoIIWQTCCFj0CAQExDzANBglghkgBZQMEAgEFADB5Bgor\r\n# YXQNcC2NQme7lajGfHWbGBOT9EyB/78Wv2/i/GgcblLUPrd/7I7yOi4sITChar8J\r\n# iJO1GbYJjzUMAhGb64sD4jlQnRj69hWKvG5uy/yu5OD39F1WvVCvTOT7FaR/HQIN\r\n# V9orkA==\r\n# SIG # End signature block\r\n",
"status": "Signed"
},
"message": null,
"appStatusCode": null,
"tags": null,
"headers": null
}

What's Next

Download Code Signed File.

Reference

Understanding the sample URL:

IP/HostName/TenantName: Replace with the actual IP address, hostname, or tenant name based on the specific configuration in AppViewX.
- IP: A unique identifier assigned to each device connected to a computer network that uses the Internet Protocol for communication
  The IP address will be included in the endpoint URL for an on-prem deployment.
- HostName: A human-readable label assigned to a device (host) on a network
  The hostname will be included in the endpoint URL for an on-prem deployment.
- TenantName: An identifier label for a tenant given to indicate which tenant's data the API request will access/modify
  The tenant name will be included in the endpoint URL for a SaaS deployment.
GWPORT: AppViewX gateway port
A gateway port refers to a network port through which data is sent and received to communicate with a gateway in an on-prem deployment.
Example: 31443
avxapi: Path parameter value (static) that is part of the endpoint's URL
Endpoint: Endpoint of the API, for example: execute-hook
gwsource: Source or origin of a gateway, for example: external.