PolicyDraftListResult

This holds the list of policy drafts.


Properties

Required Property Name Type Description
optional _links array of ResourceLink

The server will populate this field when returing the resource. Ignored on PUT and POST.

optional _schema string

Schema for this resource

optional _self SelfResourceLink

Link to this resource

optional cursor string

Opaque cursor to be used for getting next page of records (supplied by current result page)

optional result_count integer

Count of results found (across all pages), set only on first page

optional results array of PolicyDraft

Paginated list of policy drafts.

optional sort_ascending boolean

If true, results are sorted in ascending order

optional sort_by string

Field by which records are sorted

Returned By


List Policy Drafts

Extends


ListResult

JSON Example

{
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "_self": {
        "action": "string",
        "href": "string",
        "rel": "string"
    },
    "cursor": "string",
    "result_count": 0,
    "results": [
        {
            "_create_time": 0,
            "_create_user": "string",
            "_last_modified_time": 0,
            "_last_modified_user": "string",
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_protection": "string",
            "_revision": 0,
            "_schema": "string",
            "_self": {
                "action": "string",
                "href": "string",
                "rel": "string"
            },
            "_system_owned": false,
            "children": [
                {
                    "_create_time": 0,
                    "_create_user": "string",
                    "_last_modified_time": 0,
                    "_last_modified_user": "string",
                    "_links": [
                        {
                            "action": "string",
                            "href": "string",
                            "rel": "string"
                        }
                    ],
                    "_protection": "string",
                    "_revision": 0,
                    "_schema": "string",
                    "_self": {
                        "action": "string",
                        "href": "string",
                        "rel": "string"
                    },
                    "_system_owned": false,
                    "description": "string",
                    "display_name": "string",
                    "id": "string",
                    "marked_for_delete": false,
                    "resource_type": "string",
                    "tags": [
                        {
                            "scope": "string",
                            "tag": "string"
                        }
                    ]
                }
            ],
            "description": "string",
            "display_name": "string",
            "id": "string",
            "is_auto_draft": false,
            "lock_comments": "string",
            "lock_modified_by": "string",
            "lock_modified_time": 0,
            "locked": false,
            "marked_for_delete": false,
            "parent_path": "string",
            "path": "string",
            "ref_draft_path": "string",
            "relative_path": "string",
            "resource_type": "string",
            "system_area": {
                "_create_time": 0,
                "_create_user": "string",
                "_last_modified_time": 0,
                "_last_modified_user": "string",
                "_links": [
                    {
                        "action": "string",
                        "href": "string",
                        "rel": "string"
                    }
                ],
                "_protection": "string",
                "_revision": 0,
                "_schema": "string",
                "_self": {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                },
                "_system_owned": false,
                "children": [
                    {
                        "_create_time": 0,
                        "_create_user": "string",
                        "_last_modified_time": 0,
                        "_last_modified_user": "string",
                        "_links": [
                            {
                                "action": "string",
                                "href": "string",
                                "rel": "string"
                            }
                        ],
                        "_protection": "string",
                        "_revision": 0,
                        "_schema": "string",
                        "_self": {
                            "action": "string",
                            "href": "string",
                            "rel": "string"
                        },
                        "_system_owned": false,
                        "description": "string",
                        "display_name": "string",
                        "id": "string",
                        "marked_for_delete": false,
                        "resource_type": "string",
                        "tags": [
                            {
                                "scope": "string",
                                "tag": "string"
                            }
                        ]
                    }
                ],
                "connectivity_strategy": "string",
                "description": "string",
                "display_name": "string",
                "domains": [
                    {
                        "_create_time": 0,
                        "_create_user": "string",
                        "_last_modified_time": 0,
                        "_last_modified_user": "string",
                        "_links": [
                            {
                                "action": "string",
                                "href": "string",
                                "rel": "string"
                            }
                        ],
                        "_protection": "string",
                        "_revision": 0,
                        "_schema": "string",
                        "_self": {
                            "action": "string",
                            "href": "string",
                            "rel": "string"
                        },
                        "_system_owned": false,
                        "children": [
                            {
                                "_create_time": 0,
                                "_create_user": "string",
                                "_last_modified_time": 0,
                                "_last_modified_user": "string",
                                "_links": [
                                    {
                                        "action": "string",
                                        "href": "string",
                                        "rel": "string"
                                    }
                                ],
                                "_protection": "string",
                                "_revision": 0,
                                "_schema": "string",
                                "_self": {
                                    "action": "string",
                                    "href": "string",
                                    "rel": "string"
                                },
                                "_system_owned": false,
                                "description": "string",
                                "display_name": "string",
                                "id": "string",
                                "marked_for_delete": false,
                                "resource_type": "string",
                                "tags": [
                                    {
                                        "scope": "string",
                                        "tag": "string"
                                    }
                                ]
                            }
                        ],
                        "description": "string",
                        "display_name": "string",
                        "id": "string",
                        "marked_for_delete": false,
                        "parent_path": "string",
                        "path": "string",
                        "relative_path": "string",
                        "resource_type": "string",
                        "tags": [
                            {
                                "scope": "string",
                                "tag": "string"
                            }
                        ]
                    }
                ],
                "id": "string",
                "marked_for_delete": false,
                "parent_path": "string",
                "path": "string",
                "relative_path": "string",
                "resource_type": "string",
                "tags": [
                    {
                        "scope": "string",
                        "tag": "string"
                    }
                ]
            },
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ],
            "user_area": {
                "_create_time": 0,
                "_create_user": "string",
                "_last_modified_time": 0,
                "_last_modified_user": "string",
                "_links": [
                    {
                        "action": "string",
                        "href": "string",
                        "rel": "string"
                    }
                ],
                "_protection": "string",
                "_revision": 0,
                "_schema": "string",
                "_self": {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                },
                "_system_owned": false,
                "children": [
                    {
                        "_create_time": 0,
                        "_create_user": "string",
                        "_last_modified_time": 0,
                        "_last_modified_user": "string",
                        "_links": [
                            {
                                "action": "string",
                                "href": "string",
                                "rel": "string"
                            }
                        ],
                        "_protection": "string",
                        "_revision": 0,
                        "_schema": "string",
                        "_self": {
                            "action": "string",
                            "href": "string",
                            "rel": "string"
                        },
                        "_system_owned": false,
                        "description": "string",
                        "display_name": "string",
                        "id": "string",
                        "marked_for_delete": false,
                        "resource_type": "string",
                        "tags": [
                            {
                                "scope": "string",
                                "tag": "string"
                            }
                        ]
                    }
                ],
                "connectivity_strategy": "string",
                "description": "string",
                "display_name": "string",
                "domains": [
                    {
                        "_create_time": 0,
                        "_create_user": "string",
                        "_last_modified_time": 0,
                        "_last_modified_user": "string",
                        "_links": [
                            {
                                "action": "string",
                                "href": "string",
                                "rel": "string"
                            }
                        ],
                        "_protection": "string",
                        "_revision": 0,
                        "_schema": "string",
                        "_self": {
                            "action": "string",
                            "href": "string",
                            "rel": "string"
                        },
                        "_system_owned": false,
                        "children": [
                            {
                                "_create_time": 0,
                                "_create_user": "string",
                                "_last_modified_time": 0,
                                "_last_modified_user": "string",
                                "_links": [
                                    {
                                        "action": "string",
                                        "href": "string",
                                        "rel": "string"
                                    }
                                ],
                                "_protection": "string",
                                "_revision": 0,
                                "_schema": "string",
                                "_self": {
                                    "action": "string",
                                    "href": "string",
                                    "rel": "string"
                                },
                                "_system_owned": false,
                                "description": "string",
                                "display_name": "string",
                                "id": "string",
                                "marked_for_delete": false,
                                "resource_type": "string",
                                "tags": [
                                    {
                                        "scope": "string",
                                        "tag": "string"
                                    }
                                ]
                            }
                        ],
                        "description": "string",
                        "display_name": "string",
                        "id": "string",
                        "marked_for_delete": false,
                        "parent_path": "string",
                        "path": "string",
                        "relative_path": "string",
                        "resource_type": "string",
                        "tags": [
                            {
                                "scope": "string",
                                "tag": "string"
                            }
                        ]
                    }
                ],
                "id": "string",
                "marked_for_delete": false,
                "parent_path": "string",
                "path": "string",
                "relative_path": "string",
                "resource_type": "string",
                "tags": [
                    {
                        "scope": "string",
                        "tag": "string"
                    }
                ]
            }
        }
    ],
    "sort_ascending": false,
    "sort_by": "string"
}
Feedback

Was this page helpful?