Fadelconnector v1.0

/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`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`Object variable`	Object Variable
`Typecode`	TypeCode
`Response Type`	The response format expected from the API (e.g. application/json).

/agreements

Create a new Agreement in the system

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`Response Type`	The response format expected from the API (e.g. application/json).

Options (30)

Option Name	Description
`Agreementnumber`	The unique identifier for the agreement.
`Amendmentnumber`	The amendment number associated with the agreement.
`Assetcount`	The number of assets included in the agreement.
`Currencycode`	The list of possible values can be loaded through [API domain]/[API context]/lookups/CURRENCIES
`Dealid`	The identifier of the deal linked to the agreement.
`Dealtype`	The type of deal, such as new or renewal.
`Dealtypecode`	The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_DEAL_TYPE
`Deletedassetidslst`	A list of asset identifiers to remove from the agreement.
`Description`	A textual description of the agreement.
`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`	An external system's identifier for the agreement.
`Internalcontact`	The name of the internal contact responsible for the agreement.
`Internalcontactid`	The identifier of the internal contact.
`Orgid`	Unique identifier of the Business Unit. The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ORGS
`Orgname`	The name of the organization associated with the agreement.
`Primaryparty`	The primary party or customer for the agreement.
`Primarypartyaddress`	The address of the primary party.
`Primarypartycontact`	The contact person at the primary party.
`Primarypartycontactaddress`	The address of the primary party contact.
`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`	The current status of the agreement, such as draft or active.
`Statuscode`	The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_DEAL_STATUSES
`Termlength`	The length of the agreement term, in months or days.
`Termlengthcode`	The unit code for the term length, for example M for months or D for days.
`Updatedate`	Value returned is an 'MM/DD/YYYY' date format
`Updatedatetime`	Value returned is an epoch timestamp

/agreements/number/{Agreement Number}

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

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Agreement number`	Agreement Number
`Authorization`	Authorization
`Loadattachmentfile`	loadAttachmentFile
`Loadattachments`	loadAttachments
`Loadcounters`	loadCounters
`Response Type`	The response format expected from the API (e.g. application/json).

/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`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`External id`	External ID
`Loadattachmentfile`	loadAttachmentFile
`Loadattachments`	loadAttachments
`Loadcounters`	loadCounters
`Response Type`	The response format expected from the API (e.g. application/json).

/agreements/{Agreement ID}/assets

Gets the list of assets for a given agreement

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Agreement id`	Agreement ID
`Authorization`	Authorization
`Response Type`	The response format expected from the API (e.g. application/json).

Options (21)

Option Name	Description
`Assetid`	Filter assets by their unique identifier.
`Campaignid`	Filter assets associated with a specific campaign.
`Dealid`	Filter assets linked to a particular deal.
`Excludedgroupid`	Exclude assets belonging to a specific group.
`Excludedidslst`	A list of asset identifiers to exclude from the results.
`Externalid`	Filter assets by an external system's identifier.
`Globalsearch`	A free-text search term to match against asset properties.
`Groupid`	Filter assets belonging to a specific group.
`Includedidslst`	A list of asset identifiers to include in the results.
`Istemplate`	Filter assets that are templates (1) or not (0).
`Limit`	The maximum number of assets to return per page.
`Loadthumbnails`	Whether to include thumbnail images in the response (true or false).
`Name`	Filter assets by name.
`Offset`	The number of assets to skip before starting to return results.
`Orgids`	The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ORGS
`Partyid`	Filter assets associated with a specific party.
`Projectid`	Filter assets linked to a specific project.
`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

/agreements/{Agreement ID}

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

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Agreement id`	Agreement ID
`Authorization`	Authorization
`Loadattachmentfile`	loadAttachmentFile
`Loadattachments`	loadAttachments
`Loadcounters`	loadCounters
`Response Type`	The response format expected from the API (e.g. application/json).

/agreements/projects

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

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`Orgids`	orgIds
`Response Type`	The response format expected from the API (e.g. application/json).

/agreements/search

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

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`Response Type`	The response format expected from the API (e.g. application/json).

Options (47)

