Breadcrumbs

Fadelconnector v1

Version 1

Connector Overview: This page documents all 64 actions for the Fadelconnector v1.

Additional Info

GET Additional Info1

/additionalinfo/{Object Variable}

Get additional info details by object and object type.

  • The following are the possible values for Object Variable:

  • parties: This object is used to return the list of the additional info field values for parties.

  • projects: This object is used to return the list of the additional info field values for projects.

  • ads: This object is used to return the list of the additional info field values for ads.

  • assets: This object is used to return the list of the additional info field values for assets.

  • agreements: This object is used to return the list of the additional info field values for agreements.

  • The possible values for Object TypeCode can be retrieved by calling the "/lookups/{Lookup Type}" endpoint with the following params depending on the object:

  • parties: FPI_PARTY_TYPES

  • projects: FPI_ADM_PROJECT_TYPES

  • ads: FPI_ARC_GROUP_SUB_TYPES

  • assets: FPI_ARC_ASSET_TYPE

  • agreements: FPI_DEAL_TYPE

  • If TypeCode is not specified, details for all the object types will be returned.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

Object variable

Object Variable

Typecode

TypeCode

Response Type

N/A

Agreement (9)

POST Create New Agreement

/agreements

Create a new Agreement in the system

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

Response Type

N/A
Options (30)

Option Name

Description

Agreementnumber

N/A

Amendmentnumber

N/A

Assetcount

N/A

Currencycode

The list of possible values can be loaded through [API domain]/[API context]/lookups/CURRENCIES

Dealid

N/A

Dealtype

N/A

Dealtypecode

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_DEAL_TYPE

Deletedassetidslst

N/A

Description

N/A

Enddate

Value provided should be an epoch timestamp; Value returned is an epoch timestamp

Executiondate

Value provided should be an epoch timestamp; Value returned is an epoch timestamp

Externalid

N/A

Internalcontact

N/A

Internalcontactid

N/A

Orgid

Unique identifier of the Business Unit. The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ORGS

Orgname

N/A

Primaryparty

N/A

Primarypartyaddress

N/A

Primarypartycontact

N/A

Primarypartycontactaddress

N/A

Primarypartyexternalid

Either primaryPartyId or primaryPartyExternalId should be populated

Primarypartyid

Either primaryPartyId or primaryPartyExternalId should be populated

Primarypartyrole

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_PARTY_ROLE

Startdate

Value provided should be an epoch timestamp; Value returned is an epoch timestamp

Status

N/A

Statuscode

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_DEAL_STATUSES

Termlength

N/A

Termlengthcode

N/A

Updatedate

Value returned is an 'MM/DD/YYYY' date format

Updatedatetime

Value returned is an epoch timestamp

GET Get Agreement By Agreement Number

/agreements/number/{Agreement Number}

Gets an existing Agreement that the user has access to based on an agreement number

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Agreement number

Agreement Number

Authorization

Authorization

Loadattachmentfile

loadAttachmentFile

Loadattachments

loadAttachments

Loadcounters

loadCounters

Response Type

N/A

GET Get Agreement By External Id

/agreements/externalagreements/{External ID}

Gets an existing Agreement that the user has access to based on an agreement external ID

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

External id

External ID

Loadattachmentfile

loadAttachmentFile

Loadattachments

loadAttachments

Loadcounters

loadCounters

Response Type

N/A

POST Get Assets List For Given Agreement

/agreements/{Agreement ID}/assets

Gets the list of assets for a given agreement

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Agreement id

Agreement ID

Authorization

Authorization

Response Type

N/A
Options (21)

Option Name

Description

Assetid

N/A

Campaignid

N/A

Dealid

N/A

Excludedgroupid

N/A

Excludedidslst

N/A

Externalid

N/A

Globalsearch

N/A

Groupid

N/A

Includedidslst

N/A

Istemplate

N/A

Limit

N/A

Loadthumbnails

N/A

Name

N/A

Offset

N/A

Orgids

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ORGS

Partyid

N/A

Projectid

N/A

Sortfield

Possible values: "name", "description", "typeName", "statusName", "sourceName", "haveThumbnail", "id", "externalId", "typeCode", "statusCode", "creationDate" and "projectName" for project name

Sortorder

Possible values: "asc" for ascending, "desc" for descending

Thumbnailtypecode

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ARC_THUMBNAIL_DIMENSIONS

Typecode

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ARC_ASSET_TYPE

GET Get Existing Agreement Based On Agreement Id

/agreements/{Agreement ID}

Gets an existing Agreement that the user has access to based on an Agreement ID

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Agreement id

Agreement ID

Authorization

Authorization

Loadattachmentfile

loadAttachmentFile

Loadattachments

loadAttachments

Loadcounters

loadCounters

Response Type

N/A

GET Get Project List Associated To Agreement

/agreements/projects

Gets the list of projects that can be associated to an agreement right

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

Orgids

orgIds

Response Type

N/A

POST Get the list of Agreements User Has Access

/agreements/search

Gets the list of Agreements from the system that the user has access to

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

Response Type

N/A
Options (47)

Option Name

Description

Agreementnumber

N/A

Assetexternalid

N/A

Assetexternalids

N/A

Assetid

N/A

Assetids

comma separated string of assets IDs

Currencycode

The list of possible values can be loaded through [API domain]/[API context]/lookups/CURRENCIES

