The December 12 release of the Platform APIs introduces the Tenant Data API, Exchange Data API, and enhancements to the Risk Data API. The Tenant Data API enables you to view information about platform jobs across the Intelligent Risk Platform. The Exchange Data API provides services for managing requests, share keys, and recipients. Risk Data API enhancements include support for data tagging exposure enrichment.

Risk Data API

Data tagging enables you to apply keywords to entities and exposures (portfolios, accounts, etc.) to facilitate the organization and tracking of exposures and analyses based on those exposures.

Accounts

Create Account

The Create Account operation (POST /riskdata/v1/exposures/{exposureId}/accounts) now enables you to specify one or more tag IDs when you create a new account. The request body now accepts the tagIds parameters, an array of tag IDs that identify the keywords applied to this account.

{
  "accountName": "string",
  "accountNumber": "string",
  ...,
  "tagIds": [
    1,2,3,4
  ]
}

This operation validates the specified tag IDs.

Update Account

The Update Account operation (PUT /riskdata/v1/exposures/{exposureId}/accounts/{accountId}) now enables you to specify one or more tag IDs when you update an existing treaty. The request body now accepts the tagIds parameters, an array of tag IDs that that identify the keywords applied to this account.

{
  "accountName": "string",
  "accountNumber": "string",
  ...,

  "tagIds": [
    1,2,3,4
  ]
}

This operation validates the specified tag IDs and throws an error if the specified tag ID does not exist.

Search Accounts

The Search Accounts operation (GET /riskdata/v1/exposures/{exposureId}/accounts) now returns the tag IDs applied to the accounts matching the specified query.

[
  {
    "accountId": 0,
    "accountName": "string",
    ...,

    "tagIds": [
      1,2,3,4
    ]
  }
]

This operation also supports filtering accounts based on the tag IDs applied those accounts. The filter query parameter enables you to define a query string that matches tagIds values using the =, =!, IN, NOT IN, AND and OR operators. To learn more, see Response Filtering.

Get Account