Option Name	Description
`Agreementnumber`	The unique identifier for the agreement.
`Assetexternalid`	Filter agreements by a single external asset identifier.
`Assetexternalids`	Filter agreements by a list of external asset identifiers.
`Assetid`	Filter assets by their unique identifier.
`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`	Filter assets linked to a particular deal.
`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`	A textual description of the agreement.
`Enddate`	Value provided should be an epoch timestamp
`Enddateisrange`	When true, interpret the end date as a range filter instead of an exact match.
`Excludedids`	A list of agreement IDs to exclude from the results.
`Excludedpartyids`	A list of party IDs whose agreements should be excluded.
`Excludedprojectids`	A list of project IDs whose agreements should be excluded.
`Externalid`	Filter assets by an external system's identifier.
`Globalsearch`	String value representing an Agreement Number, Description or Primary Party
`Includesharedagreements`	When true, include agreements that have been shared with the user.
`Internalcontactid`	Filter agreements by a single internal contact ID.
`Internalcontactidlist`	Filter agreements by a list of internal contact IDs.
`Limit`	The maximum number of assets to return per page.
`Loadattachments`	When true, include attachment data in the agreement results.
`Loadcounters`	When true, include counter data (e.g., version counts) in the results.
`Notes`	Filter agreements whose notes contain the specified text.
`Offset`	The number of assets to skip before starting to return results.
`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`	Filter assets associated with a specific party.
`Partyidlist`	Filter agreements by a list of party IDs.
`Projectid`	Filter assets linked to a specific project.
`Projectnumber`	Filter agreements by an exact project number.
`Rightdesc`	Filter agreements whose rights description contains the specified text.
`Rightsenddate`	Filter agreements by a specific rights end date.
`Rightsenddateisrange`	When true, interpret the rights end date as a range filter.
`Rightsstartdate`	Filter agreements by a specific rights start date.
`Rightsstartdateisrange`	When true, interpret the rights start date as a range filter.
`Showprojects`	When true, include associated project information in the results.
`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`	When true, interpret the start date as a range filter.
`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`	When true, interpret the update date as a range filter.

/agreements/{Agreement ID}/assets

Link assets to an agreement

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Agreement id`	Agreement ID
`Authorization`	Authorization
`Response Type`	The response format expected from the API (e.g. application/json).

/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`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Agreement id`	Agreement ID
`Authorization`	Authorization
`Response Type`	The response format expected from the API (e.g. application/json).

Options (30)

Option Name	Description
`Agreementnumber`	The unique identifier for the agreement.
`Amendmentnumber`	The amendment number associated with the agreement.
`Assetcount`	The number of assets included in the agreement.
`Currencycode`	The list of possible values can be loaded through [API domain]/[API context]/lookups/CURRENCIES
`Dealid`	Filter assets linked to a particular deal.
`Dealtype`	The type of deal, such as new or renewal.
`Dealtypecode`	The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_DEAL_TYPE
`Deletedassetidslst`	A list of asset identifiers to remove from the agreement.
`Description`	A textual description of the agreement.
`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`	Filter assets by an external system's identifier.
`Internalcontact`	The name of the internal contact responsible for the agreement.
`Internalcontactid`	The identifier of the internal contact.
`Orgid`	Unique identifier of the Business Unit. The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ORGS
`Orgname`	The name of the organization associated with the agreement.
`Primaryparty`	The primary party or customer for the agreement.
`Primarypartyaddress`	The address of the primary party.
`Primarypartycontact`	The contact person at the primary party.
`Primarypartycontactaddress`	The address of the primary party contact.
`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`	The current status of the agreement, such as draft or active.
`Statuscode`	The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_DEAL_STATUSES
`Termlength`	The length of the agreement term, in months or days.
`Termlengthcode`	The unit code for the term length, for example M for months or D for days.
`Updatedate`	Value returned is an 'MM/DD/YYYY' date format
`Updatedatetime`	Value returned is an epoch timestamp

/assets/copy

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

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`Response Type`	The response format expected from the API (e.g. application/json).

Options (8)

Option Name	Description
`Assetid`	Filter assets by their unique identifier.
`Copygroup`	When true, copy the asset's group membership to the new copy.
`Copyprojectagreement`	When true, copy the asset's project agreement to the new copy.
`Externalid`	Filter assets by an external system's identifier.
`Externalrefid`	An external reference identifier to assign to the copied asset.
`Externalurl`	An external URL to assign to the copied asset.
`Name`	Filter assets by name.
`Statuscode`	The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ARC_STATUS

/assets

Creates a new asset in the system

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`Response Type`	The response format expected from the API (e.g. application/json).

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`	Provide a unique external identifier for the new asset.
`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`	Set to true if the asset is a composite of multiple components.
`Compositeorcomponentassetextids`	Specify external identifiers of composite or component assets to associate.
`Compositeorcomponentassetids`	Specify internal IDs of composite or component assets to associate.
`Description`	A textual description of the agreement.
`Externalurl`	An external URL to assign to the copied asset.
`Feeamount`	Set the fee amount associated with the asset.
`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`	Filter assets by name.
`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`	Provide the name of the thumbnail image for the asset.
`Typecode`	The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ARC_ASSET_TYPE
`Websearch`	Specify the web search keyword or query for the asset.

