archive

Archives the strategy.

Request

Request structure in JSON format:


  "params" : { /* required */
    "SelectionCriteria" : { /* required */
      "Ids" : [ (long) ] /* required */
    }
  }

Parameter

Type

Description

Required

params structure (for JSON) / ArchiveRequest structure (for SOAP)

SelectionCriteria

IdsCriteria

Criteria for selecting portfolio strategies to archive.

Yes

IdsCriteria structure

Ids

array of long

IDs of the portfolio strategies that you want to archive (no more than ids-select).

Yes

Response

Response structure in JSON format:

{
  "result": { /* result */
    "ArchiveResults": [{  /* ActionResult */
      "Id": (long),
      "Warnings": [{  /* ExceptionNotification */
        "Code": (int), /* required */
        "Message": (string), /* required */
        "Details": (string)
       }, ...
      ],
      "Errors": [{  /* ExceptionNotification */
        "Code": (int), /* required */
        "Message": (string), /* required */
        "Details": (string)
       }, ...
      ]
    }, ... ] /* required */
  }
}

Parameter

Type

Description

result structure (for JSON) / ArchiveResponse structure (for SOAP)

ArchiveResults

array of ActionResult

Results of archiving portfolio strategies.

ActionResult structure

Id

long

Portfolio strategy ID. Returned if there aren't any errors. See the section Operations on object arrays.

Warnings

array of ExceptionNotification

Warnings that occurred during the operation.

Errors

array of ExceptionNotification

Errors that occurred during the operation.

Previous
Next