• items(required): array items
  Collection of WorkRequestSummary

{
    "type":"object",
    "description":"Result of a platform list or search. Contains WorkRequestSummary",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "type":"array",
            "description":"Collection of WorkRequestSummary",
            "items":{
                "$ref":"#/definitions/WorkRequestSummary"
            }
        }
    }
}

• Array of: object WorkRequestSummary
  A description of workrequest status

{
    "type":"array",
    "description":"Collection of WorkRequestSummary",
    "items":{
        "$ref":"#/definitions/WorkRequestSummary"
    }
}

• compartmentId(required): string
  The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used
• id(required): string
  The ID of the work request.
• operationType(required): string
  Allowed Values: [ "CREATE_PLATFORM", "UPDATE_PLATFORM", "UPGRADE_PLATFORM", "DELETE_PLATFORM", "SCALE_PLATFORM", "START_PLATFORM", "STOP_PLATFORM", "CUSTOMIZE_PLATFORM", "SCALE_STORAGE", "WORKREQUEST_CLEANUP" ]

  Type of the work request
• percentComplete(required): number(float)
  Percentage of the request completed.
• resources(required): array resources
  The resources affected by this work request.
• status: string
  Status of current work request.
• timeAccepted(required): string(date-time)
  The date and time the request was created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29.
• timeFinished: string(date-time)
  The date and time the object was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339).
• timeStarted: string(date-time)
  The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29.

{
    "description":"A description of workrequest status",
    "properties":{
        "operationType":{
            "type":"string",
            "enum":[
                "CREATE_PLATFORM",
                "UPDATE_PLATFORM",
                "UPGRADE_PLATFORM",
                "DELETE_PLATFORM",
                "SCALE_PLATFORM",
                "START_PLATFORM",
                "STOP_PLATFORM",
                "CUSTOMIZE_PLATFORM",
                "SCALE_STORAGE",
                "WORKREQUEST_CLEANUP"
            ],
            "description":"Type of the work request"
        },
        "status":{
            "x-obmcs-enumref":"#/definitions/WorkRequest/status",
            "description":"Status of current work request.",
            "type":"string"
        },
        "id":{
            "type":"string",
            "description":"The ID of the work request."
        },
        "compartmentId":{
            "type":"string",
            "description":"The OCID of the compartment that contains the work request. Work requests should be scoped to\nthe same compartment as the resource the work request affects. If the work request affects multiple resources,\nand those resources are not in the same compartment, it is up to the service team to pick the primary\nresource whose compartment should be used\n"
        },
        "resources":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/WorkRequestResource"
            },
            "description":"The resources affected by this work request."
        },
        "percentComplete":{
            "type":"number",
            "format":"float",
            "description":"Percentage of the request completed."
        },
        "timeAccepted":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time the request was created, as described in\n[RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29.\n"
        },
        "timeStarted":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339),\nsection 14.29.\n"
        },
        "timeFinished":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time the object was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339).\n"
        }
    },
    "required":[
        "operationType",
        "id",
        "compartmentId",
        "resources",
        "percentComplete",
        "timeAccepted"
    ]
}

• Array of: object WorkRequestResource
  A resource created or operated on by a work request.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/WorkRequestResource"
    },
    "description":"The resources affected by this work request."
}

• actionType(required): string
  Allowed Values: [ "CREATED", "UPDATED", "DELETED", "IN_PROGRESS", "RELATED" ]

  The way in which this resource is affected by the work tracked in the work request. A resource being created, updated, or deleted will remain in the IN_PROGRESS state until work is complete for that resource at which point it will transition to CREATED, UPDATED, or DELETED, respectively.
• entityType(required): string
  The resource type the work request affects.
• entityUri: string
  The URI path that the user can do a GET on to access the resource metadata
• identifier(required): string
  The identifier of the resource the work request affects.
• subTypeDetails: array subTypeDetails
  Collection of SubType information for a work request resource.

{
    "description":"A resource created or operated on by a work request.",
    "properties":{
        "entityType":{
            "type":"string",
            "description":"The resource type the work request affects."
        },
        "actionType":{
            "description":"The way in which this resource is affected by the work tracked in the work request.\nA resource being created, updated, or deleted will remain in the IN_PROGRESS state until\nwork is complete for that resource at which point it will transition to CREATED, UPDATED,\nor DELETED, respectively.\n",
            "enum":[
                "CREATED",
                "UPDATED",
                "DELETED",
                "IN_PROGRESS",
                "RELATED"
            ],
            "type":"string"
        },
        "identifier":{
            "type":"string",
            "description":"The identifier of the resource the work request affects."
        },
        "entityUri":{
            "type":"string",
            "description":"The URI path that the user can do a GET on to access the resource metadata"
        },
        "subTypeDetails":{
            "type":"array",
            "description":"Collection of SubType information for a work request resource.",
            "items":{
                "$ref":"#/definitions/WorkRequestResourceSubTypeDetail"
            }
        }
    },
    "required":[
        "actionType",
        "entityType",
        "identifier"
    ]
}

• Array of: object WorkRequestResourceSubTypeDetail
  Subtype information for a work request resource.

{
    "type":"array",
    "description":"Collection of SubType information for a work request resource.",
    "items":{
        "$ref":"#/definitions/WorkRequestResourceSubTypeDetail"
    }
}

• subType(required): string
  Subtype of the work request resource like OSN or peer.
• subTypeKey(required): string
  The identifier of the resource subtype.
• subTypeStatus(required): string
  Allowed Values: [ "CREATED", "UPDATED", "DELETED" ]

  Status of the resource subtype, as a result of the work tracked in this work request. The resource subtype would be CREATED, UPDATED or DELETED after the work request is completed.

{
    "description":"Subtype information for a work request resource.",
    "properties":{
        "subType":{
            "type":"string",
            "description":"Subtype of the work request resource like OSN or peer.\n"
        },
        "subTypeKey":{
            "type":"string",
            "description":"The identifier of the resource subtype."
        },
        "subTypeStatus":{
            "description":"Status of the resource subtype, as a result of the work tracked in this work request.\nThe resource subtype would be CREATED, UPDATED or DELETED after the work request is completed.\n",
            "enum":[
                "CREATED",
                "UPDATED",
                "DELETED"
            ],
            "type":"string"
        }
    },
    "required":[
        "subType",
        "subTypeKey",
        "subTypeStatus"
    ]
}

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        }
    }
}

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        }
    }
}