/assets/bulk/rights

Creates or updates bulk assets with same right(s)

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`Response Type`	The response format expected from the API (e.g. application/json).

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`	Provide a list of organization IDs to which the rights apply.

/assets/video

Creates a new video asset in the system

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Assetjson`	assetJson
`File`	file

/assets

Deletes assets that the user has access to from the system

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`Response Type`	The response format expected from the API (e.g. application/json).

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

/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`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`External id`	External ID
`Response Type`	The response format expected from the API (e.g. application/json).

/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`	Additional HTTP header name/value pairs to include in the request.
`Asset id`	Asset ID
`Authorization`	Authorization
`Response Type`	The response format expected from the API (e.g. application/json).

/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`	Additional HTTP header name/value pairs to include in the request.
`Asset id`	Asset ID
`Authorization`	Authorization
`Response Type`	The response format expected from the API (e.g. application/json).

/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`	Additional HTTP header name/value pairs to include in the request.
`Asset id`	Asset ID
`Authorization`	Authorization
`Response Type`	The response format expected from the API (e.g. application/json).

/assets/search

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

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`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`	The response format expected from the API (e.g. application/json).

Options (30)

Option Name	Description
`Assetidlst`	Provide a list of asset IDs to filter the search.
`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`	Set to true to enable date range filtering for in and out dates.
`Description`	A textual description of the agreement.
`Externalidentifier`	Specify a single external identifier to search for.
`Externalidentifierlst`	Provide a list of external identifiers to search for.
`Identifier`	Specify the asset identifier (internal or external) to search.
`Indatefrom`	Set the start date for the "in" date range filter.
`Indateto`	Set the end date for the "in" date range filter.
`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`	Filter assets by name.
`Orgids`	The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ORGS
`Outdatefrom`	Set the start date for the "out" date range filter.
`Outdateto`	Set the end date for the "out" date range filter.
`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`	Provide a list of project IDs to filter assets by project.
`Projectnumberlst`	Provide a list of project numbers to filter assets by project.
`Ruletype`	The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ARC_RULE_TYPE
`Showagreements`	Set to true to include agreement details in the search results.
`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

/assets

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

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`Response Type`	The response format expected from the API (e.g. application/json).

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`	Set to true if the asset should be marked as composite.
`Compositeorcomponentassetextids`	Provide external identifiers of composite or component assets to add.
`Compositeorcomponentassetids`	Provide internal IDs of composite or component assets to add.
`Deletecompositeorcomponentassetextids`	Provide external identifiers of composite or component assets to remove.
`Deletecompositeorcomponentassetids`	Provide internal IDs of composite or component assets to remove.
`Description`	A textual description of the agreement.
`Externalurl`	An external URL to assign to the copied asset.
`Feeamount`	Update the fee amount associated with the asset.
`Feecurrencycode`	The list of possible values can be loaded through [API domain]/[API context]/lookups/CURRENCIES
`Name`	Filter assets by name.
`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`	Set to true to remove the existing thumbnail.
`Removevideo`	Set to true to remove the existing video.
`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`	Set the length (duration) of the thumbnail in seconds.
`Thumbnailname`	Provide a new name for the thumbnail image.
`Typecode`	The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ARC_ASSET_TYPE
`Websearch`	Update the web search keyword or query for the asset.

/assets/video

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

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Assetjson`	assetJson
`File`	file

/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`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (8)

Option Name	Description
`Apikey`	Provide an API key for authentication.
`Authrequesttoken`	It should hold a base64 encoded value of the username:password
`Googleaccesstoken`	Provide a Google access token for authentication.
`Microsoftaccesstoken`	Provide a Microsoft access token for authentication.
`Samlloginusername`	Provide the username for SAML login authentication.
`Samltoken`	Provide the SAML token for authentication.
`Twofactorcode`	Provide a two-factor authentication code.
`Username`	Provide the username for authentication.