Currencycodelist

The list of possible values can be loaded through [API domain]/[API context]/lookups/CURRENCIES

Dealid

N/A

Dealtypecode

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_DEAL_TYPE

Dealtypecodelist

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_DEAL_TYPE

Description

N/A

Enddate

Value provided should be an epoch timestamp

Enddateisrange

N/A

Excludedids

N/A

Excludedpartyids

N/A

Excludedprojectids

N/A

Externalid

N/A

Globalsearch

String value representing an Agreement Number, Description or Primary Party

Includesharedagreements

N/A

Internalcontactid

N/A

Internalcontactidlist

N/A

Limit

N/A

Loadattachments

N/A

Loadcounters

N/A

Notes

N/A

Offset

N/A

Orgid

Business Unit Unique Identifier. The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ORGS

Orgids

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ORGS

Partyid

N/A

Partyidlist

N/A

Projectid

N/A

Projectnumber

N/A

Rightdesc

N/A

Rightsenddate

N/A

Rightsenddateisrange

N/A

Rightsstartdate

N/A

Rightsstartdateisrange

N/A

Showprojects

N/A

Sortfield

Possible values: "agreementNumber", "description", "dealType", "status", "primaryParty", "primaryPartyContact", "startDate" and "endDate"

Sortorder

Possible values: "asc" for ascending, "desc" for descending

Startdate

Value provided should be an epoch timestamp

Startdateisrange

N/A

Statuscode

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_DEAL_STATUSES

Statuscodelist

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_DEAL_STATUSES

Thumbnailtypecode

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ARC_THUMBNAIL_DIMENSIONS

Updatedate

Value provided should be in 'MM/DD/YYYY' date format

Updatedateisrange

N/A

PUT Link Assets To An Agreement

/agreements/{Agreement ID}/assets

Link assets to an agreement

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Agreement id

Agreement ID

Authorization

Authorization

Response Type

N/A

PUT Update An Existing Agreement

/agreements/{Agreement ID}

Update an existing Agreement from the system that the user has access to.
Note: An agreement that is shared between business units can only be updated by users belonging to the Business Unit who shared it. The only exception is "deletedAssetIdsLst" property that can be called by any Business Unit that can see the agreements.

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Agreement id

Agreement ID

Authorization

Authorization

Response Type

N/A
Options (30)

Option Name

Description

Agreementnumber

N/A

Amendmentnumber

N/A

Assetcount

N/A

Currencycode

The list of possible values can be loaded through [API domain]/[API context]/lookups/CURRENCIES

Dealid

N/A

Dealtype

N/A

Dealtypecode

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_DEAL_TYPE

Deletedassetidslst

N/A

Description

N/A

Enddate

Value provided should be an epoch timestamp; Value returned is an epoch timestamp

Executiondate

Value provided should be an epoch timestamp; Value returned is an epoch timestamp

Externalid

N/A

Internalcontact

N/A

Internalcontactid

N/A

Orgid

Unique identifier of the Business Unit. The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ORGS

Orgname

N/A

Primaryparty

N/A

Primarypartyaddress

N/A

Primarypartycontact

N/A

Primarypartycontactaddress

N/A

Primarypartyexternalid

Either primaryPartyId or primaryPartyExternalId should be populated

Primarypartyid

Either primaryPartyId or primaryPartyExternalId should be populated

Primarypartyrole

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_PARTY_ROLE

Startdate

Value provided should be an epoch timestamp; Value returned is an epoch timestamp

Status

N/A

Statuscode

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_DEAL_STATUSES

Termlength

N/A

Termlengthcode

N/A

Updatedate

Value returned is an 'MM/DD/YYYY' date format

Updatedatetime

Value returned is an epoch timestamp

Asset (12)

POST Asset Copy

/assets/copy

Copy the selected asset that the user has access to the system

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

Response Type

N/A
Options (8)

Option Name

Description

Assetid

N/A

Copygroup

N/A

Copyprojectagreement

N/A

Externalid

N/A

Externalrefid

N/A

Externalurl

N/A

Name

N/A

Statuscode

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ARC_STATUS

POST Create New Asset

/assets

Creates a new asset in the system

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

Response Type

N/A
Options (23)

Option Name

Description

Agreementid

In Create request, at least one of "agreementId" and "agreementNumber" should have a valid value to link the asset to the selected agreement.

Agreementnumber

In Create request, at least one of "agreementId" and "agreementNumber" should have a valid value to link the asset to the selected agreement.

Assetextid

N/A

Assetid

In Create request, the asset Id value should always be zero

Categorycode

If not provided, the asset will be created as a standalone parent asset. To create assets of another category (derivatives), the following is required: 1) The category code must be provided as the value for this attribute. The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ARC_ASSET_CATEGORIES. 2) Either the ID or the external ID of the parent asset must be provided as the value for relatedAssetId/relatedAssetExtId.

Compositeflag

N/A

Compositeorcomponentassetextids

N/A

Compositeorcomponentassetids

N/A

Description

N/A

Externalurl

N/A

Feeamount

N/A

Feecurrencycode

The list of possible values can be loaded through [API domain]/[API context]/lookups/CURRENCIES

Imageuri

Value provided should be the URI for the thumbnail, to be specified if it is an image located on the Internet

Name

N/A

