IRPCPropertyDefsAdmin.GetAssociatedPropertyDefs
Administration API / specialized admin session idempotent
Gets the properties of a class: the property definitions associated with it and whether each is required.
| Service | Property definition and class administration MFiles.IRPCPropertyDefsAdmin |
|---|---|
| gRPC method | /MFiles.IRPCPropertyDefsAdmin/GetAssociatedPropertyDefs |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-associated-property-defs |
| Request | GetAssociatedPropertyDefsRequest |
| Response | GetAssociatedPropertyDefsResponse |
| Book and level | Administration API, specialized |
| Kind | admin |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | yes |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
- Requires a vault session; no vault rights are needed.
- Class 0 returned 12 associations in the Sample Vault.
Request: GetAssociatedPropertyDefsRequest
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.
| Field | Type | Description |
|---|---|---|
document_profile | int32 | The ID of the class. |
Response: GetAssociatedPropertyDefsResponse
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.
| Field | Type | Description |
|---|---|---|
values[] | repeated AssociatedPropertyDef | One AssociatedPropertyDef per property of the class. |
values[].property_def | int32 | The ID of the property definition. |
values[].is_required | bool | True if objects of the class must have a value for this property. |