/authenticate/renew

This API is responsible for renewing the access token.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`Content-type`	Specify the content type for the request (e.g., application/json).
`Response Type`	The response format expected from the API (e.g. application/json).

/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`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Answer type`	Answer Type
`Asset id`	Asset ID
`Authorization`	Authorization
`Limit`	limit
`Offset`	offset
`Response Type`	The response format expected from the API (e.g. application/json).

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

/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`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`Response Type`	The response format expected from the API (e.g. application/json).

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`	Provide a list of recipient identifiers for the rights request.

/clearance/clearancesummary

Returns the clearance summary of the selected assets

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`Limit`	limit
`Offset`	offset
`Response Type`	The response format expected from the API (e.g. application/json).

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

/clearance/clearancewarnings

Returns the clearance warning of the selected assets

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`Limit`	limit
`Offset`	offset
`Response Type`	The response format expected from the API (e.g. application/json).

Options (8)

Option Name	Description
`Draftagreementfilter`	Specifies a filter string to narrow down the draft agreements considered for clearance warnings.
`Draftagreementlimit`	Limits the number of draft agreements processed for clearance warning evaluation.
`Draftagreementoffset`	Sets the offset for paginating through draft agreements when generating clearance warnings.
`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

/clearance/assetclearance

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

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`Limit`	limit
`Offset`	offset
`Response Type`	The response format expected from the API (e.g. application/json).

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

/globalrules

Creates a new global rule in the system

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`Response Type`	The response format expected from the API (e.g. application/json).

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`	A textual description of the agreement.
`Enddate`	Value provided should be an epoch timestamp
`Externalid`	Filter assets by an external system's identifier.
`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

/globalrules

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

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`Response Type`	The response format expected from the API (e.g. application/json).

/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`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`Global rule id`	Global Rule ID
`Response Type`	The response format expected from the API (e.g. application/json).

/globalrules/search

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

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`Response Type`	The response format expected from the API (e.g. application/json).

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`	Set to true to enable date range filtering for in and out dates.
`Description`	A textual description of the agreement.
`Externalid`	Filter assets by an external system's identifier.
`Id`	Filters the list of global rules to return only the rule with the specified identifier.
`Indatefrom`	Value provided should be an epoch timestamp
`Indateto`	Value provided should be an epoch timestamp
`Limit`	The maximum number of assets to return per page.
`Offset`	The number of assets to skip before starting to return results.
`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

/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`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`External id`	External ID
`Response Type`	The response format expected from the API (e.g. application/json).

/globalrules

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

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`Response Type`	The response format expected from the API (e.g. application/json).

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`	A textual description of the agreement.
`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

/groups

Creates a new group in the system

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`Response Type`	The response format expected from the API (e.g. application/json).

Options (8)

Option Name	Description
`Description`	A textual description of the agreement.
`Externalid`	Filter assets by an external system's identifier.
`Groupsubtypecode`	The subtype code that further categorizes the new group within its group type.
`Grouptypecode`	The type code that defines the primary classification of the new group.
`Id`	The id value should always be zero
`Name`	Filter assets by name.
`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

/groups/search

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

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`Response Type`	The response format expected from the API (e.g. application/json).

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`	A textual description of the agreement.
`Externalid`	Filter assets by an external system's identifier.
`Id`	Filters the search results to return only the group with the specified numeric identifier.
`Limit`	The maximum number of assets to return per page.
`Name`	Filter assets by name.
`Offset`	The number of assets to skip before starting to return results.
`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

/groups

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

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`Response Type`	The response format expected from the API (e.g. application/json).

Options (8)

Option Name	Description
`Description`	A textual description of the agreement.
`Externalid`	Either of the following fields should have a valid value: "id" and "externalId"
`Groupsubtypecode`	The new subtype code to assign to the group being updated.
`Grouptypecode`	The new type code to assign to the group being updated.
`Id`	Either of the following fields should have a valid value: "id" and "externalId"
`Name`	Filter assets by name.
`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

/groups

Deletes groups that the user has access to from the system

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`Response Type`	The response format expected from the API (e.g. application/json).

/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`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`Group id`	Group ID
`Response Type`	The response format expected from the API (e.g. application/json).