Projectid

In Create request, at least one of "projectId" and "projectNumber" should have a valid value to link the asset to the selected project.

Projectnumber

In Create request, at least one of "projectId" and "projectNumber" should have a valid value to link the asset to the selected project.

Relatedassetextid

External ID of the parent asset for which the related asset (derivative) will be created.

Relatedassetid

ID of the parent asset for which the related asset (derivative) will be created.

Statuscode

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ARC_STATUS

Thumbnail

Value provided should be in Base64 encoding

Thumbnailname

N/A

Typecode

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ARC_ASSET_TYPE

Websearch

N/A

POST Creates or updates bulk assets with same right

/assets/bulk/rights

Creates or updates bulk assets with same right(s)

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

Response Type

N/A
Options (3)

Option Name

Description

Assetids

Determines list of Asset IDs. Required if 'assetExternalIds' property is left empty

Assetexternalids

Determines list of Asset External IDs. Required if 'assetIds' left empty

Orgids

N/A

POST Creates video

/assets/video

Creates a new video asset in the system

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

Response Type

N/A
Options (2)

Option Name

Description

Assetjson

assetJson

File

file

DELETE Delete Assets From System

/assets

Deletes assets that the user has access to from the system

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

Response Type

N/A
Options (3)

Option Name

Description

Assetstobedeleted

List of asset IDs to be deleted

Externalassetstobedeleted

List of external asset identifiers to be deleted

Orgids

List of organization IDs associated with the assets

GET Get Asset By External Id

/assets/externalassets/{External ID}

Gets the details of an asset that the user has access to from the system using its external ID

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

External id

External ID

Response Type

N/A

GET Get Asset Details

/assets/{Asset ID}

Gets the details of an asset that the user has access to from the system using its ID

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Asset id

Asset ID

Authorization

Authorization

Response Type

N/A

GET Get Asset Thumbnail

/assets/{Asset ID}/thumbnail

Returns the thumbnail of the selected asset that the user has access to from the system

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Asset id

Asset ID

Authorization

Authorization

Response Type

N/A

GET Get Asset Video

/assets/{Asset ID}/video

Returns the video of the selected asset that the user has access to from the system

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Asset id

Asset ID

Authorization

Authorization

Response Type

N/A

POST Search Asset

/assets/search

Gets a list of assets that the user has access to from the system

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

Offset (this parameter is used to indicate the number of assets per page)

offset (This parameter is used to indicate the number of assets per page)

Page (this parameter is used to indicate the page number)

page (This parameter is used to indicate the page number)

Response Type

N/A
Options (30)

Option Name

Description

Assetidlst

N/A

Creationdatefrom

Value provided should be an epoch timestamp

Creationdateto

Value provided should be an epoch timestamp

Datasource

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ARC_DATA_SOURCE

Daterange

N/A

Description

N/A

Externalidentifier

N/A

Externalidentifierlst

N/A

Identifier

N/A

Indatefrom

N/A

Indateto

N/A

Isexpiredornearexpiration

Specify "1" as the value to search for assets where asset usage status on sites is Expired or Near Expiration

Ismissingrights

Specify "1" as the value to search for assets where asset usage status on sites is Missing Rights

Isvalid

Specify "1" as the value to search for assets where asset usage status on sites is Valid

Name

N/A

Orgids

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ORGS

Outdatefrom

N/A

Outdateto

N/A

Processingstatuscode

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ARC_ASSET_PROCESSING_STATUS

Processingstatuscodelist

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ARC_ASSET_PROCESSING_STATUS

Projectidlst

N/A

Projectnumberlst

N/A

Ruletype

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ARC_RULE_TYPE

Showagreements

N/A

Statuscode

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ARC_STATUS

Statuscodelist

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ARC_STATUS

Typecode

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ARC_ASSET_TYPE

Typecodelist

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ARC_ASSET_TYPE

Updatedatefrom

Value provided should be an epoch timestamp

Updatedateto

Value provided should be an epoch timestamp

PUT Update An Existing Asset

/assets

Updates an existing asset that the user has access to in the system

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

Response Type

N/A
Options (25)

Option Name

Description

Agreementid

In Update request, at least one of "agreementId" and "agreementNumber" should have a valid value to link the asset to the selected agreement.

Agreementnumber

In Update request, at least one of "agreementId" and "agreementNumber" should have a valid value to link the asset to the selected agreement.

Assetextid

In Update request, either of the following fields should have a valid value: "assetId" and "assetExtId"

Assetid

In Update request, either of the following fields should have a valid value: "assetId" and "assetExtId"

Compositeflag

N/A

Compositeorcomponentassetextids

N/A

Compositeorcomponentassetids

N/A

Deletecompositeorcomponentassetextids

N/A

Deletecompositeorcomponentassetids

N/A

Description

N/A

Externalurl

N/A

Feeamount

N/A

Feecurrencycode

The list of possible values can be loaded through [API domain]/[API context]/lookups/CURRENCIES

Name

N/A

Projectid

In Update request, at least one of "projectId" and "projectNumber" should have a valid value to link the asset to the selected project.

Projectnumber

In Update request, at least one of "projectId" and "projectNumber" should have a valid value to link the asset to the selected project.

Removethumbnail

N/A

Removevideo

N/A

Sourcecode

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ARC_DATA_SOURCE

