Using Data Extract REST Endpoints

The following table shows examples of how to view jobs that have run and get the output from those jobs.

Endpoints for data extract job information are available on your FlexNet Operations host:

https://<siteID>.flexnetoperations.com/flexnet/operations/extracts

where <siteID> is your organization’s site ID which is supplied by Revenera. This is usually your organization's DNS name, but can also be the tenant ID that was assigned to your organization when FlexNet Operations was first implemented, and would have the format flexNNNN.

(The FlexNet Operations host prompts you for your Producer Portal username and password.)

 

Service URL

Method

Example Response

.../operations/extracts

GET

Retrieves a list of all jobs that have run.

/operations/extracts returns a response like the following:

[{"id":2087,"jobName":"FULFILLMENT","status":"C","startTime":
"2016-12-12T20:31:54.473Z", "endTime":"2016-12-12T20:31:55.543Z",
"artifactAvailable":false,"filesize":null,"checksum":null},

 

{"id":2088,"jobName":"DEVICE","status":"C","startTime":
"2016-12-09T23:31:54.450Z", "endTime":"2016-12-09T23:31:54.580Z",
"artifactAvailable":true,"filesize":"244","checksum":"B92B84053BA5EAB1EA78B515793411C3D1EEA438F445433B821B6AB118F3131A"},

 

{"id":2089,"jobName":"USAGE","status":"P","startTime":
"2016-12-09T23:29:39.197Z","endTime":"2016-12-09T23:29:39.337Z",
"artifactAvailable":false,"filesize":null,"checksum":null},

 

{"id":2090,"jobName":"FULFILLMENT","status":"C","startTime":
"2016-12-09T23:28:39.193Z","endTime":"2016-12-09T23:28:39.307Z",
"artifactAvailable":true,"filesize":"244","checksum":"B92B84053BA5EAB1EA78B515793411C3D1EEA438F445433B821B6AB118F3131A"},

Optional Parameters

Filter the job entries, if necessary, in the response using optional parameters:

• name values include ACCOUNT, DEVICE, DEVICEUPDATES, ENTITLEMENT, FULFILLMENT, PRODUCTS, SERVEDDEVICE, UPDATES, USAGE, and USER. These values limit the job entries to the entity specified.
• beginDate values use the format YYYY-MM-DD (FlexNet Operations server time).
• endDate values use the format YYYY-MM-DD (FlexNet Operations server time).
• status values can be C for “completed,” F for “failed,” or P for “pending.”
• artifactAvailable values can be true or false. If false, no artifact (.csv or .zip file) is available.
• filesize (size in bytes) and checksum (using the SHA-256 algorithm) are available when two conditions are satisfied:
• status = C
• artifactavailable = true

If both conditions are not satisfied, these fields will be null.

Optional parameters can be combined in the request. For example,

https://<siteID>.flexnetoperations.com/flexnet/operations/extracts?name=DEVICE&status=C

returns entries for all completed Device Data Extract jobs.

.../operations/extracts/{jobid}

GET

Retrieves an entry about the job that matches the job ID.

/operations/extracts/2088 returns

{"id":2088,"jobName":"DEVICE","status":"C","startTime":
"2016-12-09T23:31:54.450Z", "endTime":"2016-12-09T23:31:54.580Z",
"artifactAvailable":true,"filesize":"244","checksum":"B92B84053BA5EAB1EA78B515793411C3D1EEA438F445433B821B6AB118F3131A"}

.../operations/extracts/{jobid}/file

GET

Retrieves the output of the job that matches the specified job ID. This method returns the contents of the artifact file associated with the job, as a binary stream, if an artifact file location is provided.

See entity-specific data extract descriptions, below, for information about the contents of a job’s artifact file.

For best performance, consider deleting a job after successfully downloading the job’s artifact file.

.../operations/extracts/delete/{jobid}

POST

Deletes the job that matches the specified job ID as well as its corresponding artifact file, if any, from its given location.