/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`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`External id`	External ID
`Response Type`	The response format expected from the API (e.g. application/json).

/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`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`Lookup type`	Lookup Type
`Languagecode`	languageCode
`Loadtranslation`	loadTranslation
`Response Type`	The response format expected from the API (e.g. application/json).

/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`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`Lookup type`	Lookup Type
`Object role`	Object Role
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Orgids`	The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ORGS

/parties

Create a new Party in the system

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`Response Type`	The response format expected from the API (e.g. application/json).

Options (15)

Option Name	Description
`Agreementcount`	The number of agreements associated with the new party.
`Alias`	An alternative name or alias for the party.
`Assetcount`	The number of assets included in the agreement.
`Campaignscount`	The number of campaigns the new party is involved in.
`Enabledflag`	Determines if party is active
`Externalid`	Filter assets by an external system's identifier.
`Firstname`	The first name of the party.
`Id`	A unique identifier for the party being created.
`Iscompany`	Determines if party is company
`Lastname`	The last name of the party.
`Selectedcontributorrole`	This property should be sent when removing or replacing roles already associated with assets
`Thumbnail`	Value provided should be in Base64 encoding
`Thumbnailname`	Provide a new name for the thumbnail image.
`Typecode`	The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_PARTY_TYPES
`Typename`	The type or category name that describes the party.

/parties/externalparties/{External ID}

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

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`External id`	External ID
`Loadattachmentfile`	loadAttachmentFile
`Loadattachments`	loadAttachments
`Loadcounters`	loadCounters
`Response Type`	The response format expected from the API (e.g. application/json).

/parties/{Party ID}

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

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`Party id`	Party ID
`Loadattachmentfile`	loadAttachmentFile
`Loadattachments`	loadAttachments
`Loadcounters`	loadCounters
`Response Type`	The response format expected from the API (e.g. application/json).

/parties/{Party ID}/agreements

Gets the list of agreements for a given party

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`Party id`	Party ID
`Response Type`	The response format expected from the API (e.g. application/json).

Options (47)

Option Name	Description
`Agreementnumber`	The unique identifier for the agreement.
`Assetexternalid`	Filter agreements by a single external asset identifier.
`Assetexternalids`	Filter agreements by a list of external asset identifiers.
`Assetid`	Filter assets by their unique identifier.
`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`	Filter assets linked to a particular deal.
`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`	A textual description of the agreement.
`Enddate`	Value provided should be an epoch timestamp
`Enddateisrange`	When true, interpret the end date as a range filter instead of an exact match.
`Excludedids`	A list of agreement IDs to exclude from the results.
`Excludedpartyids`	A list of party IDs whose agreements should be excluded.
`Excludedprojectids`	A list of project IDs whose agreements should be excluded.
`Externalid`	Filter assets by an external system's identifier.
`Globalsearch`	String value representing an Agreement Number, Description or Primary Party
`Includesharedagreements`	When true, include agreements that have been shared with the user.
`Internalcontactid`	Filter agreements by a single internal contact ID.
`Internalcontactidlist`	Filter agreements by a list of internal contact IDs.
`Limit`	The maximum number of assets to return per page.
`Loadattachments`	When true, include attachment data in the agreement results.
`Loadcounters`	When true, include counter data (e.g., version counts) in the results.
`Notes`	Filter agreements whose notes contain the specified text.
`Offset`	The number of assets to skip before starting to return results.
`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`	Filter assets associated with a specific party.
`Partyidlist`	Filter agreements by a list of party IDs.
`Projectid`	Filter assets linked to a specific project.
`Projectnumber`	Filter agreements by an exact project number.
`Rightdesc`	Filter agreements whose rights description contains the specified text.
`Rightsenddate`	Filter agreements by a specific rights end date.
`Rightsenddateisrange`	When true, interpret the rights end date as a range filter.
`Rightsstartdate`	Filter agreements by a specific rights start date.
`Rightsstartdateisrange`	When true, interpret the rights start date as a range filter.
`Showprojects`	When true, include associated project information in the results.
`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`	When true, interpret the start date as a range filter.
`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`	When true, interpret the update date as a range filter.

/parties/{Party ID}/assets

Gets the list of assets for a given party

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`Party id`	Party ID
`Response Type`	The response format expected from the API (e.g. application/json).