Statuscode

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ARC_STATUS

Thumbnail

Value provided should be in Base64 encoding

Thumbnaillength

N/A

Thumbnailname

N/A

Typecode

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ARC_ASSET_TYPE

Websearch

N/A

PUT Update An Existing Video Asset

/assets/video

Updates an existing video asset that the user has access to in the system

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

Response Type

N/A
Options (2)

Option Name

Description

Assetjson

assetJson

File

file

Authenticate (2)

POST Generate Token

/authenticate

This API is responsible for the authentication and the generation of tokens
The request body should pass a json with the following pattern {"authRequestToken":"username:password"}
where username:password should be base64 encoded

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A
Options (8)

Option Name

Description

Apikey

N/A

Authrequesttoken

It should hold a base64 encoded value of the username:password

Googleaccesstoken

N/A

Microsoftaccesstoken

N/A

Samlloginusername

N/A

Samltoken

N/A

Twofactorcode

N/A

Username

N/A

POST Renew Access Token

/authenticate/renew

This API is responsible for renewing the access token.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

Content-type

N/A

Response Type

N/A

Clearance (5)

POST Clearance 2

/clearance/assetclearance/answers/{Answer Type}/{Asset ID}

Return the answers list for rights availability based on the provided search criteria of a given asset (Asset ID) for a given answer type.
The following are the possible values for:

  • Asset ID: The asset identifier.

  • Answer Type: The rights availability type

  • available for the available rights results of the previously executed clearance on the given asset.

  • notavailable for the not available rights results of the previously executed clearance on the given asset.

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Answer type

Answer Type

Asset id

Asset ID

Authorization

Authorization

Limit

limit

Offset

offset

Response Type

N/A
Options (5)

Option Name

Description

Expandnodes

When this field is set to true, a detailed answer list will be returned based on the rights attributes sent in the clearance request.

Indate

Value provided should be a timestamp

Outdate

Value provided should be a timestamp

Sortfield

Possible values: "2" for startDate, "3" for endDate, "6" for obligationFeeDescription , "7" for obligationAcknowledgment and "9" for violatedAgreements

Sortorder

Possible values: "asc" for ascending, "desc" for descending

POST Clearance 5

/clearance/rightsrequest

Initiates a rights request based on a provided clearance query and sends an email to the specified recipients.

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

Response Type

N/A
Options (11)

Option Name

Description

Body

When this field is not specified, the default value will be set: "Please secure additional rights for these assets"

Expandnodes

When this field is set to true, a detailed answer list will be returned based on the rights attributes sent in the clearance request.

Indate

Value provided should be an epoch timestamp

Includesender

When this field is set to true, a copy of the email is sent to the authenticated user

Isallgroups

"true" to get clearance for all groups

Orgids

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ORGS

Outdate

Value provided should be an epoch timestamp

Selectedassets

Asset IDs, or "all" when clearing all assets. Required if selectedExternalAssets left empty

Selectedexternalassets

Asset External IDs. Required if selectedAssets left empty

Subject

When this field is not specified, the default value will be set: "Additional Rights Request"

Torecipient

N/A

POST Returns Clearance Summary Of Assets

/clearance/clearancesummary

Returns the clearance summary of the selected assets

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

Limit

limit

Offset

offset

Response Type

N/A
Options (6)

Option Name

Description

Isallgroups

"true" to get clearance for all groups

Orgids

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ORGS

Selectedassets

Asset IDs. Required if selectedExternalAssets left empty

Selectedexternalassets

Asset External IDs. Required if selectedAssets left empty

Sortfield

Possible values: "2" for asset id, "3" for asset name, "4" for asset external id, "9" for start date, "10" for end date

Sortorder

Possible values: "asc" for ascending, "desc" for descending

POST Returns Clearance Warning Of Selected Assets

/clearance/clearancewarnings

Returns the clearance warning of the selected assets

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

Limit

limit

Offset

offset

Response Type

N/A
Options (8)

Option Name

Description

Draftagreementfilter

N/A

Draftagreementlimit

N/A

Draftagreementoffset

N/A

Orgids

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ORGS

Selectedassets

Asset IDs. Required if selectedExternalAssets left empty

Selectedexternalassets

Asset External IDs. Required if selectedAssets left empty

Sortfield

Possible values: "ASSET_ID" for asset id, "NAME" for asset name, "EXTERNAL_ID" for asset external id, "TYPE_CODE" for asset type code, "TYPENAME" for asset type name

Sortorder

Possible values: "asc" for ascending, "desc" for descending

POST Returns Clearances List

/clearance/assetclearance

Returns the list of Clearances based on the Asset Clearance search Criteria

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

Limit

limit

Offset

offset

Response Type

N/A
Options (8)

Option Name

Description

Indate

Value provided should be an epoch timestamp

Isallgroups

"true" to get clearance for all groups

Orgids

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ORGS

Outdate

Value provided should be an epoch timestamp

Selectedassets

Asset IDs, or "all" when clearing all assets. Required if selectedExternalAssets left empty

Selectedexternalassets

Asset External IDs. Required if selectedAssets left empty

Sortfield

Possible values: "2" for asset id, "3" for asset name, "7" for notAvailable, "8" for available

Sortorder

Possible values: "asc" for ascending, "desc" for descending

Global Rule (6)

POST Create New Global Rule