The Get Account operation (GET /riskdata/v1/exposures/{exposureId}/accounts/{accountId) now returns the tag IDs applied to the specified account.

{
    "id": 1,
    "name": "ACCOUNT_555167417_upd",
    "number": "ACCOUNT_555167417_up",
    ...,

    "tagIds": [
        1,2,3,4
    ]
}

Aggregate Portfolio API

Create Aggregate Portfolio

The Create Aggregate Portfolio operation (POST /riskdata/v1/exposures/{exposureId}/aggregate-portfolios) now enables you to specify one or more tag IDs when you create a new EDM. The request body now accepts the tagIds parameters, an array of tag IDs that that identify the keywords applied to this aggregate portfolio.

Update Aggregate Portfolio

The Update Aggregate Portfolio operation (PUT /riskdata/v1/exposures/{exposureId}/aggregate-portfolios/{aggregatePortfoliosId}) now enables you to specify one or more tag IDs when you create a new EDM. The request body now accepts the tagIds parameters, an array of tag IDs that that identify the keywords applied to this aggregate portfolio.

Get Aggregate Portfolio

The Get Aggregate Portfolio operation (GET /riskdata/v1/exposures/{exposureId}/aggregate-portfolios/{aggregatePortolioId) now returns the tag IDs applied to that aggregate portfolio.

Search Aggregate Portfolios

The Search Aggregate Portfolios operation (GET /riskdata/v1/exposures/{exposureId}/aggregate-portfolios) now returns the tag IDs applied to the aggregate portfolios matching the specified query.

This operation also supports filtering accounts based on the tag IDs applied to them. The filter query parameter enables you to define a query string that matches tagIds values using the =, =!, IN, NOT IN, AND and OR operators. To learn more, see Response Filtering.

Update Data Tags

The [Update Data Tags] operation (POST /riskdata/exposures/{exposureId}/update-tags) enables you to update the data tags applied to the specified EDM. The request body accepts the tagIds parameters, an array of tag IDs that identify the keywords applied to the specified EDM.

{
  "tagIds": [
    1,2,3,8,10
  ]
}

Databases

Register EDM

The Register EDM operation (POST /riskdata/dataservers/{serverId}/databases/{databaseId}/register) now enables you to specify one or more tag IDs when you create a new EDM. The request body now accepts the tagIds parameters, an array of tag IDs that that identify the keywords applied to this portfolio.

{
  "exposureSetId": 22314,
  "deferMetricCalculation": true,
  "tagIds": [
    1,2,3,8,10
  ]
}

This operation also supports filtering accounts based on the tag IDs applied those accounts. The filter query parameter enables you to define a query string that matches tagIds values using the =, =!, IN, NOT IN, AND and OR operators. To learn more, see Response Filtering.

Exposures

Create EDM

The Create EDM operation (POST /riskdata/v1/exposuresets/{exposureSetId}/exposures) now enables you to specify one or more tag IDs when you create a new EDM. The request body now accepts the tagIds parameters, an array of tag IDs that that identify the keywords applied to this portfolio.

{
  "exposureName": "Test",
  "serverId": 1,
  "tagIds": [
    1,2,3,8,10
  ]
}

Search EDMs

The Search EDMs operation (GET /riskdata/v1/exposures) now returns the tag IDs applied to the accounts matching the specified query.

[
    {
        "exposureName": "data_tag_ak",
        "exposureId": 455710,
        ...,

        "tagIds": [
            1,2,3,4
        ]
    }
]

Get EDM

The Get EDM operation (GET /riskdata/v1/exposures/{exposureId}) now returns the tag IDs applied to the specified account.

{
    "exposureName": "data_tag_ak",
    "exposureId": 455710,
    ...,

    "tagIds": [
        1,2,3,4
    ]
}

Analyses

Update Data Tags by Analysis

The Update Data Tags by Analysis operation (POST /analyses/{analysisId}/update-tags) enables you to update the data tags applied to the analysis. The request body accepts the tagIds parameters, an array of tag IDs that identify the keywords applied to the specified analysis.

{
  "tagIds": [
    1,2,3,8,10
  ]
}

Locations

Get Location Enrichment

The new Get Location Enrichment operation (GET /riskdata/v1/exposures/{exposureId}/locations/{locationId/enrichedDetails) retrieve enrichment data for the specified location.

The response returns the ESDB data that has been applied to the specified location.

{
    "locId": 1,
    "airConditioningDescription": "Central Air",
    "buildingHeight": 10,
    "buildingValuationLowerRange": 200000.0,
    "buildingValuationUpperRange": 300000.0,
    "construction": "Brick",
    "constructionSource": "Municipal Records",
    "currencyCode": "USD",
    "esdbVersion": "1.0.0",
    "exteriorDescription": "Brick Exterior",
    "floorArea": 1500,
    "floorAreaSource": "Municipal Records",
    "floorOccupancy": "Residential",
    "floorOccupancyDescription": "Single Family Home",
    "foundationSystemDescription": "Concrete Slab",
    "garagingDescription": "2 Car Garage",
    "heatingTypeDescription": "Gas Heating",
    "isHD": 0,
    "isPrimaryBuildingFlag": 1,
    "multipleBuildingFlag": 0,
    "numberOfBaths": 2,
    "numberOfBedrooms": 3,
    "numberOfUnits": 1,
    "numOfStories": 2,
    "numOfStoriesSource": "Municipal Records",
    "occupancy": "Occupied",
    "occupancy2": "Not Occupied",
    "occupancy3": "N/A",
    "occupancySource": "Municipal Records",
    "pool": "No Pool",
    "roofCoverCode": "Tile",
    "roofCoverDescription": "Tile Roof",
    "roofGeometryCode": "Gable",
    "roofGeometryDescription": "Gable Roof",
    "versionId": 1.1,
    "yearBuilt": 1990,
    "yearBuiltSource": "Municipal Records"
}

Portfolios

Create Portfolio

The Create Portfolio operation (POST /riskdata/v1/exposures/{exposureId}/portfolios) now enables you to specify one or more tag IDs when you create a new EDM. The request body now accepts the tagIds parameters, an array of tag IDs that that identify the keywords applied to this portfolio.

{
    "name": "portAk26019",
    "number": "portAk26019",
    ...,

    "tagIds": [
       3,4
    ]
}

Update Portfolio

The Update Portfolio operation (POST /riskdata/v1/exposures/{exposureId}/portfolios) now enables you to specify one or more tag IDs when you create a new EDM. The request body now accepts the tagIds parameters, an array of tag IDs that that identify the keywords applied to this portfolio.

{
    "name": "portAk26019",
    "number": "portAk26019",
    ...,
    
    "tagIds": [
       3,4
    ]
}

Get Portfolio

The Get Portfolio operation (GET /riskdata/v1/exposures/{exposureId}/portfolios/{portfolioId}) now returns the tag IDs applied to accounts matching the specified query.

{
    "id": 75,
    "name": "portAk26019",
    ...,

    "tagIds": [
        1,2,3,4
    ]
}

Search Portfolios

The Search Portfolios operation (GET /riskdata/exposures/v1/portfolios) now returns the tag IDs applied to accounts matching the specified query.

{
    "searchTotalMatch": 69,
    "searchItems": [
        {
            "id": 1,
            "name": "pf_oct9_upd",
            "number": "pf_oct9_upd",
            ...,

            "tagIds": [
                1,2,3,4
            ]
        }
    ]
}

This operation also supports filtering accounts based on the tag IDs applied to them. The filter query parameter enables you to define a query string that matches tagIds values using the =, =!, IN, NOT IN, AND and OR operators. To learn more, see Response Filtering.

Treaties

Create Treaty

The Create Treaty operation (POST /riskdata/v1/exposures/{exposureId}/treaties) now enables you to specify one or more tag IDs when you create a new treaty. The request body now accepts the tagIds parameters, an array of tag IDs that identify the keywords applied to this account.

{
    "aggregateDeductible": 0,
    "aggregateLimit": 0,
    "tagIds": [48,49]
}    

Update Treaty

The Update Treaty operation (PUT /riskdata/v1/exposures/{exposureId}/treaties/{treatyId}) now enables you to specify one or more tag IDs when you update an existing treaty. The request body now accepts the tagIds parameters, an array of tag IDs that identify the keywords applied to this account.

{
    "treatyId": 8,
    "treatyNumber": "treatyTest61111",
    ...,

    "tagIds": [5,6]
}

Search Treaties

The Search Treaties operation (GET /riskdata/v1/exposures/{exposureId}/treaties) now returns the tag IDs applied to accounts matching the specified query.

[
  {
    "treatyId": 10,
    "treatyNumber": "string",
    "treatyName": "string",
    "cedant": {
      "cedantId": "GgdG04dHLgmUOWvTWGY-",
      "cedantName": "string"
    },
    "producer": {
      "producerId": "AJT0bFLV8VLsdR",
      "producerName": "string"
    },
    "treatyType": "CATA",
    "currency": {
      "id": 0,
      "code": "string",
      "name": "string"
    },
    "attachmentBasis": "L",
    "attachmentLevel": "PORT",
    "premium": 0,
    "occurrenceLimit": 0,
    "attachmentPoint": 0,
    "riskLimit": 0,
    "retentionAmount": 0,
    "percentagePlaced": 0,
    "effectiveDate": "2020-01-01T00:00:00.000Z",
    "expirationDate": "2020-01-01T00:00:00.000Z",
    "percentageRetention": 0,
    "percentageRiShare": 0,
    "percentageCovered": 0,
    "priority": 0,
    "numberOfReinstatements": 0,
    "reinstatementCharge": 0,
    "maolAmount": 0,
    "isValid": true,
    "userId1": "string",
    "userId2": "string",
    "aggregateDeductible": 0,
    "aggregateLimit": 0,
    "uri": "string",
    "lobs": [
      {
        "lobId": 1,
        "lobName": "string",
        "uri": "string"
      }
    ],
    "lossOccurrences": [
      {
        "id": 0,
        "treatyId": 0,
        "uri": "string",
        "regionPeril": {
          "id": 0,
          "code": "string",
          "name": "string"
        },
        "lossOccurrenceTime": 0,
        "lossOccurrenceRadius": 0,
        "radiusUnit": {
          "id": 0,
          "code": "string",
          "name": "string"
        },
        "multiLossOccurrence": {
          "id": 0,
          "code": "string",
          "name": "string"
        }
      }
    ],
    "tagIds": [
      1,2,3,4
    ]
  }
]

This operation also supports filtering accounts based on the tag IDs applied those treaties. The filter query parameter enables you to define a query string that matches tagIds values using the =, =!, IN, NOT IN, AND and OR operators. To learn more, see Response Filtering.

Get Treaty

The Get Treaty operation (GET /riskdata/v1/exposures/{exposureId}/treaties/{treatyId}) now returns the tag IDs applied to the specified treaty.

{
    "treatyId": 18,
    "treatyNumber": "treaty56",
    "treatyName": "treaty56",
    "cedant": {
        "cedantId": "1",
        "cedantName": "Cedant1"
    },
    "producer": {},
    "treatyType": "NCAT",
    "currency": {
        "id": 0,
        "code": "USD",
        "name": "US Dollar"
    },
    "attachmentBasis": "L",
    "attachmentLevel": "PORT",
    "premium": 0.0,
    "occurrenceLimit": 1.0,
    "attachmentPoint": 0.0,
    "riskLimit": 0.0,
    "retentionAmount": 0.0,
    "percentagePlaced": 0.0,
    "effectiveDate": "2023-07-28T14:43:25.773Z",
    "expirationDate": "2024-07-28T14:43:25.773Z",
    "percentageRetention": 0.0,
    "percentageRiShare": 0.0,
    "percentageCovered": 0.0,
    "priority": 1,
    "numberOfReinstatements": 99,
    "reinstatementCharge": 0.0,
    "maolAmount": 0.0,
    "isValid": true,
    "userId1": "",
    "userId2": "",
    "aggregateDeductible": 0.0,
    "aggregateLimit": 0.0,
    "uri": "/platform/riskdata/v1/exposures/455710/treaties/18",
    "lobs": [],
    "lossOccurrences": [],
    "tagIds": [
        1,2,3,4
    ]
}

Enrich Exposures API

Enrich Exposure

The new Enrich Exposure operation (POST /enrichexposure/v1/jobs) enables you to "enrich" an account or portfolio exposure by fetching exposure data from the ESDB and updating the specified portfolio with data.

All other parameters are specified in the body of the request. The request body specifies the resource to update and the resourcetype of the resource. One of account or portfolio.

{
        "resourceUri": "/platform/riskdata/v1/exposures/12312/portfolios/12",
        "resourceType": "portolio",
        "settings" : {
          "retrieveData": true,
          "esdbVersion": "Latest",
          "transferData": true,
          "overwriteAll": true,
          "createBackup": true,
          "backupDetails": {
            "exposureResourceName": "your_backup_name",
            "exposureResourceNumber": "your_backup_number"
          }
}

All parameters are optional.

• The retrieveData parameter accepts indicate whether the operation retrieves data from the ESDB. By default, false
• The esdbVersion specifies the ESDB version for the retrieval task. By default, Latest.
• The transferData indicates whether the operation updates exposures with data retrieved from the ESDB. By default, false.
• The overwriteAll determines whether the operation preserves or overwrites existing exposure data. If true, the operation overwrites all exposure property values, effectively replacing existing data with the retrieved exposure enrichment data. If false, the operation preserves the integrity of existing data and updates only those properties that were empty or contained default values. By default, false.
• The createBackup parameter indicates whether the operation creates copy of the existing exposure before it updates that exposure. Only applicable if the transferData parameter is true. By default, false. If true, the backupDetails parameter is required.
• The backupDetails parameter is an object that defines the backupName and backupNumber of the backup data. Required, if createBackup is true. The backupName parameter specifies the name of the backup. The backupNumber parameter specifies the ID number of the backup.

The request also accepts two request headers:

x-rms-resource-group-Id 
x-rms-requestId 

Both headers are optional.

• The x-rms-resource-group-Id identifies the ID of the resource group that owns the data.
• The x-rms-requestId indicates whether the request is idempotent>.

On success, this operation returns a 202 response and initiates a portfolio-level ENRICH_EXPOSURE job.

Update Enrich Exposure Job

The new Update Enrich Exposure Job operation (PATCH /enrichexposure/v1/jobs/{enrichmentJobId}) enables you to update the specified ENRICH_EXPOSURE job.

The required request body can update the status or priority of the job.

{
  "status": "CANCELLED"
}

Search Enrich Exposure Jobs

The new Search Enrich Exposure Jobs operation (GET /enrichexposure/v1/jobs/) enables you to search for enrich exposure jobs using query filters.

Supported filter properties include. The operators available for each supported property depends that property's data type.

To learn more, see Response Filtering.

The response returns an array of jobs. For each job, the response includes the jobId, status, type, resourceGroupId, and job details:

[
  {
    "jobId": "string",
    "userName": "string",
    "status": "QUEUED",
    "submittedAt": "string",
    "startedAt": "string",
    "endedAt": "string",
    "name": "string",
    "type": "string",
    "progress": 0,
    "priority": "string",
    "entitlement": "string",
    "resourceGroupId": "string",
    "details": {
      "resources": [
        {
          "uri": "string"
        }
      ],
      "summary": "string"
    },
    "warnings": [
      {
        "message": "string"
      }
    ]
  }
]

Response data can be sorted by jobId, type, name, or status. To learn more, see Response Pagination.

Get Enrich Exposure Job

The new Get Enrich Exposure Job operation (GET /enrichexposure/v1/jobs/{enrichmentJobId}) enables you to view information about the specified ENRICH_EXPOSURE job.

{
    "jobId": "14199464",
        "userName": "[email protected]",
        "status": "FINISHED",
        "submittedAt": "2023-10-27T03:24:12.027Z",
        "startedAt": "2023-10-27T03:24:16Z",
        "endedAt": "2023-10-27T03:27:04Z",
        "name": "Test Enrich Port 1",
        "type": "ENRICH_EXPOSURE",
        "progress": 100,
        "entitlement": "RI-RISKMODELER",
        "resourceGroupId": "ba672cd9-3384-4cb3-9882-bbeb5f8478c6",
        "priority": "medium",
        "details": {
            "resources": [
                {
                    "uri": "/platform/riskdata/v1/exposures/12312/portfolios/12" 
                }
            ],
            "summary": "72562 Locations enriched out of 72562."
        },
    "tasks": [
        {
            "guid": "8749f8ef-d1b3-448b-b753-a1776d5857ed",
            "taskId": "1",
            "jobId": "14184418",
            "status": "Succeeded",
            "submittedAt": "2023-10-24T05:21:58.320Z",
            "createdAt": "2023-10-24T05:21:55.017Z",
            "name": "ENRICH_EXPOSURE_TASK", 
            "output": {
                "summary": "72562 Locations enriched out of 72562.",
                "errors": [],
                "log": { 
                    "summary" : "72562 Locations enriched out of 72562. ", //"72562 Locations retrieved out of 72562. "
                    "esdbVersion" : "String",
                    "databaseName" : "NZEQ_URG_2KM_SFD",
                    "dataVersion" : "21.0.0",
                    "exposureName" : "NZEQ_URG_2KM_SFD",
                    "exposureNumber": "",
                    "backupexposureId": 2131,
                    "locationsSubmitted": 72562,
                    "locationsRetrieved": 72562,
                    "locationsEnriched":72562
                }
            },
            "priorTaskGuids": [],
            "percentComplete": 100
        }
    ]
}

Import API

Create Import Job

The Create Import Job operation (POST /riskdata/v1/import/v1/jobs) now enables you to apply one or more tag IDs to an imported EDM or RDM.

The request body now accepts the tagIds parameters, an array of tag IDs that that identify the keywords applied to this portfolio.

{
	"importType": "RDM",
	"resourceUri": "/platform/riskdata/v1/exposuresets/{{exposureSetId}}",
	"settings": {
        "folderId": "{{folderId}}",
        "rdmName": "upload_rdm_nov3008",
        "tagIds": [1,4,5]
	}
}

Exchange Data API

The Exchange Data API enables you to securely share risk data (EDMs or results data) between business units across Identify Provider boundaries within the same tenant or across with other Intelligent Risk Platform tenants. (These operations also enable you to share sensitive data with RMS support for debugging.)

The API defines operations for defining recipients, share keys, share requests:

• The recipient is a party (business unit, tenant, customer support representative) to be granted access to a resource. This recipient is assigned a share key.
• The share key is an entity that provides the recipient access to a share request.
• The share request identifies the data to be shared with recipients assigned the correct share key. Shared resources are defined by an array of resourceUrls of a particular resourceType (one of Account or Portfolio).

Create Share Keys

The new Create Share Key operation (POST /exchangedata/v1/sharekeys) to create a share key. A share key is an X that enables the teant to to exchange resources.

The request request body accepts two parameters:

{
    "recipientShareKey": "string",
    "recipientShareKeyName": "string",
    "status": "string"
}

If successful, the response returns a 201 response.

Update Share Key

The new Update Share Key operation (PATCH /exchangedata/v1/sharekeys) to update the name and email of the share key applied to the specific resource.

The request request body accepts two parameters:

{
    "recipientShareKey": "string",
    "status": "string"
}

Search Share Keys

The new Search Share Keys operation (GET /exchangedata/v1/sharekeys) to view share keys.

This operation supports response filtering based the value of a subset of properties. Depending on the property, you may use a combination of comparison operators, list operators, and logical operators.

[
    {
        "shareKey": "string", 
        "shareKeyName": "string",
        "email": "string"
    }
]

Supported filter properties include status, type, and platformOperationType, of the job. The operators available for each supported property depends that property's data type.

Get Share Key by Resource

The new Get Share Key operation (GET /exchangedata/v1/sharekeys/{resourceId) to view the share keys that have been applied to a specified resource (e.g. account, portfolio).

The response returns the shareKey, shareKeyName, and email of all resource keys applied to the resource:

[
    {
        "shareKey": "string", 
        "shareKeyName": "string",
        "email": "string"
    }
]

Create Recipient

The new Create Recipient operation (POST /exchangedata/v1/sharekeys/{shareKeyId}/recipients) creates a new recipient for the specified share key.

The request takes a single parameter in the required request body.

{
    "recipientShareKey": "string"
}

On success, the response returns a 201 HTTP response.

Update Recipient

The new Update Recipient operation (PATCH /exchangedata/v1/sharekeys/{shareKeyId}/recipients/{recipientId) updates the status of the specified recipient.

The request takes a single parameter in the required request body.

{
    "status": "string"
}

Search Recipents

The new Search Recipients operation (GET /exchangedata/v1/sharekeys/{shareKeyId}/recipients) returns information about the recipients applied to a specified share key.

The response returns an array of recipient keys. For each recipient key, the response returns the recipientShareKey, recipientShareKeyName, and the status:

[
    {
        "recipientShareKey": "string",
        "recipientShareKeyName": "string",
        "status": "string"
    }
]

Supported filter properties include status, type, and platformOperationType, of the job. The operators available for each supported property depends that property's data type.

Get Recipent

The new Get Recipient operation (GET /exchangedata/v1/sharekeys/{shareKeyId}/recipients/{recipientId}) returns information about the recipients applied to a specified share key.

The response returns the recipientShareKey, recipientShareKeyName, and the status:

 {
     "recipientShareKey": "string",
     "recipientShareKeyName": "string",
     "status": "string"
 }

Create Share Request

The new Create Share Request operation (POST /exchangedata/v1/sharekeys/{shareKeyId}/sharerequests) creates a new share request for the specified share key.

The required request body defines the share request and specifies the share key and resources to which that share key is applied.

{
    "resources": [
        {
            "resourceUris": [
                "string"
            ],
            "resourceType": "string"
        }
    ],
    "comment": "string",
    "recipientShareKey": "string",
    "recipientEmail": "string",
    "shareRequestName": "string"
}

On success, the response returns a 201 HTTP response.

Search Share Requests

The new Search Share Requests operation (GET /exchangedata/v1/sharekeys/{shareKeyId}/sharerequests) returns a list of the share requests applied to the specified share key.

The response returns an array of share requests. For each share request, the response returns share request details including information about the exposure or analysis data to be shared.

[
    {
        "shareRequestId": 37,
        "shareRequestName": "string",
        "shareKey": "string",
        "shareKeyName": "string",
        "recipientShareKey": "string",
        "recipientShareKeyName": "string",
        "status": "string",
        "createdBy": "string",
        "recipientEmail": "string",
        "updatedBy": "string",
        "createdAt": "string",
        "updatedAt": "string",
        "comment": "string",
        "shareRequestType": "string",
        "resources": [
            {
                "resourceType": "string",
                "resourceSize": "string",
                "resourceUris": [
                    "string"
                ]
            }
        ]
    }
]

Supported filter properties include status, type, and platformOperationType, of the job. The operators available for each supported property depends that property's data type.

Get Share Request

The new Get Share Request operation (GET /exchangedata/v1/sharekeys/{shareKeyId}/sharerequests/{shareRequestId) returns the specified share request.

The response returns the response returns information about the share key and the related resources.

{
    "shareRequestId": 37,
    "shareRequestName": "string",
    "shareKey": "string",
    "shareKeyName": "string",
    "recipientShareKey": "string",
    "recipientShareKeyName": "string",
    "status": "string",
    "createdBy": "string",
    "recipientEmail": "string",
    "updatedBy": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "comment": "string",
    "shareRequestType": "string",
    "resources": [
        {
            "resourceType": "string",
            "resourceSize": "string",
            "resourceUris": [
                "string"
            ]
        }
    ]
}

Review Share Request

The new Review Share Request operation (GET /exchangedata/v1/sharekeys/{shareKeyId}/sharerequests/{shareRequestId/review) returns detailed information about the specified share request.

The response returns the response returns configuration details depending on the reviewType. One of INBOUND_ACCEPT, INBOUND_REJECT, OUTBOUND_ACCEPT, or OUTBOUND_REJECT.

If the reviewType is INBOUND_ACCEPT, the response returns the name, serverId, securableId, and comment settings for the share request.

{
    "reviewType": "INBOUND_ACCEPT",
    "settings": {
        "comment": "string",
        "serverId": 37,
        "securableId": 56,
        "name": "string"
    }
}

If the reviewType is INBOUND_REJECT, OUTBOUND_ACCEPT, or OUTBOUND_REJECT the response returns only the comment setting.

Tenant Data API

Search Tenant Jobs

The new Search Tenant Jobs operation (GET /tenantdata/v1/jobs) enables you to search for information about tenant jobs using query filters.

Supported filter properties include status, type, and platformOperationType, of the job. The operators available for each supported property depends that property's data type.

To learn more, see Response Filtering.

The response returns an array of jobs. For each job, the response includes the jobId, status, type, resourceGroupId, and job details:

[
  {
    "jobId": "string",
    "userName": "string",
    "status": "QUEUED",
    "submittedAt": "string",
    "startedAt": "string",
    "endedAt": "string",
    "name": "string",
    "type": "string",
    "progress": 0,
    "entitlement": "string",
    "resourceGroupId": "string",
    "details": {
      "resources": [
        {
          "uri": "string"
        }
      ],
      "summary": "string"
    },
    "jobUri": "string"
  }
]

Response data can be sorted by jobId, type, name, or status. To learn more, see Response Pagination.