Options (21)

Option Name	Description
`Assetid`	Filter assets by their unique identifier.
`Campaignid`	Filter assets associated with a specific campaign.
`Dealid`	Filter assets linked to a particular deal.
`Excludedgroupid`	Exclude assets belonging to a specific group.
`Excludedidslst`	A list of asset identifiers to exclude from the results.
`Externalid`	Filter assets by an external system's identifier.
`Globalsearch`	A free-text search term to match against asset properties.
`Groupid`	Filter assets belonging to a specific group.
`Includedidslst`	A list of asset identifiers to include in the results.
`Istemplate`	Filter assets that are templates (1) or not (0).
`Limit`	The maximum number of assets to return per page.
`Loadthumbnails`	Whether to include thumbnail images in the response (true or false).
`Name`	Filter assets by name.
`Offset`	The number of assets to skip before starting to return results.
`Orgids`	The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ORGS
`Partyid`	Filter assets associated with a specific party.
`Projectid`	Filter assets linked to a specific project.
`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

/parties/search

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

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`Response Type`	The response format expected from the API (e.g. application/json).

Options (33)

Option Name	Description
`Active`	Filter by whether the party is active; provide a Boolean value.
`Advancesearch`	Enable advanced search options; provide a Boolean value.
`Agreementid`	Filter by the agreement ID associated with the party; provide an integer.
`Alias`	An alternative name or alias for the party.
`Applydefaultmacro`	Apply the default macro to the search; provide a Boolean value.
`Applymacroid`	Apply a specific macro by its ID; provide an integer.
`Assetid`	Filter assets by their unique identifier.
`Assets`	Filter by assets associated with the party; provide a string.
`Contactid`	Filter by the contact ID associated with the party; provide an integer.
`Enddate`	Set the end date for the search range; provide a string date.
`Enddateisrange`	When true, interpret the end date as a range filter instead of an exact match.
`Excludedids`	A list of agreement IDs to exclude from the results.
`Externalid`	Filter assets by an external system's identifier.
`Globalsearch`	String value representing a Party ID (1,2,3) or range of IDs (5-12), or a Party Name, Role or Alias
`Includesharedparties`	Include parties that are shared with other entities; provide a Boolean value.
`Limit`	The maximum number of assets to return per page.
`Loadthumbnails`	Whether to include thumbnail images in the response (true or false).
`Name`	Filter assets by name.
`Offset`	The number of assets to skip before starting to return results.
`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`	Specify the page number for paginated results; provide an integer.
`Partycategory`	This field is used to search for Individuals and/or Companies parties. "0" : All,"1" : Individual, "2" : Company
`Partyid`	Filter assets associated with a specific party.
`Partyname`	Filter by the party name; provide a string.
`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`	Set the start date for the search range; provide a string date.
`Startdateisrange`	When true, interpret the start date as a range filter.
`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

/parties/{Party ID}

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

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`Party id`	Party ID
`Response Type`	The response format expected from the API (e.g. application/json).

Options (15)

Option Name	Description
`Agreementcount`	The number of agreements associated with the new party.
`Alias`	An alternative name or alias for the party.
`Assetcount`	The number of assets included in the agreement.
`Campaignscount`	The number of campaigns the new party is involved in.
`Enabledflag`	Determines if party is active
`Externalid`	Filter assets by an external system's identifier.
`Firstname`	The first name of the party.
`Id`	A unique identifier for the party being created.
`Iscompany`	Determines if party is company
`Lastname`	The last name of the party.
`Selectedcontributorrole`	This property should be sent when removing or replacing roles already associated with assets
`Thumbnail`	Value provided should be in Base64 encoding
`Thumbnailname`	Provide a new name for the thumbnail image.
`Typecode`	The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_PARTY_TYPES
`Typename`	The type or category name that describes the party.

/projects

This API is responsible for creating new projects in the system

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`Response Type`	The response format expected from the API (e.g. application/json).

Options (11)

Option Name	Description
`Agreementcount`	The number of agreements associated with the new party.
`Assetcount`	The number of assets included in the agreement.
`Comment`	Add a comment to the new project; provide a string.
`Deletedassetidslst`	A list of asset identifiers to remove from the agreement.
`Description`	A textual description of the agreement.
`Id`	A unique identifier for the party being created.
`Name`	Filter assets by name.
`Partycount`	Specify the number of parties involved in the project; provide an integer.
`Projectnumber`	Filter agreements by an exact project number.
`Typecode`	The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ADM_PROJECT_TYPES
`Typename`	The type or category name that describes the party.