/globalrules

Creates a new global rule in the system

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

Response Type

N/A
Options (7)

Option Name

Description

Assettypecode

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ARC_ASSET_TYPE

Description

N/A

Enddate

Value provided should be an epoch timestamp

Externalid

N/A

Id

The id value should always be zero

Ruletypecode

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ARC_RULE_TYPE

Startdate

Value provided should be an epoch timestamp

DELETE Delete Global Rule

/globalrules

Deletes global rules that the user has access to from the system

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

Response Type

N/A

GET Get Details Of Global Rule Based On Id

/globalrules/{Global Rule ID}

Gets the details of a global rule that the user has access to from the system using its ID

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

Global rule id

Global Rule ID

Response Type

N/A

POST Get List Of Global Rules

/globalrules/search

Gets a list of global rules that the user has access to from the system

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

Response Type

N/A
Options (16)

Option Name

Description

Assettype

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ARC_ASSET_TYPE

Datasource

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ARC_DATA_SOURCE

Daterange

N/A

Description

N/A

Externalid

N/A

Id

N/A

Indatefrom

Value provided should be an epoch timestamp

Indateto

Value provided should be an epoch timestamp

Limit

N/A

Offset

N/A

Orgids

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ORGS

Outdatefrom

Value provided should be an epoch timestamp

Outdateto

Value provided should be an epoch timestamp

Ruletype

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ARC_RULE_TYPE

Sortfield

Possible values: "2" for id, "3" for description, "5" for startDate, "6" for endDate, "8" for sourceName, "10" for assetTypeName and "12" for ruleTypeName

Sortorder

Possible values: "asc" for ascending, "desc" for descending

GET Gets Details Of Global Rule

/globalrules/externalglobalrules/{External ID}

Gets the details of a global rule that the user has access to from the system using its external ID

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

External id

External ID

Response Type

N/A

PUT Update An Existing Global Rule

/globalrules

Updates an existing global rule that the user has access to in the system

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

Response Type

N/A
Options (7)

Option Name

Description

Assettypecode

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ARC_ASSET_TYPE

Description

N/A

Enddate

Value provided should be an epoch timestamp

Externalid

Either of the following fields should have a valid value: "id" and "externalId"

Id

Either of the following fields should have a valid value: "id" and "externalId"

Ruletypecode

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ARC_RULE_TYPE

Startdate

Value provided should be an epoch timestamp

Group (6)

POST Create New Group In System

/groups

Creates a new group in the system

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

Response Type

N/A
Options (8)

Option Name

Description

Description

N/A

Externalid

N/A

Groupsubtypecode

N/A

Grouptypecode

N/A

Id

The id value should always be zero

Name

N/A

Selectedallassets

In case user wants to add all assets to the current group then this attribute value should be "true" and no need to provide assets map details as part of the request; Otherwise, this attribute value should be "false"

Statuscode

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ARC_STATUS

POST Group 1

/groups/search

Gets a list of groups that the user has access to from the system

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

Response Type

N/A
Options (12)

Option Name

Description

Assettypecode

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ARC_ASSET_TYPE

Description

N/A

Externalid

N/A

Id

N/A

Limit

N/A

Name

N/A

Offset

N/A

Orgids

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ORGS

Sortfield

Possible values: "2" for id, "3" for name, "4" for description and "5" for statusName

Sortorder

Possible values: "asc" for ascending, "desc" for descending

Statuscode

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ARC_STATUS

Statuscodelist

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ARC_STATUS

PUT Group 3

/groups

Updates an existing group that the user has access to in the system

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

Response Type

N/A
Options (8)

Option Name

Description

Description

N/A

Externalid

Either of the following fields should have a valid value: "id" and "externalId"

Groupsubtypecode

N/A

Grouptypecode

N/A

Id

Either of the following fields should have a valid value: "id" and "externalId"

Name

N/A

Selectedallassets

In case user wants to add all assets to the current group then this attribute value should be "true" and no need to provide assets map details as part of the request; Otherwise, this attribute value should be "false"

Statuscode

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ARC_STATUS

DELETE Group 4

/groups

Deletes groups that the user has access to from the system

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

Response Type

N/A

GET Group 5

/groups/{Group ID}

Gets the details of a group that the user has access to from the system using its ID

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

Group id

Group ID

Response Type

N/A

GET Group 6

/groups/externalgroups/{External ID}

Gets the details of a group that the user has access to from the system using its external ID

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

External id

External ID

Response Type

N/A

Lookup (2)

GET Lookup 1

/lookups/{Lookup Type}

Returns lookup values based on the provided lookup type.
The following is a sample of possible values for Lookup Type:

  • FPI_ARC_ASSET_TYPE: This lookup is used to list the asset types.

  • FPI_ARC_DATA_SOURCE: This lookup is used to list the source types.

  • FPI_ARC_RULE_TYPE: This lookup is used to list the global rule types.

  • FPI_ARC_SCOPE_TYPE: This lookup is used to list the scope types.

  • FPI_ARC_STATUS: This lookup is used to list the asset statuses.

  • FPI_ATT_CATEGORIES: This lookup is used to list the attachment category types.

  • FPI_ATT_TYPES: This lookup is used to list the attachment types.

  • FPI_PARTY_ROLE: This lookup is used to list the party roles.

  • FPI_ORGS: This lookup is used to list the business units.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

