API Page Pattern

[waldo1001]

We need a description of the "minimum" and the "best practices" of setting up an API.

Things I'm thinking of:
It should contain at least these fields

• id - SystemId
• lastModifiedDateTime - SystemModifiedAt
• Extensible = false;

Guidelines around the properties:

• APIPublisher
• APIGroup
• APIVersion
• EntityName
• EntitySetName
• ODataKeyFields = systemId

Refer to a snippet?
tpageapiwaldo is a start, but is far from perfect.

Is it

• A Pattern?
• A Guideline

[pibcht]

lastModifiedDateTime - SystemModifiedAt

For this point, I've several thoughts:

• Why lastModifiedDateTime and not modifiedAt as this is a system field?
• Why not createdDateTime (Or better: createdAt) ? I'm not comfortable with "Modified" date for some immutable data

My version of that would rather be:

It should contain at least these fields

• id - SystemId
• modifiedAt - SystemModifiedAt (except for Editable = false)
• createdAt - SystemCreatedAt
• Extensible = false;

And you can object to the idea of ​​having an exception in the "at least" rule 😅

[waldo1001]

@ajkauffmann is going to take the lead on this one...

[waldo1001]

Important: the name "lastModifiedDateTime" for webhook behavior: