Skip to content
This repository has been archived by the owner on Oct 8, 2020. It is now read-only.

Commit

Permalink
Merge pull request #522 from vinuvarshith/entity-unique-fields-api-ca…
Browse files Browse the repository at this point in the history
…ll-doc

Update Doc For New API Action 'getunique'
  • Loading branch information
seancolsen authored Apr 21, 2018
2 parents 1041f85 + 45960a9 commit a3f76fe
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions docs/api/actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,31 @@ Replace an old set of records with a new or modified set of records.
Warning - REPLACE includes an implicit delete - use with care & test well
before using in productions

## getunique

Returns all unique fields (other than 'id' field) for a given entity.
```php
civicrm_api3('Contribution', 'getunique');
```

return

```php
{
"is_error": 0,
"version": 3,
"count": 2,
"values": {
"UI_contrib_trxn_id": [
"trxn_id"
],
"UI_contrib_invoice_id": [
"invoice_id"
]
}
}
```

## <del>setvalue</del>

**Deprecated.** Use the create action with the param 'id' instead.
Expand Down

0 comments on commit a3f76fe

Please sign in to comment.