Lookup type

Lookup Type

Languagecode

languageCode

Loadtranslation

loadTranslation

Response Type

N/A

POST Lookup 2

/lookups/{Lookup Type}/{Object Role}

Returns lookup values based on the provided lookup type and object role.
The following are the possible values for:

  • Lookup Type:

  • FPI_ATT_CATEGORIES: This lookup is used to list the attachment categories.

  • *Object Role*:

  • partyattachment: This object role is used to return the list of the allowed lookup values for party attachments.

  • agreementattachment: This object role is used to return the list of the allowed lookup values for agreement attachments.

  • assetattachment: This object role is used to return the list of the allowed lookup values for asset attachments.

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

Lookup type

Lookup Type

Object role

Object Role

Response Type

N/A
Options (1)

Option Name

Description

Orgids

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ORGS

Party (7)

POST Create New Party In System

/parties

Create a new Party in the system

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

Response Type

N/A
Options (15)

Option Name

Description

Agreementcount

N/A

Alias

N/A

Assetcount

N/A

Campaignscount

N/A

Enabledflag

Determines if party is active

Externalid

N/A

Firstname

N/A

Id

N/A

Iscompany

Determines if party is company

Lastname

N/A

Selectedcontributorrole

This property should be sent when removing or replacing roles already associated with assets

Thumbnail

Value provided should be in Base64 encoding

Thumbnailname

N/A

Typecode

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_PARTY_TYPES

Typename

N/A

GET Get Existing Party Based On External Id

/parties/externalparties/{External ID}

Gets an existing Party that the user has access to using the Party External ID

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

External id

External ID

Loadattachmentfile

loadAttachmentFile

Loadattachments

loadAttachments

Loadcounters

loadCounters

Response Type

N/A

GET Get Existing Party Using Party Id

/parties/{Party ID}

Gets an existing Party that the user has access to using the Party ID

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

Party id

Party ID

Loadattachmentfile

loadAttachmentFile

Loadattachments

loadAttachments

Loadcounters

loadCounters

Response Type

N/A

POST Get List Of Agreements For Party

/parties/{Party ID}/agreements

Gets the list of agreements for a given party

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

Party id

Party ID

Response Type

N/A
Options (47)

Option Name

Description

Agreementnumber

N/A

Assetexternalid

N/A

Assetexternalids

N/A

Assetid

N/A

Assetids

comma separated string of assets IDs

Currencycode

The list of possible values can be loaded through [API domain]/[API context]/lookups/CURRENCIES

Currencycodelist

The list of possible values can be loaded through [API domain]/[API context]/lookups/CURRENCIES

Dealid

N/A

Dealtypecode

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_DEAL_TYPE

Dealtypecodelist

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_DEAL_TYPE

Description

N/A

Enddate

Value provided should be an epoch timestamp

Enddateisrange

N/A

Excludedids

N/A

Excludedpartyids

N/A

Excludedprojectids

N/A

Externalid

N/A

Globalsearch

String value representing an Agreement Number, Description or Primary Party

Includesharedagreements

N/A

Internalcontactid

N/A

Internalcontactidlist

N/A

Limit

N/A

Loadattachments

N/A

Loadcounters

N/A

Notes

N/A

Offset

N/A

Orgid

Business Unit Unique Identifier. The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ORGS

Orgids

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ORGS

Partyid

N/A

Partyidlist

N/A

Projectid

N/A

Projectnumber

N/A

Rightdesc

N/A

Rightsenddate

N/A

Rightsenddateisrange

N/A

Rightsstartdate

N/A

Rightsstartdateisrange

N/A

Showprojects

N/A

Sortfield

Possible values: "agreementNumber", "description", "dealType", "status", "primaryParty", "primaryPartyContact", "startDate" and "endDate"

Sortorder

Possible values: "asc" for ascending, "desc" for descending

Startdate

Value provided should be an epoch timestamp

Startdateisrange

N/A

Statuscode

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_DEAL_STATUSES

Statuscodelist

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_DEAL_STATUSES

Thumbnailtypecode

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ARC_THUMBNAIL_DIMENSIONS

Updatedate

Value provided should be in 'MM/DD/YYYY' date format

Updatedateisrange

N/A

POST Get List of Assets For Given Party

/parties/{Party ID}/assets

Gets the list of assets for a given party

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

Party id

Party ID

Response Type

N/A
Options (21)

Option Name

Description

Assetid

N/A

Campaignid

N/A

Dealid

N/A

Excludedgroupid

N/A

Excludedidslst

N/A

Externalid

N/A

Globalsearch

N/A

Groupid

N/A

Includedidslst

N/A

Istemplate

N/A

Limit

N/A

Loadthumbnails

N/A

Name

N/A

Offset

N/A

Orgids

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ORGS

Partyid

N/A

Projectid

N/A

Sortfield

Possible values: "name", "description", "typeName", "statusName", "sourceName", "haveThumbnail", "id", "externalId", "typeCode", "statusCode", "creationDate" and "projectName" for project name

Sortorder

Possible values: "asc" for ascending, "desc" for descending

Thumbnailtypecode

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ARC_THUMBNAIL_DIMENSIONS

Typecode

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ARC_ASSET_TYPE

POST Get Parties List

/parties/search

Gets the list of Parties from the system that the user has access to

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

