salesforce-marketingcloud / SFDC-MC-REST-Style-Guide

REST style guidelines
31 stars 9 forks source link

We must provide a style for identifying resources with Composite Key (e.g. Data Extensions) #21

Open sprshrp opened 9 years ago

sprshrp commented 9 years ago

We need to agree upon a style for identifying resources with a composite key, e.g. Data Extensions.

As an example, a Data Extension is a schema object, representing the types of data the live within it.

A Data Extension Row is an object that meets a Data Extensions Schema.

In the following example, let's assume we have:

I must be able to :

A few examples

POST /v4/metadata/extensions

{
    name : "westerosi"
}
201 Created
{
    name : "westerosi" 
    id : "abc123"
}

#WORK IN PROGRESS

POST /v4/metadata/extensions/westerosi
OR
POST /v4/metadata/extensions/abc123
{

}
sprshrp commented 9 years ago

Still working on this issue.

aroden-salesforce commented 9 years ago

Seems simple to my mind

To create/update/delete rows in data extension /v4/content/extensionsData/westerosi

To create/update/modify/delete the data extension /v4/content/extensionsMetadata/westerosi

Extending to a "worse case example"

/v4/content/extensionsMetadata/westerosi/action /renameColumn?from=name&to=fullName