You can create a document in one operation using the following example POST:
<ACCESS_URL>/api/v2/SDXDEV/Objects
The following headers can be used to create a document:
Accept: application/json,application/vnd.intergraph.data+json
Content-Type: application/json
The following is an example request payload used in the POST to create a single document:
{"Class":"DocumentMaster",
"SPFDocState":"e1DocStateRESERVED",
"Name":"TEST-DOC-1",
"Description":"",
"Interfaces":{"ISDocumentMaster":true},
"SDAItemSecurityCode_12@odata.bind":["<ACCESS_URL>/api/v2/SDA/Objects('001SEZA')"],
"SDADocOriginatingOrg_12@odata.bind":["<ACCESS_URL>/api/v2/SDA/Objects('001TF9A')"],
"SPFDocumentRevisions_12@odata.bind":[
{"Class":"DocumentRevision","MajorRevision":"01",
"SPFMinorRevision":"A",
"SPFRevState":"e1WORKING",
"SDAContractorIssueDate":"",
"SDAOriginatorsDocName":"",
"SDAOriginatorsDocRev":"",
"SDAOriginatorsDocDesc":"",
"SDAOriginatorsFileName":"",
"SDADocRevAuthor":"",
"SDADocRevAuthorOrganization":"",
"SDADocRevResponsibleEngineer":"",
"SDADocCreatingSystem":"",
"SDADocComments":"",
"SDARecipient":"",
"SDAValidFrom":"",
"SDAValidUntil":"",
"SDAPhysicalStorageLocation":"",
"SDAReviewedByUser":"",
"SDAReviewedDate":"",
"SDAReturnCode":"",
"SDAActualReceivedDate":"",
"SDAPlannedReturnDate":"",
"SDAActualReturnedDate":"",
"Name":"TEST-DOC-1",
"Description":"",
"Interfaces":{"ISDADocRevItems":true,"IFDWDocRevItems":true},
"SPFDocRevisionRevisionScheme_12@odata.bind":["<ACCESS_URL>/api/v2/SDXDEV/Objects('000FNZA')"],
"SDADocRevArea_12@odata.bind":["<ACCESS_URL>/api/v2/SDXDEV/Objects('002124A')"],
"SPFRevisionVersions_12@odata.bind":
{
"Class":"FDWDocumentVersion",
"Name":"TEST-DOC-1","Description":"",
"SPFItemOwningGroup_12@odata.bind":["<ACCESS_URL>/api/v2/SDXDEV/Objects('000GN0A')"]
}
}],
"SPFPrimaryClassification_21@odata.bind":["<ACCESS_URL>/api/v2/SDXDEV/Objects('002I7YA')"]
}
The request body section contains OData bind variables. These variables refer to
the following class definition types:
|
Odata Bind Variable |
Class Definition Type |
|---|---|
|
SDAItemSecurityCode_12@odata.bind |
SDASecurityCode |
|
SDADocOriginatingOrg_12@odata.bind |
SDAOrganization |
|
SPFDocRevisionRevisionScheme_12@odata.bind |
SPFRevisionScheme |
|
SDADocRevArea_12@odata.bind |
SDAArea |
|
SPFItemOwningGroup_12@odata.bind |
SPFDataAccessGroup |
|
SPFPrimaryClassification_21@odata.bind |
SDADocumentClassification |
|
SDADocRevUnit_12@odata.bind |
SDAUnit |
|
SDADocMasterDiscipline_12@odata.bind |
SDADiscipline |
|
SDADocMasterSecondaryDisciplines_12@odata.bind |
SDADiscipline |
|
SDADocRevIssuePurposes_12@odata.bind |
SDAPrgIssuePurpose |
The following example shows the response for the created document, TEST-DOC_1:
"@odata.context": "<ACCESS_URL>/api/v2/SDXDEV/$metadata#Objects/$entity",
"UID": "FDWM_PlantA_TEST-DOC-1",
"Class": "FDWDocumentMaster",
"Name": "TEST-DOC-1",
"OBID": "6FL1000A",
"TerminationUser": null,
"UniqueKey": "FDWM_PlantA_TEST-DOC-1",
"LastUpdatedDate": "2020-06-04T10:10:52.065Z",
"DomainUID": "FDWDocuments",
"ClaimedToConfigs": null,
"CreationUser": "HSV_DC",
"Config": "PL_PlantA",
"CreationDate": "2020-06-04T10:10:52.065Z",
"ContainerID": null,
"OriginatingOrgName": "INGR.HSV",
"TerminationDate": "9999-12-31T23:59:59.999Z",
"Description": null,
"SDADocSheetNumber": null,
"SDAReviewHoldStatus": null,
"SDADocCategory": null,
"SDADocType": null,
"SDADocSubType": null,
"SPFDocReasonForCancel": null,
"SPFDocCancelledDate": null,
"SPFDocCancelledBy": null,
"SecurityCodeName": "Unclassified",
"SPFDocCategory": null,
"SPFDocSubtype": null,
"SPFTitle": null,
"SPFDocState": "RESERVED",
"SPFDocType": null
}