Response Type

N/A
Options (33)

Option Name

Description

Active

N/A

Advancesearch

N/A

Agreementid

N/A

Alias

N/A

Applydefaultmacro

N/A

Applymacroid

N/A

Assetid

N/A

Assets

N/A

Contactid

N/A

Enddate

N/A

Enddateisrange

N/A

Excludedids

N/A

Externalid

N/A

Globalsearch

String value representing a Party ID (1,2,3) or range of IDs (5-12), or a Party Name, Role or Alias

Includesharedparties

N/A

Limit

N/A

Loadthumbnails

N/A

Name

N/A

Offset

N/A

Orgid

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ORGS

Orgids

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ORGS

Pagenumber

N/A

Partycategory

This field is used to search for Individuals and/or Companies parties. "0" : All,"1" : Individual, "2" : Company

Partyid

N/A

Partyname

N/A

Roleid

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_PARTY_ROLE

Roleidlist

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_PARTY_ROLE

Sortfield

Possible values: "partyName", "roleName", "phone", "email", "PRIMARY_CONTACT_NAME" for primary contact name and "RELATION_TYPE_NAME" for primary contact relationship type name

Sortorder

Possible values: "asc" for ascending, "desc" for descending

Startdate

N/A

Startdateisrange

N/A

Typecode

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_PARTY_TYPES

Typecodelist

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_PARTY_TYPES

PUT Update An Existing Party

/parties/{Party ID}

Update an existing Party from the system that the user has access to

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

Party id

Party ID

Response Type

N/A
Options (15)

Option Name

Description

Agreementcount

N/A

Alias

N/A

Assetcount

N/A

Campaignscount

N/A

Enabledflag

Determines if party is active

Externalid

N/A

Firstname

N/A

Id

N/A

Iscompany

Determines if party is company

Lastname

N/A

Selectedcontributorrole

This property should be sent when removing or replacing roles already associated with assets

Thumbnail

Value provided should be in Base64 encoding

Thumbnailname

N/A

Typecode

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_PARTY_TYPES

Typename

N/A

Project (7)

POST Create New Project

/projects

This API is responsible for creating new projects in the system

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

Response Type

N/A
Options (11)

Option Name

Description

Agreementcount

N/A

Assetcount

N/A

Comment

N/A

Deletedassetidslst

N/A

Description

N/A

Id

N/A

Name

N/A

Partycount

N/A

Projectnumber

N/A

Typecode

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ADM_PROJECT_TYPES

Typename

N/A

POST Get List Of Projects

/projects/search

This API is responsible for getting a list of projects from the system

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

Response Type

N/A
Options (17)

Option Name

Description

Agreementid

N/A

Assetid

N/A

Assets

N/A

Date

Value provided should be in 'MM/DD/YYYY' date format or in 'MM-DD-YYYY' date format

Dateisrange

N/A

Description

N/A

Globalsearch

String value representing a Project Number, Name or Description

Includesharedprojects

N/A

Limit

N/A

Offset

N/A

Orgids

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ORGS

Projectname

N/A

Projectnumber

N/A

Sortfield

Possible values: "projectNumber", "name", "description" and "dateDescription"

Sortorder

Possible values: "asc" for ascending, "desc" for descending

Typecode

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ADM_PROJECT_TYPES

Typecodelist

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ADM_PROJECT_TYPES

GET Get Project Based On Project Id

/projects/{Project ID}

This API is responsible for getting one project from the system based on a project ID

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

Project id

Project ID

Loadcounters

loadCounters

Response Type

N/A

GET Get Project Based On Project Number

/projects/number/{Project Number}

This API is responsible for getting one project from the system based on a project number

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

Project number

Project Number

Loadcounters

loadCounters

Response Type

N/A

POST Project 6

/projects/{Project ID}/agreements

Gets the list of agreements for a given project

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

Project id

Project ID

Response Type

N/A
Options (47)

Option Name

Description

Agreementnumber

N/A

Assetexternalid

N/A

Assetexternalids

N/A

Assetid

N/A

Assetids

comma separated string of assets IDs

Currencycode

The list of possible values can be loaded through [API domain]/[API context]/lookups/CURRENCIES

Currencycodelist

The list of possible values can be loaded through [API domain]/[API context]/lookups/CURRENCIES

Dealid

N/A

Dealtypecode

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_DEAL_TYPE

Dealtypecodelist

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_DEAL_TYPE

Description

N/A

Enddate

Value provided should be an epoch timestamp

Enddateisrange

N/A

Excludedids

N/A

Excludedpartyids

N/A

Excludedprojectids

N/A

Externalid

N/A

Globalsearch

String value representing an Agreement Number, Description or Primary Party

Includesharedagreements

N/A

Internalcontactid

N/A

Internalcontactidlist

N/A

Limit

N/A

Loadattachments

N/A

Loadcounters

N/A

Notes

N/A

Offset

N/A

Orgid

Business Unit Unique Identifier. The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ORGS

Orgids

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ORGS

Partyid

N/A

Partyidlist

N/A

Projectid

N/A

Projectnumber

N/A

Rightdesc

N/A

Rightsenddate

N/A

Rightsenddateisrange

N/A

Rightsstartdate

N/A

Rightsstartdateisrange

N/A

Showprojects

N/A

Sortfield