/projects/search

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

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`Response Type`	The response format expected from the API (e.g. application/json).

Options (17)

Option Name	Description
`Agreementid`	Filter by the agreement ID associated with the project; provide a number.
`Assetid`	Filter by the asset ID associated with the project; provide a number.
`Assets`	Filter by assets associated with the project; provide a string.
`Date`	Value provided should be in 'MM/DD/YYYY' date format or in 'MM-DD-YYYY' date format
`Dateisrange`	Indicate whether the date filter is a range; provide a Boolean value.
`Description`	A textual description of the agreement.
`Globalsearch`	String value representing a Project Number, Name or Description
`Includesharedprojects`	Include projects that are shared with other entities; provide a Boolean value.
`Limit`	Limit the number of results returned; provide a number.
`Offset`	Set the offset for paginated results; provide a number.
`Orgids`	The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ORGS
`Projectname`	Filter by the project name; provide a string.
`Projectnumber`	Filter agreements by an exact project number.
`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

/projects/{Project ID}

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

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`Project id`	Project ID
`Loadcounters`	loadCounters
`Response Type`	The response format expected from the API (e.g. application/json).

/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`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`Project number`	Project Number
`Loadcounters`	loadCounters
`Response Type`	The response format expected from the API (e.g. application/json).

/projects/{Project ID}/agreements

Gets the list of agreements for a given project

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`Project id`	Project ID
`Response Type`	The response format expected from the API (e.g. application/json).

Options (47)

Option Name	Description
`Agreementnumber`	The unique identifier for the agreement.
`Assetexternalid`	Filter agreements by a single external asset identifier.
`Assetexternalids`	Filter agreements by a list of external asset identifiers.
`Assetid`	Filter assets by their unique identifier.
`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`	Filter assets linked to a particular deal.
`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`	A textual description of the agreement.
`Enddate`	Value provided should be an epoch timestamp
`Enddateisrange`	When true, interpret the end date as a range filter instead of an exact match.
`Excludedids`	A list of agreement IDs to exclude from the results.
`Excludedpartyids`	A list of party IDs whose agreements should be excluded.
`Excludedprojectids`	A list of project IDs whose agreements should be excluded.
`Externalid`	Filter assets by an external system's identifier.
`Globalsearch`	String value representing an Agreement Number, Description or Primary Party
`Includesharedagreements`	When true, include agreements that have been shared with the user.
`Internalcontactid`	Filter agreements by a single internal contact ID.
`Internalcontactidlist`	Filter agreements by a list of internal contact IDs.
`Limit`	The maximum number of assets to return per page.
`Loadattachments`	When true, include attachment data in the agreement results.
`Loadcounters`	When true, include counter data (e.g., version counts) in the results.
`Notes`	Filter agreements whose notes contain the specified text.
`Offset`	The number of assets to skip before starting to return results.
`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`	Filter assets associated with a specific party.
`Partyidlist`	Filter agreements by a list of party IDs.
`Projectid`	Filter assets linked to a specific project.
`Projectnumber`	Filter agreements by an exact project number.
`Rightdesc`	Filter agreements whose rights description contains the specified text.
`Rightsenddate`	Filter agreements by a specific rights end date.
`Rightsenddateisrange`	When true, interpret the rights end date as a range filter.
`Rightsstartdate`	Filter agreements by a specific rights start date.
`Rightsstartdateisrange`	When true, interpret the rights start date as a range filter.
`Showprojects`	When true, include associated project information in the results.
`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`	When true, interpret the start date as a range filter.
`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`	When true, interpret the update date as a range filter.

/projects/{Project ID}/assets

Get project related assets

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`Project id`	Project ID
`Response Type`	The response format expected from the API (e.g. application/json).

Options (21)

