Query Organization Information

Last Updated on : 2023-07-06 08:23:41download

Query the organization object information on pages.

API address

POST: /v1.0/iot-03/idaas/spaces/{space_id}/organizations/actions/query

Request parameter

Parameter name	Type	IN	Required	Description
space_id	String	uri	true	The ID of a specified space.

Description of body

Parameter name	Type	IN	Required	Description
code	String	body	false	The identifier of a specified organization.
codes	List	body	false	The list of organization identifiers.
name	String	body	false	The name of a specified organization.
parent_code	String	body	false	The identifier of a specified parent organization.
remark	String	body	false	The remarks of a specified organization.
status	Integer	body	false	Indicates whether the organization is enabled. Valid values: `0`: enabled. `1`: not enabled.
page_number	Integer	body	false	The current page number.
page_size	Integer	body	false	The number of items per page.

Description of codes

Parameter name	Type	IN	Required	Description
code	String	body	false	The identifier of a specified organization.

Return parameter

Parameter name	Type	Description
result	Page	The returned result on pages, including the current page number, number of items on each page, total number of pages, total number of items, and specific data.

Description of result

Parameter name	Type	Description
total_count	Integer	The total number of items that are found.
total_pages	Integer	The total number of pages.
page_number	Integer	The current page number.
page_size	Integer	The number of items per page.
results	IdaasOrganizationVO	The list of results.

Description of results

Parameter name	Type	Description
code	String	The identifier of a specified organization.
name	String	The name of a specified organization.
parent_code	String	The identifier of a specified parent organization.
owner_uid	String	The user ID of the organization owner.
space_id	String	The ID of a specified space.
status	Integer	Indicates whether the organization is enabled. Valid values: `0`: enabled. `1`: not enabled.
remark	String	The identifier of a specified organization.

Request example

POST: /v1.0/iot-03/idaas/spaces/1400335346549391440/organizations/actions/query

{ "page_number": 10, "page_size": 20, "code": "1400335346598629930", }

Return example

{
    "result": {
        "total_count": 1,
        "total_pages": 1,
        "page_number": 1,
        "results": [
            {
                "gmt_create": "1622775600000",
                "parent_name": "testParentOrgName",
                "code": "1400335346598629930",
                "remark": "testRemark",
                "gmt_modified": "1622775600000",
                "owner_uid": "1400335346599528750",
                "name": "testOrgName",
                "parent_code": "1400335346598629666",
                "space_id": "1400727198159081506",
                "status": 0
            }
        ],
        "page_size": 20
    },
    "t": 1629272469492,
    "success": true
}

Error code

For more information, see error code.