Possible values: "agreementNumber", "description", "dealType", "status", "primaryParty", "primaryPartyContact", "startDate" and "endDate"

Sortorder

Possible values: "asc" for ascending, "desc" for descending

Startdate

Value provided should be an epoch timestamp

Startdateisrange

N/A

Statuscode

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_DEAL_STATUSES

Statuscodelist

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_DEAL_STATUSES

Thumbnailtypecode

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ARC_THUMBNAIL_DIMENSIONS

Updatedate

Value provided should be in 'MM/DD/YYYY' date format

Updatedateisrange

N/A

POST Project 7

/projects/{Project ID}/assets

Get project related assets

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

Project id

Project ID

Response Type

N/A
Options (21)

Option Name

Description

Assetid

N/A

Campaignid

N/A

Dealid

N/A

Excludedgroupid

N/A

Excludedidslst

N/A

Externalid

N/A

Globalsearch

N/A

Groupid

N/A

Includedidslst

N/A

Istemplate

N/A

Limit

N/A

Loadthumbnails

N/A

Name

N/A

Offset

N/A

Orgids

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ORGS

Partyid

N/A

Projectid

N/A

Sortfield

Possible values: "name", "description", "typeName", "statusName", "sourceName", "haveThumbnail", "id", "externalId", "typeCode", "statusCode", "creationDate" and "projectName" for project name

Sortorder

Possible values: "asc" for ascending, "desc" for descending

Thumbnailtypecode

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ARC_THUMBNAIL_DIMENSIONS

Typecode

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ARC_ASSET_TYPE

PUT Update Existing Projects

/projects/{Project ID}

This API is responsible for updating existing projects in the system that the user has access to.
Note: A project that is shared between business units can only be updated by users belonging to the Business Unit who shared it. The only exception is "deletedAssetIdsLst" property that can be called by any Business Unit that can see the projects.

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

Project id

Project ID

Response Type

N/A
Options (11)

Option Name

Description

Agreementcount

N/A

Assetcount

N/A

Comment

N/A

Deletedassetidslst

N/A

Description

N/A

Id

N/A

Name

N/A

Partycount

N/A

Projectnumber

N/A

Typecode

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ADM_PROJECT_TYPES

Typename

N/A

Right (4)

POST Right 1

/rights/search/{Right Type Code}

Gets a list of rights attributes that the user has access to from the system for a given right type code.
The list of possible values for the Right Type Code can be loaded through:

  • [API domain]/[API context]/lookups/FPI_RIGHT_DEFINITION_TYPES

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

Right type code

Right Type Code

Response Type

N/A
Options (7)

Option Name

Description

Description

N/A

Externalid

N/A

Indatefrom

Value provided should be an epoch timestamp or in 'YYYY-MM-DD' date format

Indateto

Value provided should be an epoch timestamp or in 'YYYY-MM-DD' date format

Orgids

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ORGS

Outdatefrom

Value provided should be an epoch timestamp or in 'YYYY-MM-DD' date format

Outdateto

Value provided should be an epoch timestamp or in 'YYYY-MM-DD' date format

POST Right 2

/rights

Creates new rights attributes in the system

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

Response Type

N/A

PUT Right 3

/rights

Updates an existing rights attribute that the user has access to in the system

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

Response Type

N/A
Options (11)

Option Name

Description

Code

N/A

Description

N/A

Enddate

Value Provided should be in 'YYYY-MM-DD' date format; Value returned is timestamp

Parentrightsattributeexternalid

N/A

Rightexternalid

N/A

Rightid

N/A

Rightorder

N/A

Rightsattributeexternalid

N/A

Rightsattributeid

N/A

Startdate

Value Provided should be in 'YYYY-MM-DD' date format; Value returned is timestamp

Typecode

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_RIGHT_DEFINITION_TYPES

DELETE Right 4

/rights

Deletes rights attributes that the user has access to from the system

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

Response Type

N/A

Site (3)

POST Creates New Site In System

/sites

Creates a new site in the system

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

Response Type

N/A
Options (10)

Option Name

Description

Buids

N/A

Domaincode

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ADM_IMAGE_INDEXING_DOMAIN

Enddatetime

N/A

Isactive

The possible values are "0" for inactive and "1" for active

Name

N/A

Pageurl

N/A

Proxycountrycode

N/A

Startdatetime

Set Today by default

Trackfiletype

The possible values are Images Only, Videos Only, Track Both respectively: "0", "1", "2", Set Images Only by default

Websitecode

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ADM_IMAGE_INDEXING_ECOMMERCE_SITES

PUT Site2

/sites

Updates an existing site that the user has access to in the system

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

Response Type

N/A
Options (12)

Option Name

Description

Buids

N/A

Domaincode

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ADM_IMAGE_INDEXING_DOMAIN

Enddatetime

N/A

Id

In Update request, this field should have a valid value

Isactive

The possible values are "0" for inactive and "1" for active

Name

N/A

Pageurl

N/A

Proxycountrycode

N/A

Removeenddate

Flag used to remove End Date of the site

Startdatetime

N/A

Trackfiletype

The possible values are: ("0", "1", "2")

Websitecode

The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ADM_IMAGE_INDEXING_ECOMMERCE_SITES

DELETE Site3

/sites

Deletes sites that the user has access to from the system

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Authorization

Authorization

Response Type

N/A