Option Name	Description
`Assetid`	Filter assets by their unique identifier.
`Campaignid`	Filter assets associated with a specific campaign.
`Dealid`	Filter assets linked to a particular deal.
`Excludedgroupid`	Exclude assets belonging to a specific group.
`Excludedidslst`	A list of asset identifiers to exclude from the results.
`Externalid`	Filter assets by an external system's identifier.
`Globalsearch`	A free-text search term to match against asset properties.
`Groupid`	Filter assets belonging to a specific group.
`Includedidslst`	A list of asset identifiers to include in the results.
`Istemplate`	Filter assets that are templates (1) or not (0).
`Limit`	The maximum number of assets to return per page.
`Loadthumbnails`	Whether to include thumbnail images in the response (true or false).
`Name`	Filter assets by name.
`Offset`	The number of assets to skip before starting to return results.
`Orgids`	The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ORGS
`Partyid`	Filter assets associated with a specific party.
`Projectid`	Filter assets linked to a specific project.
`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

/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`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`Project id`	Project ID
`Response Type`	The response format expected from the API (e.g. application/json).

Options (11)

Option Name	Description
`Agreementcount`	The number of agreements associated with the new party.
`Assetcount`	The number of assets included in the agreement.
`Comment`	Add a comment to the new project; provide a string.
`Deletedassetidslst`	A list of asset identifiers to remove from the agreement.
`Description`	A textual description of the agreement.
`Id`	A unique identifier for the party being created.
`Name`	Filter assets by name.
`Partycount`	Specify the number of parties involved in the project; provide an integer.
`Projectnumber`	Filter agreements by an exact project number.
`Typecode`	The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ADM_PROJECT_TYPES
`Typename`	The type or category name that describes the party.

/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`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`Right type code`	Right Type Code
`Response Type`	The response format expected from the API (e.g. application/json).

Options (7)

Option Name	Description
`Description`	A textual description of the agreement.
`Externalid`	Filter assets by an external system's identifier.
`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

/rights

Creates new rights attributes in the system

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`Response Type`	The response format expected from the API (e.g. application/json).

/rights

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

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`Response Type`	The response format expected from the API (e.g. application/json).

Options (11)

Option Name	Description
`Code`	The code value to assign to the right, used for identification.
`Description`	A textual description of the agreement.
`Enddate`	Value Provided should be in 'YYYY-MM-DD' date format; Value returned is timestamp
`Parentrightsattributeexternalid`	The external identifier of the parent rights attribute to associate with this right.
`Rightexternalid`	An external identifier for the right, used for cross-system reference.
`Rightid`	The internal identifier of the right to update.
`Rightorder`	The ordering index for the right within its group or hierarchy.
`Rightsattributeexternalid`	The external identifier of the rights attribute to associate with this right.
`Rightsattributeid`	The internal identifier of the rights attribute to associate with this right.
`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

/rights

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

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`Response Type`	The response format expected from the API (e.g. application/json).

/sites

Creates a new site in the system

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`Response Type`	The response format expected from the API (e.g. application/json).

Options (10)

Option Name	Description
`Buids`	An array of business unit identifiers to associate with the new site.
`Domaincode`	The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ADM_IMAGE_INDEXING_DOMAIN
`Enddatetime`	The end date and time for the site's active period, specified as a Unix timestamp.
`Isactive`	The possible values are "0" for inactive and "1" for active
`Name`	Filter assets by name.
`Pageurl`	The URL of the site's landing page or entry point.
`Proxycountrycode`	The country code to use for proxy configuration when accessing the site.
`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

/sites

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

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`Response Type`	The response format expected from the API (e.g. application/json).

Options (12)

Option Name	Description
`Buids`	An array of business unit identifiers to associate with the site, replacing any existing associations.
`Domaincode`	The list of possible values can be loaded through [API domain]/[API context]/lookups/FPI_ADM_IMAGE_INDEXING_DOMAIN
`Enddatetime`	The updated end date and time for the site's active period, as a Unix timestamp.
`Id`	In Update request, this field should have a valid value
`Isactive`	The possible values are "0" for inactive and "1" for active
`Name`	Filter assets by name.
`Pageurl`	The updated URL of the site's landing page.
`Proxycountrycode`	The updated country code for proxy configuration.
`Removeenddate`	Flag used to remove End Date of the site
`Startdatetime`	The updated start date and time for the site's active period, as a Unix timestamp.
`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

/sites

Deletes sites that the user has access to from the system

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Authorization`	Authorization
`Response Type`	The response format expected from the API (e.g. application/json).

Additional Info

Agreement (9)

Asset (12)

Authenticate (2)

Clearance (5)

Global Rule (6)

Group (6)

Lookup (2)

Party (7)

Project (7)

Right (4)

Site (3)