API Documentation
Kuali Research REST APIs - Export Control
Research Export Control ¶
Excon Intl Shipment Documents ¶
Get Excon Intl Shipment Documents by KeyGET/excon/api/v1/excon-intl-shipment-documents(key)
Example URI
GET /excon/api/v1/excon-intl-shipment-documents(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"documentNumber": "(val)",
"_primaryKey": "(val)"
}Get All Excon Intl Shipment DocumentsGET/excon/api/v1/excon-intl-shipment-documents
Example URI
GET /excon/api/v1/excon-intl-shipment-documents
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"documentNumber": "(val)",
"_primaryKey": "(val)"
},
{
"documentNumber": "(val)",
"_primaryKey": "(val)"
}
]Get All Excon Intl Shipment Documents with FilteringGET/excon/api/v1/excon-intl-shipment-documents
Example URI
GET /excon/api/v1/excon-intl-shipment-documents
URI Parameters
- documentNumber
string(optional)The document id is generated by the workflow environment and is unique to each installation of Kuali… Maximum length is 14.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"documentNumber": "(val)",
"_primaryKey": "(val)"
},
{
"documentNumber": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Excon Intl Shipment DocumentsGET/excon/api/v1/excon-intl-shipment-documents
Example URI
GET /excon/api/v1/excon-intl-shipment-documents
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"documentNumber"
],
"primaryKey": "documentNumber"
}Get Blueprint API specification for Excon Intl Shipment DocumentsGET/excon/api/v1/excon-intl-shipment-documents
Example URI
GET /excon/api/v1/excon-intl-shipment-documents
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Excon Intl Shipment Documents.md"
transfer-encoding: chunkedUpdate Excon Intl Shipment DocumentsPUT/excon/api/v1/excon-intl-shipment-documents(key)
Example URI
PUT /excon/api/v1/excon-intl-shipment-documents(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"documentNumber": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Excon Intl Shipment DocumentsPUT/excon/api/v1/excon-intl-shipment-documents
Example URI
PUT /excon/api/v1/excon-intl-shipment-documents
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"documentNumber": "(val)",
"_primaryKey": "(val)"
},
{
"documentNumber": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Excon Intl Shipment DocumentsPATCH/excon/api/v1/excon-intl-shipment-documents(key)
Example URI
PATCH /excon/api/v1/excon-intl-shipment-documents(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"documentNumber": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"documentNumber": "(val)",
"_primaryKey": "(val)"
}Insert Excon Intl Shipment DocumentsPOST/excon/api/v1/excon-intl-shipment-documents
Example URI
POST /excon/api/v1/excon-intl-shipment-documents
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"documentNumber": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"documentNumber": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Excon Intl Shipment DocumentsPOST/excon/api/v1/excon-intl-shipment-documents
Example URI
POST /excon/api/v1/excon-intl-shipment-documents
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"documentNumber": "(val)",
"_primaryKey": "(val)"
},
{
"documentNumber": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"documentNumber": "(val)",
"_primaryKey": "(val)"
},
{
"documentNumber": "(val)",
"_primaryKey": "(val)"
}
]Delete Excon Intl Shipment Documents by KeyDELETE/excon/api/v1/excon-intl-shipment-documents(key)
Example URI
DELETE /excon/api/v1/excon-intl-shipment-documents(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Intl Shipment DocumentsDELETE/excon/api/v1/excon-intl-shipment-documents
Example URI
DELETE /excon/api/v1/excon-intl-shipment-documents
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Intl Shipment Documents with MatchingDELETE/excon/api/v1/excon-intl-shipment-documents
Example URI
DELETE /excon/api/v1/excon-intl-shipment-documents
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- documentNumber
string(optional)The document id is generated by the workflow environment and is unique to each installation of Kuali… Maximum length is 14.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Excon Intl Shipments ¶
Get Excon Intl Shipments by KeyGET/excon/api/v1/excon-intl-shipments(key)
Example URI
GET /excon/api/v1/excon-intl-shipments(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"shipmentId": "(val)",
"restrictedExport": "(val)",
"shipmentDescription": "(val)",
"restrictedCountry": "(val)",
"countryCode": "(val)",
"sanctionListCode": "(val)",
"restrictedParty": "(val)",
"receivingParty": "(val)",
"rpsResultContent": "(val)",
"certificationInd": "(val)",
"applicantId": "(val)",
"applicantName": "(val)",
"supervisorId": "(val)",
"supervisorName": "(val)",
"unitNumber": "(val)",
"unitName": "(val)",
"exconIntlShipmentDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
}Get All Excon Intl ShipmentsGET/excon/api/v1/excon-intl-shipments
Example URI
GET /excon/api/v1/excon-intl-shipments
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"shipmentId": "(val)",
"restrictedExport": "(val)",
"shipmentDescription": "(val)",
"restrictedCountry": "(val)",
"countryCode": "(val)",
"sanctionListCode": "(val)",
"restrictedParty": "(val)",
"receivingParty": "(val)",
"rpsResultContent": "(val)",
"certificationInd": "(val)",
"applicantId": "(val)",
"applicantName": "(val)",
"supervisorId": "(val)",
"supervisorName": "(val)",
"unitNumber": "(val)",
"unitName": "(val)",
"exconIntlShipmentDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
},
{
"shipmentId": "(val)",
"restrictedExport": "(val)",
"shipmentDescription": "(val)",
"restrictedCountry": "(val)",
"countryCode": "(val)",
"sanctionListCode": "(val)",
"restrictedParty": "(val)",
"receivingParty": "(val)",
"rpsResultContent": "(val)",
"certificationInd": "(val)",
"applicantId": "(val)",
"applicantName": "(val)",
"supervisorId": "(val)",
"supervisorName": "(val)",
"unitNumber": "(val)",
"unitName": "(val)",
"exconIntlShipmentDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
}
]Get All Excon Intl Shipments with FilteringGET/excon/api/v1/excon-intl-shipments
Example URI
GET /excon/api/v1/excon-intl-shipments
URI Parameters
- shipmentId
string(optional)Shipment ID. Maximum length is 22.
- restrictedExport
string(optional)Restricted Export. Maximum length is 1.
- shipmentDescription
string(optional)Shipment Description. Maximum length is 200.
- restrictedCountry
string(optional)Restricted Country. Maximum length is 1.
- countryCode
string(optional)Country Code. Maximum length is 3.
- sanctionListCode
string(optional)Sanction List. Maximum length is 4.
- restrictedParty
string(optional)Restricted Party. Maximum length is 1.
- receivingParty
string(optional)Receiving Party. Maximum length is 200.
- rpsResultContent
string(optional)- certificationInd
string(optional)Shipment Certification. Maximum length is 1.
- applicantId
string(optional)Person ID. Maximum length is 40.
- applicantName
string(optional)Applicant Name. Maximum length is 200.
- supervisorId
string(optional)Person ID. Maximum length is 40.
- supervisorName
string(optional)Supervisor Name. Maximum length is 200.
- unitNumber
string(optional)The lead unit number for the ExconProject. Maximum length is 8.
- unitName
string(optional)Unit Name. Maximum length is 200.
- exconIntlShipmentDocument.documentNumber
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"shipmentId": "(val)",
"restrictedExport": "(val)",
"shipmentDescription": "(val)",
"restrictedCountry": "(val)",
"countryCode": "(val)",
"sanctionListCode": "(val)",
"restrictedParty": "(val)",
"receivingParty": "(val)",
"rpsResultContent": "(val)",
"certificationInd": "(val)",
"applicantId": "(val)",
"applicantName": "(val)",
"supervisorId": "(val)",
"supervisorName": "(val)",
"unitNumber": "(val)",
"unitName": "(val)",
"exconIntlShipmentDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
},
{
"shipmentId": "(val)",
"restrictedExport": "(val)",
"shipmentDescription": "(val)",
"restrictedCountry": "(val)",
"countryCode": "(val)",
"sanctionListCode": "(val)",
"restrictedParty": "(val)",
"receivingParty": "(val)",
"rpsResultContent": "(val)",
"certificationInd": "(val)",
"applicantId": "(val)",
"applicantName": "(val)",
"supervisorId": "(val)",
"supervisorName": "(val)",
"unitNumber": "(val)",
"unitName": "(val)",
"exconIntlShipmentDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Excon Intl ShipmentsGET/excon/api/v1/excon-intl-shipments
Example URI
GET /excon/api/v1/excon-intl-shipments
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"shipmentId",
"restrictedExport",
"shipmentDescription",
"restrictedCountry",
"countryCode",
"sanctionListCode",
"restrictedParty",
"receivingParty",
"rpsResultContent",
"certificationInd",
"applicantId",
"applicantName",
"supervisorId",
"supervisorName",
"unitNumber",
"unitName",
"exconIntlShipmentDocument.documentNumber"
],
"primaryKey": "shipmentId"
}Get Blueprint API specification for Excon Intl ShipmentsGET/excon/api/v1/excon-intl-shipments
Example URI
GET /excon/api/v1/excon-intl-shipments
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Excon Intl Shipments.md"
transfer-encoding: chunkedUpdate Excon Intl ShipmentsPUT/excon/api/v1/excon-intl-shipments(key)
Example URI
PUT /excon/api/v1/excon-intl-shipments(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"shipmentId": "(val)",
"restrictedExport": "(val)",
"shipmentDescription": "(val)",
"restrictedCountry": "(val)",
"countryCode": "(val)",
"sanctionListCode": "(val)",
"restrictedParty": "(val)",
"receivingParty": "(val)",
"rpsResultContent": "(val)",
"certificationInd": "(val)",
"applicantId": "(val)",
"applicantName": "(val)",
"supervisorId": "(val)",
"supervisorName": "(val)",
"unitNumber": "(val)",
"unitName": "(val)",
"exconIntlShipmentDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Excon Intl ShipmentsPUT/excon/api/v1/excon-intl-shipments
Example URI
PUT /excon/api/v1/excon-intl-shipments
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"shipmentId": "(val)",
"restrictedExport": "(val)",
"shipmentDescription": "(val)",
"restrictedCountry": "(val)",
"countryCode": "(val)",
"sanctionListCode": "(val)",
"restrictedParty": "(val)",
"receivingParty": "(val)",
"rpsResultContent": "(val)",
"certificationInd": "(val)",
"applicantId": "(val)",
"applicantName": "(val)",
"supervisorId": "(val)",
"supervisorName": "(val)",
"unitNumber": "(val)",
"unitName": "(val)",
"exconIntlShipmentDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
},
{
"shipmentId": "(val)",
"restrictedExport": "(val)",
"shipmentDescription": "(val)",
"restrictedCountry": "(val)",
"countryCode": "(val)",
"sanctionListCode": "(val)",
"restrictedParty": "(val)",
"receivingParty": "(val)",
"rpsResultContent": "(val)",
"certificationInd": "(val)",
"applicantId": "(val)",
"applicantName": "(val)",
"supervisorId": "(val)",
"supervisorName": "(val)",
"unitNumber": "(val)",
"unitName": "(val)",
"exconIntlShipmentDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Excon Intl ShipmentsPATCH/excon/api/v1/excon-intl-shipments(key)
Example URI
PATCH /excon/api/v1/excon-intl-shipments(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"shipmentId": "(val)",
"restrictedExport": "(val)",
"shipmentDescription": "(val)",
"restrictedCountry": "(val)",
"countryCode": "(val)",
"sanctionListCode": "(val)",
"restrictedParty": "(val)",
"receivingParty": "(val)",
"rpsResultContent": "(val)",
"certificationInd": "(val)",
"applicantId": "(val)",
"applicantName": "(val)",
"supervisorId": "(val)",
"supervisorName": "(val)",
"unitNumber": "(val)",
"unitName": "(val)",
"exconIntlShipmentDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"shipmentId": "(val)",
"restrictedExport": "(val)",
"shipmentDescription": "(val)",
"restrictedCountry": "(val)",
"countryCode": "(val)",
"sanctionListCode": "(val)",
"restrictedParty": "(val)",
"receivingParty": "(val)",
"rpsResultContent": "(val)",
"certificationInd": "(val)",
"applicantId": "(val)",
"applicantName": "(val)",
"supervisorId": "(val)",
"supervisorName": "(val)",
"unitNumber": "(val)",
"unitName": "(val)",
"exconIntlShipmentDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
}Insert Excon Intl ShipmentsPOST/excon/api/v1/excon-intl-shipments
Example URI
POST /excon/api/v1/excon-intl-shipments
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"shipmentId": "(val)",
"restrictedExport": "(val)",
"shipmentDescription": "(val)",
"restrictedCountry": "(val)",
"countryCode": "(val)",
"sanctionListCode": "(val)",
"restrictedParty": "(val)",
"receivingParty": "(val)",
"rpsResultContent": "(val)",
"certificationInd": "(val)",
"applicantId": "(val)",
"applicantName": "(val)",
"supervisorId": "(val)",
"supervisorName": "(val)",
"unitNumber": "(val)",
"unitName": "(val)",
"exconIntlShipmentDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"shipmentId": "(val)",
"restrictedExport": "(val)",
"shipmentDescription": "(val)",
"restrictedCountry": "(val)",
"countryCode": "(val)",
"sanctionListCode": "(val)",
"restrictedParty": "(val)",
"receivingParty": "(val)",
"rpsResultContent": "(val)",
"certificationInd": "(val)",
"applicantId": "(val)",
"applicantName": "(val)",
"supervisorId": "(val)",
"supervisorName": "(val)",
"unitNumber": "(val)",
"unitName": "(val)",
"exconIntlShipmentDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Excon Intl ShipmentsPOST/excon/api/v1/excon-intl-shipments
Example URI
POST /excon/api/v1/excon-intl-shipments
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"shipmentId": "(val)",
"restrictedExport": "(val)",
"shipmentDescription": "(val)",
"restrictedCountry": "(val)",
"countryCode": "(val)",
"sanctionListCode": "(val)",
"restrictedParty": "(val)",
"receivingParty": "(val)",
"rpsResultContent": "(val)",
"certificationInd": "(val)",
"applicantId": "(val)",
"applicantName": "(val)",
"supervisorId": "(val)",
"supervisorName": "(val)",
"unitNumber": "(val)",
"unitName": "(val)",
"exconIntlShipmentDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
},
{
"shipmentId": "(val)",
"restrictedExport": "(val)",
"shipmentDescription": "(val)",
"restrictedCountry": "(val)",
"countryCode": "(val)",
"sanctionListCode": "(val)",
"restrictedParty": "(val)",
"receivingParty": "(val)",
"rpsResultContent": "(val)",
"certificationInd": "(val)",
"applicantId": "(val)",
"applicantName": "(val)",
"supervisorId": "(val)",
"supervisorName": "(val)",
"unitNumber": "(val)",
"unitName": "(val)",
"exconIntlShipmentDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"shipmentId": "(val)",
"restrictedExport": "(val)",
"shipmentDescription": "(val)",
"restrictedCountry": "(val)",
"countryCode": "(val)",
"sanctionListCode": "(val)",
"restrictedParty": "(val)",
"receivingParty": "(val)",
"rpsResultContent": "(val)",
"certificationInd": "(val)",
"applicantId": "(val)",
"applicantName": "(val)",
"supervisorId": "(val)",
"supervisorName": "(val)",
"unitNumber": "(val)",
"unitName": "(val)",
"exconIntlShipmentDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
},
{
"shipmentId": "(val)",
"restrictedExport": "(val)",
"shipmentDescription": "(val)",
"restrictedCountry": "(val)",
"countryCode": "(val)",
"sanctionListCode": "(val)",
"restrictedParty": "(val)",
"receivingParty": "(val)",
"rpsResultContent": "(val)",
"certificationInd": "(val)",
"applicantId": "(val)",
"applicantName": "(val)",
"supervisorId": "(val)",
"supervisorName": "(val)",
"unitNumber": "(val)",
"unitName": "(val)",
"exconIntlShipmentDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
}
]Delete Excon Intl Shipments by KeyDELETE/excon/api/v1/excon-intl-shipments(key)
Example URI
DELETE /excon/api/v1/excon-intl-shipments(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Intl ShipmentsDELETE/excon/api/v1/excon-intl-shipments
Example URI
DELETE /excon/api/v1/excon-intl-shipments
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Intl Shipments with MatchingDELETE/excon/api/v1/excon-intl-shipments
Example URI
DELETE /excon/api/v1/excon-intl-shipments
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- shipmentId
string(optional)Shipment ID. Maximum length is 22.
- restrictedExport
string(optional)Restricted Export. Maximum length is 1.
- shipmentDescription
string(optional)Shipment Description. Maximum length is 200.
- restrictedCountry
string(optional)Restricted Country. Maximum length is 1.
- countryCode
string(optional)Country Code. Maximum length is 3.
- sanctionListCode
string(optional)Sanction List. Maximum length is 4.
- restrictedParty
string(optional)Restricted Party. Maximum length is 1.
- receivingParty
string(optional)Receiving Party. Maximum length is 200.
- rpsResultContent
string(optional)- certificationInd
string(optional)Shipment Certification. Maximum length is 1.
- applicantId
string(optional)Person ID. Maximum length is 40.
- applicantName
string(optional)Applicant Name. Maximum length is 200.
- supervisorId
string(optional)Person ID. Maximum length is 40.
- supervisorName
string(optional)Supervisor Name. Maximum length is 200.
- unitNumber
string(optional)The lead unit number for the ExconProject. Maximum length is 8.
- unitName
string(optional)Unit Name. Maximum length is 200.
- exconIntlShipmentDocument.documentNumber
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Excon Project Associated Document Types ¶
Get Excon Project Associated Document Types by KeyGET/excon/api/v1/excon-project-associated-document-types(key)
Example URI
GET /excon/api/v1/excon-project-associated-document-types(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"assocDocTypeCode": "(val)",
"assocDocTypeName": "(val)",
"assocDocTypeClassName": "(val)",
"assocDocTypeNumberAttr": "(val)",
"returnsVals": "(val)",
"_primaryKey": "(val)"
}Get All Excon Project Associated Document TypesGET/excon/api/v1/excon-project-associated-document-types
Example URI
GET /excon/api/v1/excon-project-associated-document-types
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"assocDocTypeCode": "(val)",
"assocDocTypeName": "(val)",
"assocDocTypeClassName": "(val)",
"assocDocTypeNumberAttr": "(val)",
"returnsVals": "(val)",
"_primaryKey": "(val)"
},
{
"assocDocTypeCode": "(val)",
"assocDocTypeName": "(val)",
"assocDocTypeClassName": "(val)",
"assocDocTypeNumberAttr": "(val)",
"returnsVals": "(val)",
"_primaryKey": "(val)"
}
]Get All Excon Project Associated Document Types with FilteringGET/excon/api/v1/excon-project-associated-document-types
Example URI
GET /excon/api/v1/excon-project-associated-document-types
URI Parameters
- assocDocTypeCode
string(optional)Export Control Project Associated Document Type Code. Maximum length is 8.
- assocDocTypeName
string(optional)Export Control Project Associated Document Type Name. Maximum length is 40.
- assocDocTypeClassName
string(optional)Export Control Project Associated Document Type Class Name. Maximum length is 100.
- assocDocTypeNumberAttr
string(optional)Export Control Project Associated Document Type Number Attr. Maximum length is 40.
- returnsVals
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"assocDocTypeCode": "(val)",
"assocDocTypeName": "(val)",
"assocDocTypeClassName": "(val)",
"assocDocTypeNumberAttr": "(val)",
"returnsVals": "(val)",
"_primaryKey": "(val)"
},
{
"assocDocTypeCode": "(val)",
"assocDocTypeName": "(val)",
"assocDocTypeClassName": "(val)",
"assocDocTypeNumberAttr": "(val)",
"returnsVals": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Excon Project Associated Document TypesGET/excon/api/v1/excon-project-associated-document-types
Example URI
GET /excon/api/v1/excon-project-associated-document-types
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"assocDocTypeCode",
"assocDocTypeName",
"assocDocTypeClassName",
"assocDocTypeNumberAttr",
"returnsVals"
],
"primaryKey": "assocDocTypeCode"
}Get Blueprint API specification for Excon Project Associated Document TypesGET/excon/api/v1/excon-project-associated-document-types
Example URI
GET /excon/api/v1/excon-project-associated-document-types
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Excon Project Associated Document Types.md"
transfer-encoding: chunkedUpdate Excon Project Associated Document TypesPUT/excon/api/v1/excon-project-associated-document-types(key)
Example URI
PUT /excon/api/v1/excon-project-associated-document-types(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"assocDocTypeCode": "(val)",
"assocDocTypeName": "(val)",
"assocDocTypeClassName": "(val)",
"assocDocTypeNumberAttr": "(val)",
"returnsVals": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Excon Project Associated Document TypesPUT/excon/api/v1/excon-project-associated-document-types
Example URI
PUT /excon/api/v1/excon-project-associated-document-types
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"assocDocTypeCode": "(val)",
"assocDocTypeName": "(val)",
"assocDocTypeClassName": "(val)",
"assocDocTypeNumberAttr": "(val)",
"returnsVals": "(val)",
"_primaryKey": "(val)"
},
{
"assocDocTypeCode": "(val)",
"assocDocTypeName": "(val)",
"assocDocTypeClassName": "(val)",
"assocDocTypeNumberAttr": "(val)",
"returnsVals": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Excon Project Associated Document TypesPATCH/excon/api/v1/excon-project-associated-document-types(key)
Example URI
PATCH /excon/api/v1/excon-project-associated-document-types(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"assocDocTypeCode": "(val)",
"assocDocTypeName": "(val)",
"assocDocTypeClassName": "(val)",
"assocDocTypeNumberAttr": "(val)",
"returnsVals": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"assocDocTypeCode": "(val)",
"assocDocTypeName": "(val)",
"assocDocTypeClassName": "(val)",
"assocDocTypeNumberAttr": "(val)",
"returnsVals": "(val)",
"_primaryKey": "(val)"
}Insert Excon Project Associated Document TypesPOST/excon/api/v1/excon-project-associated-document-types
Example URI
POST /excon/api/v1/excon-project-associated-document-types
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"assocDocTypeCode": "(val)",
"assocDocTypeName": "(val)",
"assocDocTypeClassName": "(val)",
"assocDocTypeNumberAttr": "(val)",
"returnsVals": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"assocDocTypeCode": "(val)",
"assocDocTypeName": "(val)",
"assocDocTypeClassName": "(val)",
"assocDocTypeNumberAttr": "(val)",
"returnsVals": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Excon Project Associated Document TypesPOST/excon/api/v1/excon-project-associated-document-types
Example URI
POST /excon/api/v1/excon-project-associated-document-types
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"assocDocTypeCode": "(val)",
"assocDocTypeName": "(val)",
"assocDocTypeClassName": "(val)",
"assocDocTypeNumberAttr": "(val)",
"returnsVals": "(val)",
"_primaryKey": "(val)"
},
{
"assocDocTypeCode": "(val)",
"assocDocTypeName": "(val)",
"assocDocTypeClassName": "(val)",
"assocDocTypeNumberAttr": "(val)",
"returnsVals": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"assocDocTypeCode": "(val)",
"assocDocTypeName": "(val)",
"assocDocTypeClassName": "(val)",
"assocDocTypeNumberAttr": "(val)",
"returnsVals": "(val)",
"_primaryKey": "(val)"
},
{
"assocDocTypeCode": "(val)",
"assocDocTypeName": "(val)",
"assocDocTypeClassName": "(val)",
"assocDocTypeNumberAttr": "(val)",
"returnsVals": "(val)",
"_primaryKey": "(val)"
}
]Delete Excon Project Associated Document Types by KeyDELETE/excon/api/v1/excon-project-associated-document-types(key)
Example URI
DELETE /excon/api/v1/excon-project-associated-document-types(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project Associated Document TypesDELETE/excon/api/v1/excon-project-associated-document-types
Example URI
DELETE /excon/api/v1/excon-project-associated-document-types
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project Associated Document Types with MatchingDELETE/excon/api/v1/excon-project-associated-document-types
Example URI
DELETE /excon/api/v1/excon-project-associated-document-types
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- assocDocTypeCode
string(optional)Export Control Project Associated Document Type Code. Maximum length is 8.
- assocDocTypeName
string(optional)Export Control Project Associated Document Type Name. Maximum length is 40.
- assocDocTypeClassName
string(optional)Export Control Project Associated Document Type Class Name. Maximum length is 100.
- assocDocTypeNumberAttr
string(optional)Export Control Project Associated Document Type Number Attr. Maximum length is 40.
- returnsVals
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Excon Project Associated Documents ¶
Get Excon Project Associated Documents by KeyGET/excon/api/v1/excon-project-associated-documents(key)
Example URI
GET /excon/api/v1/excon-project-associated-documents(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"exconProjectAssocDocId": "(val)",
"assocDocTypeCode": "(val)",
"assocDocNumber": "(val)",
"assocDocTitle": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Get All Excon Project Associated DocumentsGET/excon/api/v1/excon-project-associated-documents
Example URI
GET /excon/api/v1/excon-project-associated-documents
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"exconProjectAssocDocId": "(val)",
"assocDocTypeCode": "(val)",
"assocDocNumber": "(val)",
"assocDocTitle": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectAssocDocId": "(val)",
"assocDocTypeCode": "(val)",
"assocDocNumber": "(val)",
"assocDocTitle": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}
]Get All Excon Project Associated Documents with FilteringGET/excon/api/v1/excon-project-associated-documents
Example URI
GET /excon/api/v1/excon-project-associated-documents
URI Parameters
- exconProjectAssocDocId
string(optional)Export Control Associated Document ID. Maximum length is 22.
- assocDocTypeCode
string(optional)Associated Document Type Code. Maximum length is 8.
- assocDocNumber
string(optional)Associated Document Identifier. Maximum length is 12.
- assocDocTitle
string(optional)Associated Document Title. Maximum length is 200.
- projectNumber
string(optional)- sequenceNumber
string(optional)- exconProject.projectId
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"exconProjectAssocDocId": "(val)",
"assocDocTypeCode": "(val)",
"assocDocNumber": "(val)",
"assocDocTitle": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectAssocDocId": "(val)",
"assocDocTypeCode": "(val)",
"assocDocNumber": "(val)",
"assocDocTitle": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Excon Project Associated DocumentsGET/excon/api/v1/excon-project-associated-documents
Example URI
GET /excon/api/v1/excon-project-associated-documents
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"exconProjectAssocDocId",
"assocDocTypeCode",
"assocDocNumber",
"assocDocTitle",
"projectNumber",
"sequenceNumber",
"exconProject.projectId"
],
"primaryKey": "exconProjectAssocDocId"
}Get Blueprint API specification for Excon Project Associated DocumentsGET/excon/api/v1/excon-project-associated-documents
Example URI
GET /excon/api/v1/excon-project-associated-documents
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Excon Project Associated Documents.md"
transfer-encoding: chunkedUpdate Excon Project Associated DocumentsPUT/excon/api/v1/excon-project-associated-documents(key)
Example URI
PUT /excon/api/v1/excon-project-associated-documents(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"exconProjectAssocDocId": "(val)",
"assocDocTypeCode": "(val)",
"assocDocNumber": "(val)",
"assocDocTitle": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Excon Project Associated DocumentsPUT/excon/api/v1/excon-project-associated-documents
Example URI
PUT /excon/api/v1/excon-project-associated-documents
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"exconProjectAssocDocId": "(val)",
"assocDocTypeCode": "(val)",
"assocDocNumber": "(val)",
"assocDocTitle": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectAssocDocId": "(val)",
"assocDocTypeCode": "(val)",
"assocDocNumber": "(val)",
"assocDocTitle": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Excon Project Associated DocumentsPATCH/excon/api/v1/excon-project-associated-documents(key)
Example URI
PATCH /excon/api/v1/excon-project-associated-documents(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"exconProjectAssocDocId": "(val)",
"assocDocTypeCode": "(val)",
"assocDocNumber": "(val)",
"assocDocTitle": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"exconProjectAssocDocId": "(val)",
"assocDocTypeCode": "(val)",
"assocDocNumber": "(val)",
"assocDocTitle": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Insert Excon Project Associated DocumentsPOST/excon/api/v1/excon-project-associated-documents
Example URI
POST /excon/api/v1/excon-project-associated-documents
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"exconProjectAssocDocId": "(val)",
"assocDocTypeCode": "(val)",
"assocDocNumber": "(val)",
"assocDocTitle": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"exconProjectAssocDocId": "(val)",
"assocDocTypeCode": "(val)",
"assocDocNumber": "(val)",
"assocDocTitle": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Excon Project Associated DocumentsPOST/excon/api/v1/excon-project-associated-documents
Example URI
POST /excon/api/v1/excon-project-associated-documents
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"exconProjectAssocDocId": "(val)",
"assocDocTypeCode": "(val)",
"assocDocNumber": "(val)",
"assocDocTitle": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectAssocDocId": "(val)",
"assocDocTypeCode": "(val)",
"assocDocNumber": "(val)",
"assocDocTitle": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"exconProjectAssocDocId": "(val)",
"assocDocTypeCode": "(val)",
"assocDocNumber": "(val)",
"assocDocTitle": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectAssocDocId": "(val)",
"assocDocTypeCode": "(val)",
"assocDocNumber": "(val)",
"assocDocTitle": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}
]Delete Excon Project Associated Documents by KeyDELETE/excon/api/v1/excon-project-associated-documents(key)
Example URI
DELETE /excon/api/v1/excon-project-associated-documents(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project Associated DocumentsDELETE/excon/api/v1/excon-project-associated-documents
Example URI
DELETE /excon/api/v1/excon-project-associated-documents
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project Associated Documents with MatchingDELETE/excon/api/v1/excon-project-associated-documents
Example URI
DELETE /excon/api/v1/excon-project-associated-documents
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- exconProjectAssocDocId
string(optional)Export Control Associated Document ID. Maximum length is 22.
- assocDocTypeCode
string(optional)Associated Document Type Code. Maximum length is 8.
- assocDocNumber
string(optional)Associated Document Identifier. Maximum length is 12.
- assocDocTitle
string(optional)Associated Document Title. Maximum length is 200.
- projectNumber
string(optional)- sequenceNumber
string(optional)- exconProject.projectId
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Excon Project Attachment Types ¶
Get Excon Project Attachment Types by KeyGET/excon/api/v1/excon-project-attachment-types(key)
Example URI
GET /excon/api/v1/excon-project-attachment-types(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"exconProjectAttachmentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Excon Project Attachment TypesGET/excon/api/v1/excon-project-attachment-types
Example URI
GET /excon/api/v1/excon-project-attachment-types
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"exconProjectAttachmentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectAttachmentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Excon Project Attachment Types with FilteringGET/excon/api/v1/excon-project-attachment-types
Example URI
GET /excon/api/v1/excon-project-attachment-types
URI Parameters
- exconProjectAttachmentTypeCode
string(optional)Export Control Project Attachment Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"exconProjectAttachmentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectAttachmentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Excon Project Attachment TypesGET/excon/api/v1/excon-project-attachment-types
Example URI
GET /excon/api/v1/excon-project-attachment-types
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"exconProjectAttachmentTypeCode",
"description"
],
"primaryKey": "exconProjectAttachmentTypeCode"
}Get Blueprint API specification for Excon Project Attachment TypesGET/excon/api/v1/excon-project-attachment-types
Example URI
GET /excon/api/v1/excon-project-attachment-types
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Excon Project Attachment Types.md"
transfer-encoding: chunkedUpdate Excon Project Attachment TypesPUT/excon/api/v1/excon-project-attachment-types(key)
Example URI
PUT /excon/api/v1/excon-project-attachment-types(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"exconProjectAttachmentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Excon Project Attachment TypesPUT/excon/api/v1/excon-project-attachment-types
Example URI
PUT /excon/api/v1/excon-project-attachment-types
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"exconProjectAttachmentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectAttachmentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Excon Project Attachment TypesPATCH/excon/api/v1/excon-project-attachment-types(key)
Example URI
PATCH /excon/api/v1/excon-project-attachment-types(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"exconProjectAttachmentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"exconProjectAttachmentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Excon Project Attachment TypesPOST/excon/api/v1/excon-project-attachment-types
Example URI
POST /excon/api/v1/excon-project-attachment-types
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"exconProjectAttachmentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"exconProjectAttachmentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Excon Project Attachment TypesPOST/excon/api/v1/excon-project-attachment-types
Example URI
POST /excon/api/v1/excon-project-attachment-types
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"exconProjectAttachmentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectAttachmentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"exconProjectAttachmentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectAttachmentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Excon Project Attachment Types by KeyDELETE/excon/api/v1/excon-project-attachment-types(key)
Example URI
DELETE /excon/api/v1/excon-project-attachment-types(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project Attachment TypesDELETE/excon/api/v1/excon-project-attachment-types
Example URI
DELETE /excon/api/v1/excon-project-attachment-types
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project Attachment Types with MatchingDELETE/excon/api/v1/excon-project-attachment-types
Example URI
DELETE /excon/api/v1/excon-project-attachment-types
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- exconProjectAttachmentTypeCode
string(optional)Export Control Project Attachment Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Excon Project Attachments ¶
Get Excon Project Attachments by KeyGET/excon/api/v1/excon-project-attachments(key)
Example URI
GET /excon/api/v1/excon-project-attachments(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"exconProjectAttachmentId": "(val)",
"projectId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"typeCode": "(val)",
"documentId": "(val)",
"fileId": "(val)",
"description": "(val)",
"attachUser": "(val)",
"attachDate": "(val)",
"_primaryKey": "(val)"
}Get All Excon Project AttachmentsGET/excon/api/v1/excon-project-attachments
Example URI
GET /excon/api/v1/excon-project-attachments
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"exconProjectAttachmentId": "(val)",
"projectId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"typeCode": "(val)",
"documentId": "(val)",
"fileId": "(val)",
"description": "(val)",
"attachUser": "(val)",
"attachDate": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectAttachmentId": "(val)",
"projectId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"typeCode": "(val)",
"documentId": "(val)",
"fileId": "(val)",
"description": "(val)",
"attachUser": "(val)",
"attachDate": "(val)",
"_primaryKey": "(val)"
}
]Get All Excon Project Attachments with FilteringGET/excon/api/v1/excon-project-attachments
Example URI
GET /excon/api/v1/excon-project-attachments
URI Parameters
- exconProjectAttachmentId
string(optional)Export Control Attachment ID. Maximum length is 22.
- projectId
string(optional)- projectNumber
string(optional)- sequenceNumber
string(optional)- typeCode
string(optional)Type Code. Maximum length is 3.
- documentId
string(optional)Document ID. Maximum length is 4.
- fileId
string(optional)File Id. Maximum length is 22.
- description
string(optional)Description.
- attachUser
string(optional)- attachDate
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"exconProjectAttachmentId": "(val)",
"projectId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"typeCode": "(val)",
"documentId": "(val)",
"fileId": "(val)",
"description": "(val)",
"attachUser": "(val)",
"attachDate": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectAttachmentId": "(val)",
"projectId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"typeCode": "(val)",
"documentId": "(val)",
"fileId": "(val)",
"description": "(val)",
"attachUser": "(val)",
"attachDate": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Excon Project AttachmentsGET/excon/api/v1/excon-project-attachments
Example URI
GET /excon/api/v1/excon-project-attachments
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"exconProjectAttachmentId",
"projectId",
"projectNumber",
"sequenceNumber",
"typeCode",
"documentId",
"fileId",
"description",
"attachUser",
"attachDate"
],
"primaryKey": "exconProjectAttachmentId"
}Get Blueprint API specification for Excon Project AttachmentsGET/excon/api/v1/excon-project-attachments
Example URI
GET /excon/api/v1/excon-project-attachments
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Excon Project Attachments.md"
transfer-encoding: chunkedUpdate Excon Project AttachmentsPUT/excon/api/v1/excon-project-attachments(key)
Example URI
PUT /excon/api/v1/excon-project-attachments(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"exconProjectAttachmentId": "(val)",
"projectId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"typeCode": "(val)",
"documentId": "(val)",
"fileId": "(val)",
"description": "(val)",
"attachUser": "(val)",
"attachDate": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Excon Project AttachmentsPUT/excon/api/v1/excon-project-attachments
Example URI
PUT /excon/api/v1/excon-project-attachments
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"exconProjectAttachmentId": "(val)",
"projectId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"typeCode": "(val)",
"documentId": "(val)",
"fileId": "(val)",
"description": "(val)",
"attachUser": "(val)",
"attachDate": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectAttachmentId": "(val)",
"projectId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"typeCode": "(val)",
"documentId": "(val)",
"fileId": "(val)",
"description": "(val)",
"attachUser": "(val)",
"attachDate": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Excon Project AttachmentsPATCH/excon/api/v1/excon-project-attachments(key)
Example URI
PATCH /excon/api/v1/excon-project-attachments(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"exconProjectAttachmentId": "(val)",
"projectId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"typeCode": "(val)",
"documentId": "(val)",
"fileId": "(val)",
"description": "(val)",
"attachUser": "(val)",
"attachDate": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"exconProjectAttachmentId": "(val)",
"projectId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"typeCode": "(val)",
"documentId": "(val)",
"fileId": "(val)",
"description": "(val)",
"attachUser": "(val)",
"attachDate": "(val)",
"_primaryKey": "(val)"
}Insert Excon Project AttachmentsPOST/excon/api/v1/excon-project-attachments
Example URI
POST /excon/api/v1/excon-project-attachments
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"exconProjectAttachmentId": "(val)",
"projectId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"typeCode": "(val)",
"documentId": "(val)",
"fileId": "(val)",
"description": "(val)",
"attachUser": "(val)",
"attachDate": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"exconProjectAttachmentId": "(val)",
"projectId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"typeCode": "(val)",
"documentId": "(val)",
"fileId": "(val)",
"description": "(val)",
"attachUser": "(val)",
"attachDate": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Excon Project AttachmentsPOST/excon/api/v1/excon-project-attachments
Example URI
POST /excon/api/v1/excon-project-attachments
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"exconProjectAttachmentId": "(val)",
"projectId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"typeCode": "(val)",
"documentId": "(val)",
"fileId": "(val)",
"description": "(val)",
"attachUser": "(val)",
"attachDate": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectAttachmentId": "(val)",
"projectId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"typeCode": "(val)",
"documentId": "(val)",
"fileId": "(val)",
"description": "(val)",
"attachUser": "(val)",
"attachDate": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"exconProjectAttachmentId": "(val)",
"projectId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"typeCode": "(val)",
"documentId": "(val)",
"fileId": "(val)",
"description": "(val)",
"attachUser": "(val)",
"attachDate": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectAttachmentId": "(val)",
"projectId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"typeCode": "(val)",
"documentId": "(val)",
"fileId": "(val)",
"description": "(val)",
"attachUser": "(val)",
"attachDate": "(val)",
"_primaryKey": "(val)"
}
]Delete Excon Project Attachments by KeyDELETE/excon/api/v1/excon-project-attachments(key)
Example URI
DELETE /excon/api/v1/excon-project-attachments(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project AttachmentsDELETE/excon/api/v1/excon-project-attachments
Example URI
DELETE /excon/api/v1/excon-project-attachments
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project Attachments with MatchingDELETE/excon/api/v1/excon-project-attachments
Example URI
DELETE /excon/api/v1/excon-project-attachments
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- exconProjectAttachmentId
string(optional)Export Control Attachment ID. Maximum length is 22.
- projectId
string(optional)- projectNumber
string(optional)- sequenceNumber
string(optional)- typeCode
string(optional)Type Code. Maximum length is 3.
- documentId
string(optional)Document ID. Maximum length is 4.
- fileId
string(optional)File Id. Maximum length is 22.
- description
string(optional)Description.
- attachUser
string(optional)- attachDate
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Excon Project Comment Types ¶
Get Excon Project Comment Types by KeyGET/excon/api/v1/excon-project-comment-types(key)
Example URI
GET /excon/api/v1/excon-project-comment-types(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"exconProjectCommentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Excon Project Comment TypesGET/excon/api/v1/excon-project-comment-types
Example URI
GET /excon/api/v1/excon-project-comment-types
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"exconProjectCommentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectCommentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Excon Project Comment Types with FilteringGET/excon/api/v1/excon-project-comment-types
Example URI
GET /excon/api/v1/excon-project-comment-types
URI Parameters
- exconProjectCommentTypeCode
string(optional)Export Control Project Comment Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"exconProjectCommentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectCommentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Excon Project Comment TypesGET/excon/api/v1/excon-project-comment-types
Example URI
GET /excon/api/v1/excon-project-comment-types
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"exconProjectCommentTypeCode",
"description"
],
"primaryKey": "exconProjectCommentTypeCode"
}Get Blueprint API specification for Excon Project Comment TypesGET/excon/api/v1/excon-project-comment-types
Example URI
GET /excon/api/v1/excon-project-comment-types
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Excon Project Comment Types.md"
transfer-encoding: chunkedUpdate Excon Project Comment TypesPUT/excon/api/v1/excon-project-comment-types(key)
Example URI
PUT /excon/api/v1/excon-project-comment-types(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"exconProjectCommentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Excon Project Comment TypesPUT/excon/api/v1/excon-project-comment-types
Example URI
PUT /excon/api/v1/excon-project-comment-types
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"exconProjectCommentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectCommentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Excon Project Comment TypesPATCH/excon/api/v1/excon-project-comment-types(key)
Example URI
PATCH /excon/api/v1/excon-project-comment-types(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"exconProjectCommentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"exconProjectCommentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Excon Project Comment TypesPOST/excon/api/v1/excon-project-comment-types
Example URI
POST /excon/api/v1/excon-project-comment-types
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"exconProjectCommentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"exconProjectCommentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Excon Project Comment TypesPOST/excon/api/v1/excon-project-comment-types
Example URI
POST /excon/api/v1/excon-project-comment-types
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"exconProjectCommentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectCommentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"exconProjectCommentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectCommentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Excon Project Comment Types by KeyDELETE/excon/api/v1/excon-project-comment-types(key)
Example URI
DELETE /excon/api/v1/excon-project-comment-types(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project Comment TypesDELETE/excon/api/v1/excon-project-comment-types
Example URI
DELETE /excon/api/v1/excon-project-comment-types
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project Comment Types with MatchingDELETE/excon/api/v1/excon-project-comment-types
Example URI
DELETE /excon/api/v1/excon-project-comment-types
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- exconProjectCommentTypeCode
string(optional)Export Control Project Comment Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Excon Project Comments ¶
Get Excon Project Comments by KeyGET/excon/api/v1/excon-project-comments(key)
Example URI
GET /excon/api/v1/excon-project-comments(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"exconProjectCommentId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"commentTypeCode": "(val)",
"comments": "(val)",
"commentAuthor": "(val)",
"commentDate": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Get All Excon Project CommentsGET/excon/api/v1/excon-project-comments
Example URI
GET /excon/api/v1/excon-project-comments
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"exconProjectCommentId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"commentTypeCode": "(val)",
"comments": "(val)",
"commentAuthor": "(val)",
"commentDate": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectCommentId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"commentTypeCode": "(val)",
"comments": "(val)",
"commentAuthor": "(val)",
"commentDate": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}
]Get All Excon Project Comments with FilteringGET/excon/api/v1/excon-project-comments
Example URI
GET /excon/api/v1/excon-project-comments
URI Parameters
- exconProjectCommentId
string(optional)Export Control Comment Project ID. Maximum length is 22.
- projectNumber
string(optional)- sequenceNumber
string(optional)- commentTypeCode
string(optional)Comment Type Code. Maximum length is 3.
- comments
string(optional)Comments.
- commentAuthor
string(optional)The user who created or last modified the object. Maximum length is 60.
- commentDate
string(optional)The creation or last modification timestamp. Maximum length is 21.
- exconProject.projectId
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"exconProjectCommentId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"commentTypeCode": "(val)",
"comments": "(val)",
"commentAuthor": "(val)",
"commentDate": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectCommentId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"commentTypeCode": "(val)",
"comments": "(val)",
"commentAuthor": "(val)",
"commentDate": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Excon Project CommentsGET/excon/api/v1/excon-project-comments
Example URI
GET /excon/api/v1/excon-project-comments
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"exconProjectCommentId",
"projectNumber",
"sequenceNumber",
"commentTypeCode",
"comments",
"commentAuthor",
"commentDate",
"exconProject.projectId"
],
"primaryKey": "exconProjectCommentId"
}Get Blueprint API specification for Excon Project CommentsGET/excon/api/v1/excon-project-comments
Example URI
GET /excon/api/v1/excon-project-comments
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Excon Project Comments.md"
transfer-encoding: chunkedUpdate Excon Project CommentsPUT/excon/api/v1/excon-project-comments(key)
Example URI
PUT /excon/api/v1/excon-project-comments(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"exconProjectCommentId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"commentTypeCode": "(val)",
"comments": "(val)",
"commentAuthor": "(val)",
"commentDate": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Excon Project CommentsPUT/excon/api/v1/excon-project-comments
Example URI
PUT /excon/api/v1/excon-project-comments
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"exconProjectCommentId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"commentTypeCode": "(val)",
"comments": "(val)",
"commentAuthor": "(val)",
"commentDate": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectCommentId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"commentTypeCode": "(val)",
"comments": "(val)",
"commentAuthor": "(val)",
"commentDate": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Excon Project CommentsPATCH/excon/api/v1/excon-project-comments(key)
Example URI
PATCH /excon/api/v1/excon-project-comments(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"exconProjectCommentId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"commentTypeCode": "(val)",
"comments": "(val)",
"commentAuthor": "(val)",
"commentDate": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"exconProjectCommentId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"commentTypeCode": "(val)",
"comments": "(val)",
"commentAuthor": "(val)",
"commentDate": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Insert Excon Project CommentsPOST/excon/api/v1/excon-project-comments
Example URI
POST /excon/api/v1/excon-project-comments
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"exconProjectCommentId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"commentTypeCode": "(val)",
"comments": "(val)",
"commentAuthor": "(val)",
"commentDate": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"exconProjectCommentId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"commentTypeCode": "(val)",
"comments": "(val)",
"commentAuthor": "(val)",
"commentDate": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Excon Project CommentsPOST/excon/api/v1/excon-project-comments
Example URI
POST /excon/api/v1/excon-project-comments
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"exconProjectCommentId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"commentTypeCode": "(val)",
"comments": "(val)",
"commentAuthor": "(val)",
"commentDate": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectCommentId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"commentTypeCode": "(val)",
"comments": "(val)",
"commentAuthor": "(val)",
"commentDate": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"exconProjectCommentId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"commentTypeCode": "(val)",
"comments": "(val)",
"commentAuthor": "(val)",
"commentDate": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectCommentId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"commentTypeCode": "(val)",
"comments": "(val)",
"commentAuthor": "(val)",
"commentDate": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}
]Delete Excon Project Comments by KeyDELETE/excon/api/v1/excon-project-comments(key)
Example URI
DELETE /excon/api/v1/excon-project-comments(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project CommentsDELETE/excon/api/v1/excon-project-comments
Example URI
DELETE /excon/api/v1/excon-project-comments
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project Comments with MatchingDELETE/excon/api/v1/excon-project-comments
Example URI
DELETE /excon/api/v1/excon-project-comments
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- exconProjectCommentId
string(optional)Export Control Comment Project ID. Maximum length is 22.
- projectNumber
string(optional)- sequenceNumber
string(optional)- commentTypeCode
string(optional)Comment Type Code. Maximum length is 3.
- comments
string(optional)Comments.
- commentAuthor
string(optional)The user who created or last modified the object. Maximum length is 60.
- commentDate
string(optional)The creation or last modification timestamp. Maximum length is 21.
- exconProject.projectId
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Excon Project Content Types ¶
Get Excon Project Content Types by KeyGET/excon/api/v1/excon-project-content-types(key)
Example URI
GET /excon/api/v1/excon-project-content-types(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"contentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Excon Project Content TypesGET/excon/api/v1/excon-project-content-types
Example URI
GET /excon/api/v1/excon-project-content-types
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"contentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"contentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Excon Project Content Types with FilteringGET/excon/api/v1/excon-project-content-types
Example URI
GET /excon/api/v1/excon-project-content-types
URI Parameters
- contentTypeCode
string(optional)Export Control Project Content Type Code. Maximum length is 5.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"contentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"contentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Excon Project Content TypesGET/excon/api/v1/excon-project-content-types
Example URI
GET /excon/api/v1/excon-project-content-types
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"contentTypeCode",
"description"
],
"primaryKey": "contentTypeCode"
}Get Blueprint API specification for Excon Project Content TypesGET/excon/api/v1/excon-project-content-types
Example URI
GET /excon/api/v1/excon-project-content-types
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Excon Project Content Types.md"
transfer-encoding: chunkedUpdate Excon Project Content TypesPUT/excon/api/v1/excon-project-content-types(key)
Example URI
PUT /excon/api/v1/excon-project-content-types(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"contentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Excon Project Content TypesPUT/excon/api/v1/excon-project-content-types
Example URI
PUT /excon/api/v1/excon-project-content-types
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"contentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"contentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Excon Project Content TypesPATCH/excon/api/v1/excon-project-content-types(key)
Example URI
PATCH /excon/api/v1/excon-project-content-types(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"contentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"contentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Excon Project Content TypesPOST/excon/api/v1/excon-project-content-types
Example URI
POST /excon/api/v1/excon-project-content-types
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"contentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"contentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Excon Project Content TypesPOST/excon/api/v1/excon-project-content-types
Example URI
POST /excon/api/v1/excon-project-content-types
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"contentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"contentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"contentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"contentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Excon Project Content Types by KeyDELETE/excon/api/v1/excon-project-content-types(key)
Example URI
DELETE /excon/api/v1/excon-project-content-types(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project Content TypesDELETE/excon/api/v1/excon-project-content-types
Example URI
DELETE /excon/api/v1/excon-project-content-types
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project Content Types with MatchingDELETE/excon/api/v1/excon-project-content-types
Example URI
DELETE /excon/api/v1/excon-project-content-types
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- contentTypeCode
string(optional)Export Control Project Content Type Code. Maximum length is 5.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Excon Project Custom Datas ¶
Get Excon Project Custom Datas by KeyGET/excon/api/v1/excon-project-custom-datas(key)
Example URI
GET /excon/api/v1/excon-project-custom-datas(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"exconProjectCustomDataId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"customAttributeId": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
}Get All Excon Project Custom DatasGET/excon/api/v1/excon-project-custom-datas
Example URI
GET /excon/api/v1/excon-project-custom-datas
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"exconProjectCustomDataId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"customAttributeId": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectCustomDataId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"customAttributeId": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
}
]Get All Excon Project Custom Datas with FilteringGET/excon/api/v1/excon-project-custom-datas
Example URI
GET /excon/api/v1/excon-project-custom-datas
URI Parameters
- exconProjectCustomDataId
string(optional)- projectNumber
string(optional)- sequenceNumber
string(optional)- customAttributeId
string(optional)- value
string(optional)Value. Maximum length is 2000.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"exconProjectCustomDataId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"customAttributeId": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectCustomDataId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"customAttributeId": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Excon Project Custom DatasGET/excon/api/v1/excon-project-custom-datas
Example URI
GET /excon/api/v1/excon-project-custom-datas
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"exconProjectCustomDataId",
"projectNumber",
"sequenceNumber",
"customAttributeId",
"value"
],
"primaryKey": "exconProjectCustomDataId"
}Get Blueprint API specification for Excon Project Custom DatasGET/excon/api/v1/excon-project-custom-datas
Example URI
GET /excon/api/v1/excon-project-custom-datas
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Excon Project Custom Datas.md"
transfer-encoding: chunkedUpdate Excon Project Custom DatasPUT/excon/api/v1/excon-project-custom-datas(key)
Example URI
PUT /excon/api/v1/excon-project-custom-datas(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"exconProjectCustomDataId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"customAttributeId": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Excon Project Custom DatasPUT/excon/api/v1/excon-project-custom-datas
Example URI
PUT /excon/api/v1/excon-project-custom-datas
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"exconProjectCustomDataId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"customAttributeId": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectCustomDataId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"customAttributeId": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Excon Project Custom DatasPATCH/excon/api/v1/excon-project-custom-datas(key)
Example URI
PATCH /excon/api/v1/excon-project-custom-datas(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"exconProjectCustomDataId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"customAttributeId": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"exconProjectCustomDataId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"customAttributeId": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
}Insert Excon Project Custom DatasPOST/excon/api/v1/excon-project-custom-datas
Example URI
POST /excon/api/v1/excon-project-custom-datas
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"exconProjectCustomDataId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"customAttributeId": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"exconProjectCustomDataId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"customAttributeId": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Excon Project Custom DatasPOST/excon/api/v1/excon-project-custom-datas
Example URI
POST /excon/api/v1/excon-project-custom-datas
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"exconProjectCustomDataId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"customAttributeId": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectCustomDataId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"customAttributeId": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"exconProjectCustomDataId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"customAttributeId": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectCustomDataId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"customAttributeId": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
}
]Delete Excon Project Custom Datas by KeyDELETE/excon/api/v1/excon-project-custom-datas(key)
Example URI
DELETE /excon/api/v1/excon-project-custom-datas(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project Custom DatasDELETE/excon/api/v1/excon-project-custom-datas
Example URI
DELETE /excon/api/v1/excon-project-custom-datas
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project Custom Datas with MatchingDELETE/excon/api/v1/excon-project-custom-datas
Example URI
DELETE /excon/api/v1/excon-project-custom-datas
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- exconProjectCustomDataId
string(optional)- projectNumber
string(optional)- sequenceNumber
string(optional)- customAttributeId
string(optional)- value
string(optional)Value. Maximum length is 2000.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Excon Project Destinations ¶
Get Excon Project Destinations by KeyGET/excon/api/v1/excon-project-destinations(key)
Example URI
GET /excon/api/v1/excon-project-destinations(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"exconProjectDestId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"destinationCountryCode": "(val)",
"arrivalDate": "(val)",
"departureDate": "(val)",
"destinationComment": "(val)",
"sanctionList": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Get All Excon Project DestinationsGET/excon/api/v1/excon-project-destinations
Example URI
GET /excon/api/v1/excon-project-destinations
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"exconProjectDestId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"destinationCountryCode": "(val)",
"arrivalDate": "(val)",
"departureDate": "(val)",
"destinationComment": "(val)",
"sanctionList": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectDestId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"destinationCountryCode": "(val)",
"arrivalDate": "(val)",
"departureDate": "(val)",
"destinationComment": "(val)",
"sanctionList": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}
]Get All Excon Project Destinations with FilteringGET/excon/api/v1/excon-project-destinations
Example URI
GET /excon/api/v1/excon-project-destinations
URI Parameters
- exconProjectDestId
string(optional)Export Control Destination ID. Maximum length is 22.
- projectNumber
string(optional)- sequenceNumber
string(optional)- destinationCountryCode
string(optional)Destination Country. Maximum length is 3.
- arrivalDate
string(optional)Destination Arrival Date. Maximum length is 21.
- departureDate
string(optional)Destination Departure Date. Maximum length is 21.
- destinationComment
string(optional)Destination Comment.
- sanctionList
string(optional)Sanction List. Maximum length is 4.
- exconProject.projectId
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"exconProjectDestId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"destinationCountryCode": "(val)",
"arrivalDate": "(val)",
"departureDate": "(val)",
"destinationComment": "(val)",
"sanctionList": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectDestId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"destinationCountryCode": "(val)",
"arrivalDate": "(val)",
"departureDate": "(val)",
"destinationComment": "(val)",
"sanctionList": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Excon Project DestinationsGET/excon/api/v1/excon-project-destinations
Example URI
GET /excon/api/v1/excon-project-destinations
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"exconProjectDestId",
"projectNumber",
"sequenceNumber",
"destinationCountryCode",
"arrivalDate",
"departureDate",
"destinationComment",
"sanctionList",
"exconProject.projectId"
],
"primaryKey": "exconProjectDestId"
}Get Blueprint API specification for Excon Project DestinationsGET/excon/api/v1/excon-project-destinations
Example URI
GET /excon/api/v1/excon-project-destinations
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Excon Project Destinations.md"
transfer-encoding: chunkedUpdate Excon Project DestinationsPUT/excon/api/v1/excon-project-destinations(key)
Example URI
PUT /excon/api/v1/excon-project-destinations(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"exconProjectDestId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"destinationCountryCode": "(val)",
"arrivalDate": "(val)",
"departureDate": "(val)",
"destinationComment": "(val)",
"sanctionList": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Excon Project DestinationsPUT/excon/api/v1/excon-project-destinations
Example URI
PUT /excon/api/v1/excon-project-destinations
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"exconProjectDestId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"destinationCountryCode": "(val)",
"arrivalDate": "(val)",
"departureDate": "(val)",
"destinationComment": "(val)",
"sanctionList": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectDestId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"destinationCountryCode": "(val)",
"arrivalDate": "(val)",
"departureDate": "(val)",
"destinationComment": "(val)",
"sanctionList": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Excon Project DestinationsPATCH/excon/api/v1/excon-project-destinations(key)
Example URI
PATCH /excon/api/v1/excon-project-destinations(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"exconProjectDestId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"destinationCountryCode": "(val)",
"arrivalDate": "(val)",
"departureDate": "(val)",
"destinationComment": "(val)",
"sanctionList": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"exconProjectDestId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"destinationCountryCode": "(val)",
"arrivalDate": "(val)",
"departureDate": "(val)",
"destinationComment": "(val)",
"sanctionList": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Insert Excon Project DestinationsPOST/excon/api/v1/excon-project-destinations
Example URI
POST /excon/api/v1/excon-project-destinations
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"exconProjectDestId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"destinationCountryCode": "(val)",
"arrivalDate": "(val)",
"departureDate": "(val)",
"destinationComment": "(val)",
"sanctionList": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"exconProjectDestId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"destinationCountryCode": "(val)",
"arrivalDate": "(val)",
"departureDate": "(val)",
"destinationComment": "(val)",
"sanctionList": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Excon Project DestinationsPOST/excon/api/v1/excon-project-destinations
Example URI
POST /excon/api/v1/excon-project-destinations
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"exconProjectDestId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"destinationCountryCode": "(val)",
"arrivalDate": "(val)",
"departureDate": "(val)",
"destinationComment": "(val)",
"sanctionList": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectDestId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"destinationCountryCode": "(val)",
"arrivalDate": "(val)",
"departureDate": "(val)",
"destinationComment": "(val)",
"sanctionList": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"exconProjectDestId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"destinationCountryCode": "(val)",
"arrivalDate": "(val)",
"departureDate": "(val)",
"destinationComment": "(val)",
"sanctionList": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectDestId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"destinationCountryCode": "(val)",
"arrivalDate": "(val)",
"departureDate": "(val)",
"destinationComment": "(val)",
"sanctionList": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}
]Delete Excon Project Destinations by KeyDELETE/excon/api/v1/excon-project-destinations(key)
Example URI
DELETE /excon/api/v1/excon-project-destinations(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project DestinationsDELETE/excon/api/v1/excon-project-destinations
Example URI
DELETE /excon/api/v1/excon-project-destinations
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project Destinations with MatchingDELETE/excon/api/v1/excon-project-destinations
Example URI
DELETE /excon/api/v1/excon-project-destinations
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- exconProjectDestId
string(optional)Export Control Destination ID. Maximum length is 22.
- projectNumber
string(optional)- sequenceNumber
string(optional)- destinationCountryCode
string(optional)Destination Country. Maximum length is 3.
- arrivalDate
string(optional)Destination Arrival Date. Maximum length is 21.
- departureDate
string(optional)Destination Departure Date. Maximum length is 21.
- destinationComment
string(optional)Destination Comment.
- sanctionList
string(optional)Sanction List. Maximum length is 4.
- exconProject.projectId
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Excon Project Documents ¶
Get Excon Project Documents by KeyGET/excon/api/v1/excon-project-documents(key)
Example URI
GET /excon/api/v1/excon-project-documents(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"documentNumber": "(val)",
"_primaryKey": "(val)"
}Get All Excon Project DocumentsGET/excon/api/v1/excon-project-documents
Example URI
GET /excon/api/v1/excon-project-documents
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"documentNumber": "(val)",
"_primaryKey": "(val)"
},
{
"documentNumber": "(val)",
"_primaryKey": "(val)"
}
]Get All Excon Project Documents with FilteringGET/excon/api/v1/excon-project-documents
Example URI
GET /excon/api/v1/excon-project-documents
URI Parameters
- documentNumber
string(optional)The document id is generated by the workflow environment and is unique to each installation of Kuali… Maximum length is 14.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"documentNumber": "(val)",
"_primaryKey": "(val)"
},
{
"documentNumber": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Excon Project DocumentsGET/excon/api/v1/excon-project-documents
Example URI
GET /excon/api/v1/excon-project-documents
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"documentNumber"
],
"primaryKey": "documentNumber"
}Get Blueprint API specification for Excon Project DocumentsGET/excon/api/v1/excon-project-documents
Example URI
GET /excon/api/v1/excon-project-documents
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Excon Project Documents.md"
transfer-encoding: chunkedUpdate Excon Project DocumentsPUT/excon/api/v1/excon-project-documents(key)
Example URI
PUT /excon/api/v1/excon-project-documents(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"documentNumber": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Excon Project DocumentsPUT/excon/api/v1/excon-project-documents
Example URI
PUT /excon/api/v1/excon-project-documents
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"documentNumber": "(val)",
"_primaryKey": "(val)"
},
{
"documentNumber": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Excon Project DocumentsPATCH/excon/api/v1/excon-project-documents(key)
Example URI
PATCH /excon/api/v1/excon-project-documents(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"documentNumber": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"documentNumber": "(val)",
"_primaryKey": "(val)"
}Insert Excon Project DocumentsPOST/excon/api/v1/excon-project-documents
Example URI
POST /excon/api/v1/excon-project-documents
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"documentNumber": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"documentNumber": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Excon Project DocumentsPOST/excon/api/v1/excon-project-documents
Example URI
POST /excon/api/v1/excon-project-documents
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"documentNumber": "(val)",
"_primaryKey": "(val)"
},
{
"documentNumber": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"documentNumber": "(val)",
"_primaryKey": "(val)"
},
{
"documentNumber": "(val)",
"_primaryKey": "(val)"
}
]Delete Excon Project Documents by KeyDELETE/excon/api/v1/excon-project-documents(key)
Example URI
DELETE /excon/api/v1/excon-project-documents(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project DocumentsDELETE/excon/api/v1/excon-project-documents
Example URI
DELETE /excon/api/v1/excon-project-documents
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project Documents with MatchingDELETE/excon/api/v1/excon-project-documents
Example URI
DELETE /excon/api/v1/excon-project-documents
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- documentNumber
string(optional)The document id is generated by the workflow environment and is unique to each installation of Kuali… Maximum length is 14.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Excon Project Email Contents ¶
Get Excon Project Email Contents by KeyGET/excon/api/v1/excon-project-email-contents(key)
Example URI
GET /excon/api/v1/excon-project-email-contents(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"contentCode": "(val)",
"description": "(val)",
"contentTypeCode": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"attachmentContent": "(val)",
"_primaryKey": "(val)"
}Get All Excon Project Email ContentsGET/excon/api/v1/excon-project-email-contents
Example URI
GET /excon/api/v1/excon-project-email-contents
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"contentCode": "(val)",
"description": "(val)",
"contentTypeCode": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"attachmentContent": "(val)",
"_primaryKey": "(val)"
},
{
"contentCode": "(val)",
"description": "(val)",
"contentTypeCode": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"attachmentContent": "(val)",
"_primaryKey": "(val)"
}
]Get All Excon Project Email Contents with FilteringGET/excon/api/v1/excon-project-email-contents
Example URI
GET /excon/api/v1/excon-project-email-contents
URI Parameters
- contentCode
string(optional)Content Code. Maximum length is 20.
- description
string(optional)Description. Maximum length is 200.
- contentTypeCode
string(optional)contentTypeCode. Maximum length is 5.
- fileName
string(optional)- contentType
string(optional)- attachmentContent
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"contentCode": "(val)",
"description": "(val)",
"contentTypeCode": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"attachmentContent": "(val)",
"_primaryKey": "(val)"
},
{
"contentCode": "(val)",
"description": "(val)",
"contentTypeCode": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"attachmentContent": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Excon Project Email ContentsGET/excon/api/v1/excon-project-email-contents
Example URI
GET /excon/api/v1/excon-project-email-contents
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"contentCode",
"description",
"contentTypeCode",
"fileName",
"contentType",
"attachmentContent"
],
"primaryKey": "contentCode"
}Get Blueprint API specification for Excon Project Email ContentsGET/excon/api/v1/excon-project-email-contents
Example URI
GET /excon/api/v1/excon-project-email-contents
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Excon Project Email Contents.md"
transfer-encoding: chunkedUpdate Excon Project Email ContentsPUT/excon/api/v1/excon-project-email-contents(key)
Example URI
PUT /excon/api/v1/excon-project-email-contents(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"contentCode": "(val)",
"description": "(val)",
"contentTypeCode": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"attachmentContent": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Excon Project Email ContentsPUT/excon/api/v1/excon-project-email-contents
Example URI
PUT /excon/api/v1/excon-project-email-contents
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"contentCode": "(val)",
"description": "(val)",
"contentTypeCode": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"attachmentContent": "(val)",
"_primaryKey": "(val)"
},
{
"contentCode": "(val)",
"description": "(val)",
"contentTypeCode": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"attachmentContent": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Excon Project Email ContentsPATCH/excon/api/v1/excon-project-email-contents(key)
Example URI
PATCH /excon/api/v1/excon-project-email-contents(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"contentCode": "(val)",
"description": "(val)",
"contentTypeCode": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"attachmentContent": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"contentCode": "(val)",
"description": "(val)",
"contentTypeCode": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"attachmentContent": "(val)",
"_primaryKey": "(val)"
}Insert Excon Project Email ContentsPOST/excon/api/v1/excon-project-email-contents
Example URI
POST /excon/api/v1/excon-project-email-contents
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"contentCode": "(val)",
"description": "(val)",
"contentTypeCode": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"attachmentContent": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"contentCode": "(val)",
"description": "(val)",
"contentTypeCode": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"attachmentContent": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Excon Project Email ContentsPOST/excon/api/v1/excon-project-email-contents
Example URI
POST /excon/api/v1/excon-project-email-contents
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"contentCode": "(val)",
"description": "(val)",
"contentTypeCode": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"attachmentContent": "(val)",
"_primaryKey": "(val)"
},
{
"contentCode": "(val)",
"description": "(val)",
"contentTypeCode": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"attachmentContent": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"contentCode": "(val)",
"description": "(val)",
"contentTypeCode": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"attachmentContent": "(val)",
"_primaryKey": "(val)"
},
{
"contentCode": "(val)",
"description": "(val)",
"contentTypeCode": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"attachmentContent": "(val)",
"_primaryKey": "(val)"
}
]Delete Excon Project Email Contents by KeyDELETE/excon/api/v1/excon-project-email-contents(key)
Example URI
DELETE /excon/api/v1/excon-project-email-contents(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project Email ContentsDELETE/excon/api/v1/excon-project-email-contents
Example URI
DELETE /excon/api/v1/excon-project-email-contents
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project Email Contents with MatchingDELETE/excon/api/v1/excon-project-email-contents
Example URI
DELETE /excon/api/v1/excon-project-email-contents
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- contentCode
string(optional)Content Code. Maximum length is 20.
- description
string(optional)Description. Maximum length is 200.
- contentTypeCode
string(optional)contentTypeCode. Maximum length is 5.
- fileName
string(optional)- contentType
string(optional)- attachmentContent
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Excon Project Event Types ¶
Get Excon Project Event Types by KeyGET/excon/api/v1/excon-project-event-types(key)
Example URI
GET /excon/api/v1/excon-project-event-types(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"exconProjectEventTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Excon Project Event TypesGET/excon/api/v1/excon-project-event-types
Example URI
GET /excon/api/v1/excon-project-event-types
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"exconProjectEventTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectEventTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Excon Project Event Types with FilteringGET/excon/api/v1/excon-project-event-types
Example URI
GET /excon/api/v1/excon-project-event-types
URI Parameters
- exconProjectEventTypeCode
string(optional)Export Control Project Event Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"exconProjectEventTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectEventTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Excon Project Event TypesGET/excon/api/v1/excon-project-event-types
Example URI
GET /excon/api/v1/excon-project-event-types
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"exconProjectEventTypeCode",
"description"
],
"primaryKey": "exconProjectEventTypeCode"
}Get Blueprint API specification for Excon Project Event TypesGET/excon/api/v1/excon-project-event-types
Example URI
GET /excon/api/v1/excon-project-event-types
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Excon Project Event Types.md"
transfer-encoding: chunkedUpdate Excon Project Event TypesPUT/excon/api/v1/excon-project-event-types(key)
Example URI
PUT /excon/api/v1/excon-project-event-types(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"exconProjectEventTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Excon Project Event TypesPUT/excon/api/v1/excon-project-event-types
Example URI
PUT /excon/api/v1/excon-project-event-types
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"exconProjectEventTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectEventTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Excon Project Event TypesPATCH/excon/api/v1/excon-project-event-types(key)
Example URI
PATCH /excon/api/v1/excon-project-event-types(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"exconProjectEventTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"exconProjectEventTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Excon Project Event TypesPOST/excon/api/v1/excon-project-event-types
Example URI
POST /excon/api/v1/excon-project-event-types
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"exconProjectEventTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"exconProjectEventTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Excon Project Event TypesPOST/excon/api/v1/excon-project-event-types
Example URI
POST /excon/api/v1/excon-project-event-types
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"exconProjectEventTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectEventTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"exconProjectEventTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectEventTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Excon Project Event Types by KeyDELETE/excon/api/v1/excon-project-event-types(key)
Example URI
DELETE /excon/api/v1/excon-project-event-types(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project Event TypesDELETE/excon/api/v1/excon-project-event-types
Example URI
DELETE /excon/api/v1/excon-project-event-types
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project Event Types with MatchingDELETE/excon/api/v1/excon-project-event-types
Example URI
DELETE /excon/api/v1/excon-project-event-types
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- exconProjectEventTypeCode
string(optional)Export Control Project Event Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Excon Project Events ¶
Get Excon Project Events by KeyGET/excon/api/v1/excon-project-events(key)
Example URI
GET /excon/api/v1/excon-project-events(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"exconProjectEventId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"projectEventTypeCode": "(val)",
"eventDate": "(val)",
"eventComment": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Get All Excon Project EventsGET/excon/api/v1/excon-project-events
Example URI
GET /excon/api/v1/excon-project-events
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"exconProjectEventId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"projectEventTypeCode": "(val)",
"eventDate": "(val)",
"eventComment": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectEventId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"projectEventTypeCode": "(val)",
"eventDate": "(val)",
"eventComment": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}
]Get All Excon Project Events with FilteringGET/excon/api/v1/excon-project-events
Example URI
GET /excon/api/v1/excon-project-events
URI Parameters
- exconProjectEventId
string(optional)Export Control Event ID. Maximum length is 22.
- projectNumber
string(optional)- sequenceNumber
string(optional)- projectEventTypeCode
string(optional)Project Event Type. Maximum length is 3.
- eventDate
string(optional)Project Event Date. Maximum length is 21.
- eventComment
string(optional)Event Comment.
- exconProject.projectId
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"exconProjectEventId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"projectEventTypeCode": "(val)",
"eventDate": "(val)",
"eventComment": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectEventId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"projectEventTypeCode": "(val)",
"eventDate": "(val)",
"eventComment": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Excon Project EventsGET/excon/api/v1/excon-project-events
Example URI
GET /excon/api/v1/excon-project-events
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"exconProjectEventId",
"projectNumber",
"sequenceNumber",
"projectEventTypeCode",
"eventDate",
"eventComment",
"exconProject.projectId"
],
"primaryKey": "exconProjectEventId"
}Get Blueprint API specification for Excon Project EventsGET/excon/api/v1/excon-project-events
Example URI
GET /excon/api/v1/excon-project-events
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Excon Project Events.md"
transfer-encoding: chunkedUpdate Excon Project EventsPUT/excon/api/v1/excon-project-events(key)
Example URI
PUT /excon/api/v1/excon-project-events(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"exconProjectEventId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"projectEventTypeCode": "(val)",
"eventDate": "(val)",
"eventComment": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Excon Project EventsPUT/excon/api/v1/excon-project-events
Example URI
PUT /excon/api/v1/excon-project-events
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"exconProjectEventId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"projectEventTypeCode": "(val)",
"eventDate": "(val)",
"eventComment": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectEventId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"projectEventTypeCode": "(val)",
"eventDate": "(val)",
"eventComment": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Excon Project EventsPATCH/excon/api/v1/excon-project-events(key)
Example URI
PATCH /excon/api/v1/excon-project-events(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"exconProjectEventId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"projectEventTypeCode": "(val)",
"eventDate": "(val)",
"eventComment": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"exconProjectEventId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"projectEventTypeCode": "(val)",
"eventDate": "(val)",
"eventComment": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Insert Excon Project EventsPOST/excon/api/v1/excon-project-events
Example URI
POST /excon/api/v1/excon-project-events
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"exconProjectEventId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"projectEventTypeCode": "(val)",
"eventDate": "(val)",
"eventComment": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"exconProjectEventId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"projectEventTypeCode": "(val)",
"eventDate": "(val)",
"eventComment": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Excon Project EventsPOST/excon/api/v1/excon-project-events
Example URI
POST /excon/api/v1/excon-project-events
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"exconProjectEventId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"projectEventTypeCode": "(val)",
"eventDate": "(val)",
"eventComment": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectEventId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"projectEventTypeCode": "(val)",
"eventDate": "(val)",
"eventComment": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"exconProjectEventId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"projectEventTypeCode": "(val)",
"eventDate": "(val)",
"eventComment": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectEventId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"projectEventTypeCode": "(val)",
"eventDate": "(val)",
"eventComment": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}
]Delete Excon Project Events by KeyDELETE/excon/api/v1/excon-project-events(key)
Example URI
DELETE /excon/api/v1/excon-project-events(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project EventsDELETE/excon/api/v1/excon-project-events
Example URI
DELETE /excon/api/v1/excon-project-events
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project Events with MatchingDELETE/excon/api/v1/excon-project-events
Example URI
DELETE /excon/api/v1/excon-project-events
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- exconProjectEventId
string(optional)Export Control Event ID. Maximum length is 22.
- projectNumber
string(optional)- sequenceNumber
string(optional)- projectEventTypeCode
string(optional)Project Event Type. Maximum length is 3.
- eventDate
string(optional)Project Event Date. Maximum length is 21.
- eventComment
string(optional)Event Comment.
- exconProject.projectId
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Excon Project External Institutions ¶
Get Excon Project External Institutions by KeyGET/excon/api/v1/excon-project-external-institutions(key)
Example URI
GET /excon/api/v1/excon-project-external-institutions(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"projectExternalInstitutionId": "(val)",
"rolodexId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Get All Excon Project External InstitutionsGET/excon/api/v1/excon-project-external-institutions
Example URI
GET /excon/api/v1/excon-project-external-institutions
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"projectExternalInstitutionId": "(val)",
"rolodexId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
},
{
"projectExternalInstitutionId": "(val)",
"rolodexId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}
]Get All Excon Project External Institutions with FilteringGET/excon/api/v1/excon-project-external-institutions
Example URI
GET /excon/api/v1/excon-project-external-institutions
URI Parameters
- projectExternalInstitutionId
string(optional)Export Control Unit ExternalInstitution ID. Maximum length is 22.
- rolodexId
string(optional)External Institution. Maximum length is 6.
- projectNumber
string(optional)- sequenceNumber
string(optional)- exconProject.projectId
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"projectExternalInstitutionId": "(val)",
"rolodexId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
},
{
"projectExternalInstitutionId": "(val)",
"rolodexId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Excon Project External InstitutionsGET/excon/api/v1/excon-project-external-institutions
Example URI
GET /excon/api/v1/excon-project-external-institutions
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"projectExternalInstitutionId",
"rolodexId",
"projectNumber",
"sequenceNumber",
"exconProject.projectId"
],
"primaryKey": "projectExternalInstitutionId"
}Get Blueprint API specification for Excon Project External InstitutionsGET/excon/api/v1/excon-project-external-institutions
Example URI
GET /excon/api/v1/excon-project-external-institutions
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Excon Project External Institutions.md"
transfer-encoding: chunkedUpdate Excon Project External InstitutionsPUT/excon/api/v1/excon-project-external-institutions(key)
Example URI
PUT /excon/api/v1/excon-project-external-institutions(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"projectExternalInstitutionId": "(val)",
"rolodexId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Excon Project External InstitutionsPUT/excon/api/v1/excon-project-external-institutions
Example URI
PUT /excon/api/v1/excon-project-external-institutions
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"projectExternalInstitutionId": "(val)",
"rolodexId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
},
{
"projectExternalInstitutionId": "(val)",
"rolodexId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Excon Project External InstitutionsPATCH/excon/api/v1/excon-project-external-institutions(key)
Example URI
PATCH /excon/api/v1/excon-project-external-institutions(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"projectExternalInstitutionId": "(val)",
"rolodexId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"projectExternalInstitutionId": "(val)",
"rolodexId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Insert Excon Project External InstitutionsPOST/excon/api/v1/excon-project-external-institutions
Example URI
POST /excon/api/v1/excon-project-external-institutions
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"projectExternalInstitutionId": "(val)",
"rolodexId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"projectExternalInstitutionId": "(val)",
"rolodexId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Excon Project External InstitutionsPOST/excon/api/v1/excon-project-external-institutions
Example URI
POST /excon/api/v1/excon-project-external-institutions
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"projectExternalInstitutionId": "(val)",
"rolodexId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
},
{
"projectExternalInstitutionId": "(val)",
"rolodexId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"projectExternalInstitutionId": "(val)",
"rolodexId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
},
{
"projectExternalInstitutionId": "(val)",
"rolodexId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}
]Delete Excon Project External Institutions by KeyDELETE/excon/api/v1/excon-project-external-institutions(key)
Example URI
DELETE /excon/api/v1/excon-project-external-institutions(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project External InstitutionsDELETE/excon/api/v1/excon-project-external-institutions
Example URI
DELETE /excon/api/v1/excon-project-external-institutions
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project External Institutions with MatchingDELETE/excon/api/v1/excon-project-external-institutions
Example URI
DELETE /excon/api/v1/excon-project-external-institutions
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- projectExternalInstitutionId
string(optional)Export Control Unit ExternalInstitution ID. Maximum length is 22.
- rolodexId
string(optional)External Institution. Maximum length is 6.
- projectNumber
string(optional)- sequenceNumber
string(optional)- exconProject.projectId
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Excon Project H R Extensions ¶
Get Excon Project H R Extensions by KeyGET/excon/api/v1/excon-project-h-r-extensions(key)
Example URI
GET /excon/api/v1/excon-project-h-r-extensions(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"projectId": "(val)",
"requestType": "(val)",
"employeeType": "(val)",
"jobCode": "(val)",
"bcResult": "(val)",
"bcStatus": "(val)",
"selfDisclosed": "(val)",
"criminalDiscrepancy": "(val)",
"criminalOffenses": "(val)",
"mvrDiscrepancy": "(val)",
"notes": "(val)",
"contact": "(val)",
"criminalCheck": "(val)",
"criminalPrevious": "(val)",
"mvrCheck": "(val)",
"mvrPrevious": "(val)",
"stateCheck": "(val)",
"creditCheck": "(val)",
"sexOffenderCheck": "(val)",
"educationCheck": "(val)",
"ssnNoData": "(val)",
"hardCopyReq": "(val)",
"candDispute": "(val)",
"rerunReason": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}Get All Excon Project H R ExtensionsGET/excon/api/v1/excon-project-h-r-extensions
Example URI
GET /excon/api/v1/excon-project-h-r-extensions
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"projectId": "(val)",
"requestType": "(val)",
"employeeType": "(val)",
"jobCode": "(val)",
"bcResult": "(val)",
"bcStatus": "(val)",
"selfDisclosed": "(val)",
"criminalDiscrepancy": "(val)",
"criminalOffenses": "(val)",
"mvrDiscrepancy": "(val)",
"notes": "(val)",
"contact": "(val)",
"criminalCheck": "(val)",
"criminalPrevious": "(val)",
"mvrCheck": "(val)",
"mvrPrevious": "(val)",
"stateCheck": "(val)",
"creditCheck": "(val)",
"sexOffenderCheck": "(val)",
"educationCheck": "(val)",
"ssnNoData": "(val)",
"hardCopyReq": "(val)",
"candDispute": "(val)",
"rerunReason": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
},
{
"projectId": "(val)",
"requestType": "(val)",
"employeeType": "(val)",
"jobCode": "(val)",
"bcResult": "(val)",
"bcStatus": "(val)",
"selfDisclosed": "(val)",
"criminalDiscrepancy": "(val)",
"criminalOffenses": "(val)",
"mvrDiscrepancy": "(val)",
"notes": "(val)",
"contact": "(val)",
"criminalCheck": "(val)",
"criminalPrevious": "(val)",
"mvrCheck": "(val)",
"mvrPrevious": "(val)",
"stateCheck": "(val)",
"creditCheck": "(val)",
"sexOffenderCheck": "(val)",
"educationCheck": "(val)",
"ssnNoData": "(val)",
"hardCopyReq": "(val)",
"candDispute": "(val)",
"rerunReason": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}
]Get All Excon Project H R Extensions with FilteringGET/excon/api/v1/excon-project-h-r-extensions
Example URI
GET /excon/api/v1/excon-project-h-r-extensions
URI Parameters
- projectId
string(optional)- requestType
string(optional)Request Type. Maximum length is 3.
- employeeType
string(optional)Employee Type. Maximum length is 3.
- jobCode
string(optional)Job Code. Maximum length is 6.
- bcResult
string(optional)Background Check Result. Maximum length is 3.
- bcStatus
string(optional)Background Check Status. Maximum length is 3.
- selfDisclosed
string(optional)Self Disclosed. Maximum length is 3.
- criminalDiscrepancy
string(optional)Criminal Discrepancy.
- criminalOffenses
string(optional)Criminal Offenses.
- mvrDiscrepancy
string(optional)MVR Discrepancy.
- notes
string(optional)Notes.
- contact
string(optional)Contact. Maximum length is 80.
- criminalCheck
string(optional)Criminal Check. Maximum length is 1.
- criminalPrevious
string(optional)Criminal Previous. Maximum length is 1.
- mvrCheck
string(optional)MVR Check. Maximum length is 1.
- mvrPrevious
string(optional)MVR Previous. Maximum length is 1.
- stateCheck
string(optional)State Check. Maximum length is 1.
- creditCheck
string(optional)Credit Check. Maximum length is 1.
- sexOffenderCheck
string(optional)Sex Offender Check. Maximum length is 1.
- educationCheck
string(optional)Education Check. Maximum length is 1.
- ssnNoData
string(optional)SSN No Data. Maximum length is 1.
- hardCopyReq
string(optional)Hard Copy Request. Maximum length is 1.
- candDispute
string(optional)Candidate Dispute. Maximum length is 1.
- rerunReason
string(optional)Rerun Reason. Maximum length is 3.
- projectNumber
string(optional)- sequenceNumber
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"projectId": "(val)",
"requestType": "(val)",
"employeeType": "(val)",
"jobCode": "(val)",
"bcResult": "(val)",
"bcStatus": "(val)",
"selfDisclosed": "(val)",
"criminalDiscrepancy": "(val)",
"criminalOffenses": "(val)",
"mvrDiscrepancy": "(val)",
"notes": "(val)",
"contact": "(val)",
"criminalCheck": "(val)",
"criminalPrevious": "(val)",
"mvrCheck": "(val)",
"mvrPrevious": "(val)",
"stateCheck": "(val)",
"creditCheck": "(val)",
"sexOffenderCheck": "(val)",
"educationCheck": "(val)",
"ssnNoData": "(val)",
"hardCopyReq": "(val)",
"candDispute": "(val)",
"rerunReason": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
},
{
"projectId": "(val)",
"requestType": "(val)",
"employeeType": "(val)",
"jobCode": "(val)",
"bcResult": "(val)",
"bcStatus": "(val)",
"selfDisclosed": "(val)",
"criminalDiscrepancy": "(val)",
"criminalOffenses": "(val)",
"mvrDiscrepancy": "(val)",
"notes": "(val)",
"contact": "(val)",
"criminalCheck": "(val)",
"criminalPrevious": "(val)",
"mvrCheck": "(val)",
"mvrPrevious": "(val)",
"stateCheck": "(val)",
"creditCheck": "(val)",
"sexOffenderCheck": "(val)",
"educationCheck": "(val)",
"ssnNoData": "(val)",
"hardCopyReq": "(val)",
"candDispute": "(val)",
"rerunReason": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Excon Project H R ExtensionsGET/excon/api/v1/excon-project-h-r-extensions
Example URI
GET /excon/api/v1/excon-project-h-r-extensions
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"projectId",
"requestType",
"employeeType",
"jobCode",
"bcResult",
"bcStatus",
"selfDisclosed",
"criminalDiscrepancy",
"criminalOffenses",
"mvrDiscrepancy",
"notes",
"contact",
"criminalCheck",
"criminalPrevious",
"mvrCheck",
"mvrPrevious",
"stateCheck",
"creditCheck",
"sexOffenderCheck",
"educationCheck",
"ssnNoData",
"hardCopyReq",
"candDispute",
"rerunReason",
"projectNumber",
"sequenceNumber"
],
"primaryKey": "projectId"
}Get Blueprint API specification for Excon Project H R ExtensionsGET/excon/api/v1/excon-project-h-r-extensions
Example URI
GET /excon/api/v1/excon-project-h-r-extensions
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Excon Project H R Extensions.md"
transfer-encoding: chunkedUpdate Excon Project H R ExtensionsPUT/excon/api/v1/excon-project-h-r-extensions(key)
Example URI
PUT /excon/api/v1/excon-project-h-r-extensions(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"projectId": "(val)",
"requestType": "(val)",
"employeeType": "(val)",
"jobCode": "(val)",
"bcResult": "(val)",
"bcStatus": "(val)",
"selfDisclosed": "(val)",
"criminalDiscrepancy": "(val)",
"criminalOffenses": "(val)",
"mvrDiscrepancy": "(val)",
"notes": "(val)",
"contact": "(val)",
"criminalCheck": "(val)",
"criminalPrevious": "(val)",
"mvrCheck": "(val)",
"mvrPrevious": "(val)",
"stateCheck": "(val)",
"creditCheck": "(val)",
"sexOffenderCheck": "(val)",
"educationCheck": "(val)",
"ssnNoData": "(val)",
"hardCopyReq": "(val)",
"candDispute": "(val)",
"rerunReason": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Excon Project H R ExtensionsPUT/excon/api/v1/excon-project-h-r-extensions
Example URI
PUT /excon/api/v1/excon-project-h-r-extensions
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"projectId": "(val)",
"requestType": "(val)",
"employeeType": "(val)",
"jobCode": "(val)",
"bcResult": "(val)",
"bcStatus": "(val)",
"selfDisclosed": "(val)",
"criminalDiscrepancy": "(val)",
"criminalOffenses": "(val)",
"mvrDiscrepancy": "(val)",
"notes": "(val)",
"contact": "(val)",
"criminalCheck": "(val)",
"criminalPrevious": "(val)",
"mvrCheck": "(val)",
"mvrPrevious": "(val)",
"stateCheck": "(val)",
"creditCheck": "(val)",
"sexOffenderCheck": "(val)",
"educationCheck": "(val)",
"ssnNoData": "(val)",
"hardCopyReq": "(val)",
"candDispute": "(val)",
"rerunReason": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
},
{
"projectId": "(val)",
"requestType": "(val)",
"employeeType": "(val)",
"jobCode": "(val)",
"bcResult": "(val)",
"bcStatus": "(val)",
"selfDisclosed": "(val)",
"criminalDiscrepancy": "(val)",
"criminalOffenses": "(val)",
"mvrDiscrepancy": "(val)",
"notes": "(val)",
"contact": "(val)",
"criminalCheck": "(val)",
"criminalPrevious": "(val)",
"mvrCheck": "(val)",
"mvrPrevious": "(val)",
"stateCheck": "(val)",
"creditCheck": "(val)",
"sexOffenderCheck": "(val)",
"educationCheck": "(val)",
"ssnNoData": "(val)",
"hardCopyReq": "(val)",
"candDispute": "(val)",
"rerunReason": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Excon Project H R ExtensionsPATCH/excon/api/v1/excon-project-h-r-extensions(key)
Example URI
PATCH /excon/api/v1/excon-project-h-r-extensions(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"projectId": "(val)",
"requestType": "(val)",
"employeeType": "(val)",
"jobCode": "(val)",
"bcResult": "(val)",
"bcStatus": "(val)",
"selfDisclosed": "(val)",
"criminalDiscrepancy": "(val)",
"criminalOffenses": "(val)",
"mvrDiscrepancy": "(val)",
"notes": "(val)",
"contact": "(val)",
"criminalCheck": "(val)",
"criminalPrevious": "(val)",
"mvrCheck": "(val)",
"mvrPrevious": "(val)",
"stateCheck": "(val)",
"creditCheck": "(val)",
"sexOffenderCheck": "(val)",
"educationCheck": "(val)",
"ssnNoData": "(val)",
"hardCopyReq": "(val)",
"candDispute": "(val)",
"rerunReason": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"projectId": "(val)",
"requestType": "(val)",
"employeeType": "(val)",
"jobCode": "(val)",
"bcResult": "(val)",
"bcStatus": "(val)",
"selfDisclosed": "(val)",
"criminalDiscrepancy": "(val)",
"criminalOffenses": "(val)",
"mvrDiscrepancy": "(val)",
"notes": "(val)",
"contact": "(val)",
"criminalCheck": "(val)",
"criminalPrevious": "(val)",
"mvrCheck": "(val)",
"mvrPrevious": "(val)",
"stateCheck": "(val)",
"creditCheck": "(val)",
"sexOffenderCheck": "(val)",
"educationCheck": "(val)",
"ssnNoData": "(val)",
"hardCopyReq": "(val)",
"candDispute": "(val)",
"rerunReason": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}Insert Excon Project H R ExtensionsPOST/excon/api/v1/excon-project-h-r-extensions
Example URI
POST /excon/api/v1/excon-project-h-r-extensions
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"projectId": "(val)",
"requestType": "(val)",
"employeeType": "(val)",
"jobCode": "(val)",
"bcResult": "(val)",
"bcStatus": "(val)",
"selfDisclosed": "(val)",
"criminalDiscrepancy": "(val)",
"criminalOffenses": "(val)",
"mvrDiscrepancy": "(val)",
"notes": "(val)",
"contact": "(val)",
"criminalCheck": "(val)",
"criminalPrevious": "(val)",
"mvrCheck": "(val)",
"mvrPrevious": "(val)",
"stateCheck": "(val)",
"creditCheck": "(val)",
"sexOffenderCheck": "(val)",
"educationCheck": "(val)",
"ssnNoData": "(val)",
"hardCopyReq": "(val)",
"candDispute": "(val)",
"rerunReason": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"projectId": "(val)",
"requestType": "(val)",
"employeeType": "(val)",
"jobCode": "(val)",
"bcResult": "(val)",
"bcStatus": "(val)",
"selfDisclosed": "(val)",
"criminalDiscrepancy": "(val)",
"criminalOffenses": "(val)",
"mvrDiscrepancy": "(val)",
"notes": "(val)",
"contact": "(val)",
"criminalCheck": "(val)",
"criminalPrevious": "(val)",
"mvrCheck": "(val)",
"mvrPrevious": "(val)",
"stateCheck": "(val)",
"creditCheck": "(val)",
"sexOffenderCheck": "(val)",
"educationCheck": "(val)",
"ssnNoData": "(val)",
"hardCopyReq": "(val)",
"candDispute": "(val)",
"rerunReason": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Excon Project H R ExtensionsPOST/excon/api/v1/excon-project-h-r-extensions
Example URI
POST /excon/api/v1/excon-project-h-r-extensions
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"projectId": "(val)",
"requestType": "(val)",
"employeeType": "(val)",
"jobCode": "(val)",
"bcResult": "(val)",
"bcStatus": "(val)",
"selfDisclosed": "(val)",
"criminalDiscrepancy": "(val)",
"criminalOffenses": "(val)",
"mvrDiscrepancy": "(val)",
"notes": "(val)",
"contact": "(val)",
"criminalCheck": "(val)",
"criminalPrevious": "(val)",
"mvrCheck": "(val)",
"mvrPrevious": "(val)",
"stateCheck": "(val)",
"creditCheck": "(val)",
"sexOffenderCheck": "(val)",
"educationCheck": "(val)",
"ssnNoData": "(val)",
"hardCopyReq": "(val)",
"candDispute": "(val)",
"rerunReason": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
},
{
"projectId": "(val)",
"requestType": "(val)",
"employeeType": "(val)",
"jobCode": "(val)",
"bcResult": "(val)",
"bcStatus": "(val)",
"selfDisclosed": "(val)",
"criminalDiscrepancy": "(val)",
"criminalOffenses": "(val)",
"mvrDiscrepancy": "(val)",
"notes": "(val)",
"contact": "(val)",
"criminalCheck": "(val)",
"criminalPrevious": "(val)",
"mvrCheck": "(val)",
"mvrPrevious": "(val)",
"stateCheck": "(val)",
"creditCheck": "(val)",
"sexOffenderCheck": "(val)",
"educationCheck": "(val)",
"ssnNoData": "(val)",
"hardCopyReq": "(val)",
"candDispute": "(val)",
"rerunReason": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"projectId": "(val)",
"requestType": "(val)",
"employeeType": "(val)",
"jobCode": "(val)",
"bcResult": "(val)",
"bcStatus": "(val)",
"selfDisclosed": "(val)",
"criminalDiscrepancy": "(val)",
"criminalOffenses": "(val)",
"mvrDiscrepancy": "(val)",
"notes": "(val)",
"contact": "(val)",
"criminalCheck": "(val)",
"criminalPrevious": "(val)",
"mvrCheck": "(val)",
"mvrPrevious": "(val)",
"stateCheck": "(val)",
"creditCheck": "(val)",
"sexOffenderCheck": "(val)",
"educationCheck": "(val)",
"ssnNoData": "(val)",
"hardCopyReq": "(val)",
"candDispute": "(val)",
"rerunReason": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
},
{
"projectId": "(val)",
"requestType": "(val)",
"employeeType": "(val)",
"jobCode": "(val)",
"bcResult": "(val)",
"bcStatus": "(val)",
"selfDisclosed": "(val)",
"criminalDiscrepancy": "(val)",
"criminalOffenses": "(val)",
"mvrDiscrepancy": "(val)",
"notes": "(val)",
"contact": "(val)",
"criminalCheck": "(val)",
"criminalPrevious": "(val)",
"mvrCheck": "(val)",
"mvrPrevious": "(val)",
"stateCheck": "(val)",
"creditCheck": "(val)",
"sexOffenderCheck": "(val)",
"educationCheck": "(val)",
"ssnNoData": "(val)",
"hardCopyReq": "(val)",
"candDispute": "(val)",
"rerunReason": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}
]Delete Excon Project H R Extensions by KeyDELETE/excon/api/v1/excon-project-h-r-extensions(key)
Example URI
DELETE /excon/api/v1/excon-project-h-r-extensions(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project H R ExtensionsDELETE/excon/api/v1/excon-project-h-r-extensions
Example URI
DELETE /excon/api/v1/excon-project-h-r-extensions
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project H R Extensions with MatchingDELETE/excon/api/v1/excon-project-h-r-extensions
Example URI
DELETE /excon/api/v1/excon-project-h-r-extensions
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- projectId
string(optional)- requestType
string(optional)Request Type. Maximum length is 3.
- employeeType
string(optional)Employee Type. Maximum length is 3.
- jobCode
string(optional)Job Code. Maximum length is 6.
- bcResult
string(optional)Background Check Result. Maximum length is 3.
- bcStatus
string(optional)Background Check Status. Maximum length is 3.
- selfDisclosed
string(optional)Self Disclosed. Maximum length is 3.
- criminalDiscrepancy
string(optional)Criminal Discrepancy.
- criminalOffenses
string(optional)Criminal Offenses.
- mvrDiscrepancy
string(optional)MVR Discrepancy.
- notes
string(optional)Notes.
- contact
string(optional)Contact. Maximum length is 80.
- criminalCheck
string(optional)Criminal Check. Maximum length is 1.
- criminalPrevious
string(optional)Criminal Previous. Maximum length is 1.
- mvrCheck
string(optional)MVR Check. Maximum length is 1.
- mvrPrevious
string(optional)MVR Previous. Maximum length is 1.
- stateCheck
string(optional)State Check. Maximum length is 1.
- creditCheck
string(optional)Credit Check. Maximum length is 1.
- sexOffenderCheck
string(optional)Sex Offender Check. Maximum length is 1.
- educationCheck
string(optional)Education Check. Maximum length is 1.
- ssnNoData
string(optional)SSN No Data. Maximum length is 1.
- hardCopyReq
string(optional)Hard Copy Request. Maximum length is 1.
- candDispute
string(optional)Candidate Dispute. Maximum length is 1.
- rerunReason
string(optional)Rerun Reason. Maximum length is 3.
- projectNumber
string(optional)- sequenceNumber
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Excon Project Person Role Types ¶
Get Excon Project Person Role Types by KeyGET/excon/api/v1/excon-project-person-role-types(key)
Example URI
GET /excon/api/v1/excon-project-person-role-types(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"exconProjectPersonRoleTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Excon Project Person Role TypesGET/excon/api/v1/excon-project-person-role-types
Example URI
GET /excon/api/v1/excon-project-person-role-types
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"exconProjectPersonRoleTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectPersonRoleTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Excon Project Person Role Types with FilteringGET/excon/api/v1/excon-project-person-role-types
Example URI
GET /excon/api/v1/excon-project-person-role-types
URI Parameters
- exconProjectPersonRoleTypeCode
string(optional)Export Control Project Person Role Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"exconProjectPersonRoleTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectPersonRoleTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Excon Project Person Role TypesGET/excon/api/v1/excon-project-person-role-types
Example URI
GET /excon/api/v1/excon-project-person-role-types
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"exconProjectPersonRoleTypeCode",
"description"
],
"primaryKey": "exconProjectPersonRoleTypeCode"
}Get Blueprint API specification for Excon Project Person Role TypesGET/excon/api/v1/excon-project-person-role-types
Example URI
GET /excon/api/v1/excon-project-person-role-types
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Excon Project Person Role Types.md"
transfer-encoding: chunkedUpdate Excon Project Person Role TypesPUT/excon/api/v1/excon-project-person-role-types(key)
Example URI
PUT /excon/api/v1/excon-project-person-role-types(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"exconProjectPersonRoleTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Excon Project Person Role TypesPUT/excon/api/v1/excon-project-person-role-types
Example URI
PUT /excon/api/v1/excon-project-person-role-types
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"exconProjectPersonRoleTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectPersonRoleTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Excon Project Person Role TypesPATCH/excon/api/v1/excon-project-person-role-types(key)
Example URI
PATCH /excon/api/v1/excon-project-person-role-types(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"exconProjectPersonRoleTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"exconProjectPersonRoleTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Excon Project Person Role TypesPOST/excon/api/v1/excon-project-person-role-types
Example URI
POST /excon/api/v1/excon-project-person-role-types
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"exconProjectPersonRoleTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"exconProjectPersonRoleTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Excon Project Person Role TypesPOST/excon/api/v1/excon-project-person-role-types
Example URI
POST /excon/api/v1/excon-project-person-role-types
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"exconProjectPersonRoleTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectPersonRoleTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"exconProjectPersonRoleTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectPersonRoleTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Excon Project Person Role Types by KeyDELETE/excon/api/v1/excon-project-person-role-types(key)
Example URI
DELETE /excon/api/v1/excon-project-person-role-types(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project Person Role TypesDELETE/excon/api/v1/excon-project-person-role-types
Example URI
DELETE /excon/api/v1/excon-project-person-role-types
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project Person Role Types with MatchingDELETE/excon/api/v1/excon-project-person-role-types
Example URI
DELETE /excon/api/v1/excon-project-person-role-types
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- exconProjectPersonRoleTypeCode
string(optional)Export Control Project Person Role Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Excon Project Persons ¶
Get Excon Project Persons by KeyGET/excon/api/v1/excon-project-persons(key)
Example URI
GET /excon/api/v1/excon-project-persons(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"exconProjectPersonId": "(val)",
"personId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"rolodexId": "(val)",
"fullName": "(val)",
"roleTypeCode": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Get All Excon Project PersonsGET/excon/api/v1/excon-project-persons
Example URI
GET /excon/api/v1/excon-project-persons
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"exconProjectPersonId": "(val)",
"personId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"rolodexId": "(val)",
"fullName": "(val)",
"roleTypeCode": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectPersonId": "(val)",
"personId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"rolodexId": "(val)",
"fullName": "(val)",
"roleTypeCode": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}
]Get All Excon Project Persons with FilteringGET/excon/api/v1/excon-project-persons
Example URI
GET /excon/api/v1/excon-project-persons
URI Parameters
- exconProjectPersonId
string(optional)Export Control Unit Person ID. Maximum length is 22.
- personId
string(optional)Person ID. Maximum length is 40.
- projectNumber
string(optional)- sequenceNumber
string(optional)- rolodexId
string(optional)Rolodex ID. Maximum length is 22.
- fullName
string(optional)Full Name. Maximum length is 90.
- roleTypeCode
string(optional)Role Type Code. Maximum length is 3.
- exconProject.projectId
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"exconProjectPersonId": "(val)",
"personId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"rolodexId": "(val)",
"fullName": "(val)",
"roleTypeCode": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectPersonId": "(val)",
"personId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"rolodexId": "(val)",
"fullName": "(val)",
"roleTypeCode": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Excon Project PersonsGET/excon/api/v1/excon-project-persons
Example URI
GET /excon/api/v1/excon-project-persons
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"exconProjectPersonId",
"personId",
"projectNumber",
"sequenceNumber",
"rolodexId",
"fullName",
"roleTypeCode",
"exconProject.projectId"
],
"primaryKey": "exconProjectPersonId"
}Get Blueprint API specification for Excon Project PersonsGET/excon/api/v1/excon-project-persons
Example URI
GET /excon/api/v1/excon-project-persons
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Excon Project Persons.md"
transfer-encoding: chunkedUpdate Excon Project PersonsPUT/excon/api/v1/excon-project-persons(key)
Example URI
PUT /excon/api/v1/excon-project-persons(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"exconProjectPersonId": "(val)",
"personId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"rolodexId": "(val)",
"fullName": "(val)",
"roleTypeCode": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Excon Project PersonsPUT/excon/api/v1/excon-project-persons
Example URI
PUT /excon/api/v1/excon-project-persons
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"exconProjectPersonId": "(val)",
"personId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"rolodexId": "(val)",
"fullName": "(val)",
"roleTypeCode": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectPersonId": "(val)",
"personId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"rolodexId": "(val)",
"fullName": "(val)",
"roleTypeCode": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Excon Project PersonsPATCH/excon/api/v1/excon-project-persons(key)
Example URI
PATCH /excon/api/v1/excon-project-persons(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"exconProjectPersonId": "(val)",
"personId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"rolodexId": "(val)",
"fullName": "(val)",
"roleTypeCode": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"exconProjectPersonId": "(val)",
"personId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"rolodexId": "(val)",
"fullName": "(val)",
"roleTypeCode": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Insert Excon Project PersonsPOST/excon/api/v1/excon-project-persons
Example URI
POST /excon/api/v1/excon-project-persons
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"exconProjectPersonId": "(val)",
"personId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"rolodexId": "(val)",
"fullName": "(val)",
"roleTypeCode": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"exconProjectPersonId": "(val)",
"personId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"rolodexId": "(val)",
"fullName": "(val)",
"roleTypeCode": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Excon Project PersonsPOST/excon/api/v1/excon-project-persons
Example URI
POST /excon/api/v1/excon-project-persons
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"exconProjectPersonId": "(val)",
"personId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"rolodexId": "(val)",
"fullName": "(val)",
"roleTypeCode": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectPersonId": "(val)",
"personId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"rolodexId": "(val)",
"fullName": "(val)",
"roleTypeCode": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"exconProjectPersonId": "(val)",
"personId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"rolodexId": "(val)",
"fullName": "(val)",
"roleTypeCode": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectPersonId": "(val)",
"personId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"rolodexId": "(val)",
"fullName": "(val)",
"roleTypeCode": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}
]Delete Excon Project Persons by KeyDELETE/excon/api/v1/excon-project-persons(key)
Example URI
DELETE /excon/api/v1/excon-project-persons(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project PersonsDELETE/excon/api/v1/excon-project-persons
Example URI
DELETE /excon/api/v1/excon-project-persons
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project Persons with MatchingDELETE/excon/api/v1/excon-project-persons
Example URI
DELETE /excon/api/v1/excon-project-persons
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- exconProjectPersonId
string(optional)Export Control Unit Person ID. Maximum length is 22.
- personId
string(optional)Person ID. Maximum length is 40.
- projectNumber
string(optional)- sequenceNumber
string(optional)- rolodexId
string(optional)Rolodex ID. Maximum length is 22.
- fullName
string(optional)Full Name. Maximum length is 90.
- roleTypeCode
string(optional)Role Type Code. Maximum length is 3.
- exconProject.projectId
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Excon Project R P S Entities ¶
Get Excon Project R P S Entities by KeyGET/excon/api/v1/excon-project-r-p-s-entities(key)
Example URI
GET /excon/api/v1/excon-project-r-p-s-entities(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"rpsEntityId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"otherNames": "(val)",
"concatNames": "(val)",
"companyName": "(val)",
"streetAddress": "(val)",
"city": "(val)",
"state": "(val)",
"countryCode": "(val)",
"birthdate": "(val)",
"otherInfo": "(val)",
"rpsMatchCode": "(val)",
"_primaryKey": "(val)"
}Get All Excon Project R P S EntitiesGET/excon/api/v1/excon-project-r-p-s-entities
Example URI
GET /excon/api/v1/excon-project-r-p-s-entities
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"rpsEntityId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"otherNames": "(val)",
"concatNames": "(val)",
"companyName": "(val)",
"streetAddress": "(val)",
"city": "(val)",
"state": "(val)",
"countryCode": "(val)",
"birthdate": "(val)",
"otherInfo": "(val)",
"rpsMatchCode": "(val)",
"_primaryKey": "(val)"
},
{
"rpsEntityId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"otherNames": "(val)",
"concatNames": "(val)",
"companyName": "(val)",
"streetAddress": "(val)",
"city": "(val)",
"state": "(val)",
"countryCode": "(val)",
"birthdate": "(val)",
"otherInfo": "(val)",
"rpsMatchCode": "(val)",
"_primaryKey": "(val)"
}
]Get All Excon Project R P S Entities with FilteringGET/excon/api/v1/excon-project-r-p-s-entities
Example URI
GET /excon/api/v1/excon-project-r-p-s-entities
URI Parameters
- rpsEntityId
string(optional)Export Control RPSEntity ID. Maximum length is 22.
- projectNumber
string(optional)- sequenceNumber
string(optional)- firstName
string(optional)First Name. Maximum length is 60.
- lastName
string(optional)Last Name. Maximum length is 60.
- otherNames
string(optional)Other Names. Maximum length is 200.
- concatNames
string(optional)- companyName
string(optional)Company Name. Maximum length is 100.
- streetAddress
string(optional)Street Address. Maximum length is 80.
- city
string(optional)City. Maximum length is 50.
- state
string(optional)State. Maximum length is 50.
- countryCode
string(optional)Country Code. Maximum length is 3.
- birthdate
string(optional)Birthdate. Maximum length is 21.
- otherInfo
string(optional)Other Info.
- rpsMatchCode
string(optional)RPS Match Code. Maximum length is 3.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"rpsEntityId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"otherNames": "(val)",
"concatNames": "(val)",
"companyName": "(val)",
"streetAddress": "(val)",
"city": "(val)",
"state": "(val)",
"countryCode": "(val)",
"birthdate": "(val)",
"otherInfo": "(val)",
"rpsMatchCode": "(val)",
"_primaryKey": "(val)"
},
{
"rpsEntityId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"otherNames": "(val)",
"concatNames": "(val)",
"companyName": "(val)",
"streetAddress": "(val)",
"city": "(val)",
"state": "(val)",
"countryCode": "(val)",
"birthdate": "(val)",
"otherInfo": "(val)",
"rpsMatchCode": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Excon Project R P S EntitiesGET/excon/api/v1/excon-project-r-p-s-entities
Example URI
GET /excon/api/v1/excon-project-r-p-s-entities
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"rpsEntityId",
"projectNumber",
"sequenceNumber",
"firstName",
"lastName",
"otherNames",
"concatNames",
"companyName",
"streetAddress",
"city",
"state",
"countryCode",
"birthdate",
"otherInfo",
"rpsMatchCode"
],
"primaryKey": "rpsEntityId"
}Get Blueprint API specification for Excon Project R P S EntitiesGET/excon/api/v1/excon-project-r-p-s-entities
Example URI
GET /excon/api/v1/excon-project-r-p-s-entities
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Excon Project R P S Entities.md"
transfer-encoding: chunkedUpdate Excon Project R P S EntitiesPUT/excon/api/v1/excon-project-r-p-s-entities(key)
Example URI
PUT /excon/api/v1/excon-project-r-p-s-entities(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"rpsEntityId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"otherNames": "(val)",
"concatNames": "(val)",
"companyName": "(val)",
"streetAddress": "(val)",
"city": "(val)",
"state": "(val)",
"countryCode": "(val)",
"birthdate": "(val)",
"otherInfo": "(val)",
"rpsMatchCode": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Excon Project R P S EntitiesPUT/excon/api/v1/excon-project-r-p-s-entities
Example URI
PUT /excon/api/v1/excon-project-r-p-s-entities
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"rpsEntityId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"otherNames": "(val)",
"concatNames": "(val)",
"companyName": "(val)",
"streetAddress": "(val)",
"city": "(val)",
"state": "(val)",
"countryCode": "(val)",
"birthdate": "(val)",
"otherInfo": "(val)",
"rpsMatchCode": "(val)",
"_primaryKey": "(val)"
},
{
"rpsEntityId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"otherNames": "(val)",
"concatNames": "(val)",
"companyName": "(val)",
"streetAddress": "(val)",
"city": "(val)",
"state": "(val)",
"countryCode": "(val)",
"birthdate": "(val)",
"otherInfo": "(val)",
"rpsMatchCode": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Excon Project R P S EntitiesPATCH/excon/api/v1/excon-project-r-p-s-entities(key)
Example URI
PATCH /excon/api/v1/excon-project-r-p-s-entities(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"rpsEntityId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"otherNames": "(val)",
"concatNames": "(val)",
"companyName": "(val)",
"streetAddress": "(val)",
"city": "(val)",
"state": "(val)",
"countryCode": "(val)",
"birthdate": "(val)",
"otherInfo": "(val)",
"rpsMatchCode": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"rpsEntityId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"otherNames": "(val)",
"concatNames": "(val)",
"companyName": "(val)",
"streetAddress": "(val)",
"city": "(val)",
"state": "(val)",
"countryCode": "(val)",
"birthdate": "(val)",
"otherInfo": "(val)",
"rpsMatchCode": "(val)",
"_primaryKey": "(val)"
}Insert Excon Project R P S EntitiesPOST/excon/api/v1/excon-project-r-p-s-entities
Example URI
POST /excon/api/v1/excon-project-r-p-s-entities
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"rpsEntityId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"otherNames": "(val)",
"concatNames": "(val)",
"companyName": "(val)",
"streetAddress": "(val)",
"city": "(val)",
"state": "(val)",
"countryCode": "(val)",
"birthdate": "(val)",
"otherInfo": "(val)",
"rpsMatchCode": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"rpsEntityId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"otherNames": "(val)",
"concatNames": "(val)",
"companyName": "(val)",
"streetAddress": "(val)",
"city": "(val)",
"state": "(val)",
"countryCode": "(val)",
"birthdate": "(val)",
"otherInfo": "(val)",
"rpsMatchCode": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Excon Project R P S EntitiesPOST/excon/api/v1/excon-project-r-p-s-entities
Example URI
POST /excon/api/v1/excon-project-r-p-s-entities
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"rpsEntityId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"otherNames": "(val)",
"concatNames": "(val)",
"companyName": "(val)",
"streetAddress": "(val)",
"city": "(val)",
"state": "(val)",
"countryCode": "(val)",
"birthdate": "(val)",
"otherInfo": "(val)",
"rpsMatchCode": "(val)",
"_primaryKey": "(val)"
},
{
"rpsEntityId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"otherNames": "(val)",
"concatNames": "(val)",
"companyName": "(val)",
"streetAddress": "(val)",
"city": "(val)",
"state": "(val)",
"countryCode": "(val)",
"birthdate": "(val)",
"otherInfo": "(val)",
"rpsMatchCode": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"rpsEntityId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"otherNames": "(val)",
"concatNames": "(val)",
"companyName": "(val)",
"streetAddress": "(val)",
"city": "(val)",
"state": "(val)",
"countryCode": "(val)",
"birthdate": "(val)",
"otherInfo": "(val)",
"rpsMatchCode": "(val)",
"_primaryKey": "(val)"
},
{
"rpsEntityId": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"otherNames": "(val)",
"concatNames": "(val)",
"companyName": "(val)",
"streetAddress": "(val)",
"city": "(val)",
"state": "(val)",
"countryCode": "(val)",
"birthdate": "(val)",
"otherInfo": "(val)",
"rpsMatchCode": "(val)",
"_primaryKey": "(val)"
}
]Delete Excon Project R P S Entities by KeyDELETE/excon/api/v1/excon-project-r-p-s-entities(key)
Example URI
DELETE /excon/api/v1/excon-project-r-p-s-entities(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project R P S EntitiesDELETE/excon/api/v1/excon-project-r-p-s-entities
Example URI
DELETE /excon/api/v1/excon-project-r-p-s-entities
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project R P S Entities with MatchingDELETE/excon/api/v1/excon-project-r-p-s-entities
Example URI
DELETE /excon/api/v1/excon-project-r-p-s-entities
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- rpsEntityId
string(optional)Export Control RPSEntity ID. Maximum length is 22.
- projectNumber
string(optional)- sequenceNumber
string(optional)- firstName
string(optional)First Name. Maximum length is 60.
- lastName
string(optional)Last Name. Maximum length is 60.
- otherNames
string(optional)Other Names. Maximum length is 200.
- concatNames
string(optional)- companyName
string(optional)Company Name. Maximum length is 100.
- streetAddress
string(optional)Street Address. Maximum length is 80.
- city
string(optional)City. Maximum length is 50.
- state
string(optional)State. Maximum length is 50.
- countryCode
string(optional)Country Code. Maximum length is 3.
- birthdate
string(optional)Birthdate. Maximum length is 21.
- otherInfo
string(optional)Other Info.
- rpsMatchCode
string(optional)RPS Match Code. Maximum length is 3.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Excon Project R P S Results ¶
Get Excon Project R P S Results by KeyGET/excon/api/v1/excon-project-r-p-s-results(key)
Example URI
GET /excon/api/v1/excon-project-r-p-s-results(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"rpsResultId": "(val)",
"rpsResultContent": "(val)",
"rpsSearchDate": "(val)",
"searchingUser": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Get All Excon Project R P S ResultsGET/excon/api/v1/excon-project-r-p-s-results
Example URI
GET /excon/api/v1/excon-project-r-p-s-results
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"rpsResultId": "(val)",
"rpsResultContent": "(val)",
"rpsSearchDate": "(val)",
"searchingUser": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
},
{
"rpsResultId": "(val)",
"rpsResultContent": "(val)",
"rpsSearchDate": "(val)",
"searchingUser": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}
]Get All Excon Project R P S Results with FilteringGET/excon/api/v1/excon-project-r-p-s-results
Example URI
GET /excon/api/v1/excon-project-r-p-s-results
URI Parameters
- rpsResultId
string(optional)Export Control RPS Result ID. Maximum length is 22.
- rpsResultContent
string(optional)RPS Result Content.
- rpsSearchDate
string(optional)The creation or last modification timestamp. Maximum length is 21.
- searchingUser
string(optional)The user who created or last modified the object. Maximum length is 60.
- projectNumber
string(optional)- sequenceNumber
string(optional)- exconProject.projectId
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"rpsResultId": "(val)",
"rpsResultContent": "(val)",
"rpsSearchDate": "(val)",
"searchingUser": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
},
{
"rpsResultId": "(val)",
"rpsResultContent": "(val)",
"rpsSearchDate": "(val)",
"searchingUser": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Excon Project R P S ResultsGET/excon/api/v1/excon-project-r-p-s-results
Example URI
GET /excon/api/v1/excon-project-r-p-s-results
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"rpsResultId",
"rpsResultContent",
"rpsSearchDate",
"searchingUser",
"projectNumber",
"sequenceNumber",
"exconProject.projectId"
],
"primaryKey": "rpsResultId"
}Get Blueprint API specification for Excon Project R P S ResultsGET/excon/api/v1/excon-project-r-p-s-results
Example URI
GET /excon/api/v1/excon-project-r-p-s-results
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Excon Project R P S Results.md"
transfer-encoding: chunkedUpdate Excon Project R P S ResultsPUT/excon/api/v1/excon-project-r-p-s-results(key)
Example URI
PUT /excon/api/v1/excon-project-r-p-s-results(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"rpsResultId": "(val)",
"rpsResultContent": "(val)",
"rpsSearchDate": "(val)",
"searchingUser": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Excon Project R P S ResultsPUT/excon/api/v1/excon-project-r-p-s-results
Example URI
PUT /excon/api/v1/excon-project-r-p-s-results
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"rpsResultId": "(val)",
"rpsResultContent": "(val)",
"rpsSearchDate": "(val)",
"searchingUser": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
},
{
"rpsResultId": "(val)",
"rpsResultContent": "(val)",
"rpsSearchDate": "(val)",
"searchingUser": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Excon Project R P S ResultsPATCH/excon/api/v1/excon-project-r-p-s-results(key)
Example URI
PATCH /excon/api/v1/excon-project-r-p-s-results(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"rpsResultId": "(val)",
"rpsResultContent": "(val)",
"rpsSearchDate": "(val)",
"searchingUser": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"rpsResultId": "(val)",
"rpsResultContent": "(val)",
"rpsSearchDate": "(val)",
"searchingUser": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Insert Excon Project R P S ResultsPOST/excon/api/v1/excon-project-r-p-s-results
Example URI
POST /excon/api/v1/excon-project-r-p-s-results
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"rpsResultId": "(val)",
"rpsResultContent": "(val)",
"rpsSearchDate": "(val)",
"searchingUser": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"rpsResultId": "(val)",
"rpsResultContent": "(val)",
"rpsSearchDate": "(val)",
"searchingUser": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Excon Project R P S ResultsPOST/excon/api/v1/excon-project-r-p-s-results
Example URI
POST /excon/api/v1/excon-project-r-p-s-results
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"rpsResultId": "(val)",
"rpsResultContent": "(val)",
"rpsSearchDate": "(val)",
"searchingUser": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
},
{
"rpsResultId": "(val)",
"rpsResultContent": "(val)",
"rpsSearchDate": "(val)",
"searchingUser": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"rpsResultId": "(val)",
"rpsResultContent": "(val)",
"rpsSearchDate": "(val)",
"searchingUser": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
},
{
"rpsResultId": "(val)",
"rpsResultContent": "(val)",
"rpsSearchDate": "(val)",
"searchingUser": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}
]Delete Excon Project R P S Results by KeyDELETE/excon/api/v1/excon-project-r-p-s-results(key)
Example URI
DELETE /excon/api/v1/excon-project-r-p-s-results(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project R P S ResultsDELETE/excon/api/v1/excon-project-r-p-s-results
Example URI
DELETE /excon/api/v1/excon-project-r-p-s-results
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project R P S Results with MatchingDELETE/excon/api/v1/excon-project-r-p-s-results
Example URI
DELETE /excon/api/v1/excon-project-r-p-s-results
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- rpsResultId
string(optional)Export Control RPS Result ID. Maximum length is 22.
- rpsResultContent
string(optional)RPS Result Content.
- rpsSearchDate
string(optional)The creation or last modification timestamp. Maximum length is 21.
- searchingUser
string(optional)The user who created or last modified the object. Maximum length is 60.
- projectNumber
string(optional)- sequenceNumber
string(optional)- exconProject.projectId
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Excon Project Restricted Countries ¶
Get Excon Project Restricted Countries by KeyGET/excon/api/v1/excon-project-restricted-countries(key)
Example URI
GET /excon/api/v1/excon-project-restricted-countries(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"postalCountryCode": "(val)",
"sanctionListCode": "(val)",
"_primaryKey": "(val)"
}Get All Excon Project Restricted CountriesGET/excon/api/v1/excon-project-restricted-countries
Example URI
GET /excon/api/v1/excon-project-restricted-countries
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"postalCountryCode": "(val)",
"sanctionListCode": "(val)",
"_primaryKey": "(val)"
},
{
"postalCountryCode": "(val)",
"sanctionListCode": "(val)",
"_primaryKey": "(val)"
}
]Get All Excon Project Restricted Countries with FilteringGET/excon/api/v1/excon-project-restricted-countries
Example URI
GET /excon/api/v1/excon-project-restricted-countries
URI Parameters
- postalCountryCode
string(optional)Country Code. Maximum length is 3.
- sanctionListCode
string(optional)Export Control Sanction List. Maximum length is 4.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"postalCountryCode": "(val)",
"sanctionListCode": "(val)",
"_primaryKey": "(val)"
},
{
"postalCountryCode": "(val)",
"sanctionListCode": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Excon Project Restricted CountriesGET/excon/api/v1/excon-project-restricted-countries
Example URI
GET /excon/api/v1/excon-project-restricted-countries
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"postalCountryCode",
"sanctionListCode"
],
"primaryKey": "postalCountryCode"
}Get Blueprint API specification for Excon Project Restricted CountriesGET/excon/api/v1/excon-project-restricted-countries
Example URI
GET /excon/api/v1/excon-project-restricted-countries
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Excon Project Restricted Countries.md"
transfer-encoding: chunkedUpdate Excon Project Restricted CountriesPUT/excon/api/v1/excon-project-restricted-countries(key)
Example URI
PUT /excon/api/v1/excon-project-restricted-countries(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"postalCountryCode": "(val)",
"sanctionListCode": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Excon Project Restricted CountriesPUT/excon/api/v1/excon-project-restricted-countries
Example URI
PUT /excon/api/v1/excon-project-restricted-countries
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"postalCountryCode": "(val)",
"sanctionListCode": "(val)",
"_primaryKey": "(val)"
},
{
"postalCountryCode": "(val)",
"sanctionListCode": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Excon Project Restricted CountriesPATCH/excon/api/v1/excon-project-restricted-countries(key)
Example URI
PATCH /excon/api/v1/excon-project-restricted-countries(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"postalCountryCode": "(val)",
"sanctionListCode": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"postalCountryCode": "(val)",
"sanctionListCode": "(val)",
"_primaryKey": "(val)"
}Insert Excon Project Restricted CountriesPOST/excon/api/v1/excon-project-restricted-countries
Example URI
POST /excon/api/v1/excon-project-restricted-countries
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"postalCountryCode": "(val)",
"sanctionListCode": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"postalCountryCode": "(val)",
"sanctionListCode": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Excon Project Restricted CountriesPOST/excon/api/v1/excon-project-restricted-countries
Example URI
POST /excon/api/v1/excon-project-restricted-countries
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"postalCountryCode": "(val)",
"sanctionListCode": "(val)",
"_primaryKey": "(val)"
},
{
"postalCountryCode": "(val)",
"sanctionListCode": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"postalCountryCode": "(val)",
"sanctionListCode": "(val)",
"_primaryKey": "(val)"
},
{
"postalCountryCode": "(val)",
"sanctionListCode": "(val)",
"_primaryKey": "(val)"
}
]Delete Excon Project Restricted Countries by KeyDELETE/excon/api/v1/excon-project-restricted-countries(key)
Example URI
DELETE /excon/api/v1/excon-project-restricted-countries(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project Restricted CountriesDELETE/excon/api/v1/excon-project-restricted-countries
Example URI
DELETE /excon/api/v1/excon-project-restricted-countries
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project Restricted Countries with MatchingDELETE/excon/api/v1/excon-project-restricted-countries
Example URI
DELETE /excon/api/v1/excon-project-restricted-countries
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- postalCountryCode
string(optional)Country Code. Maximum length is 3.
- sanctionListCode
string(optional)Export Control Sanction List. Maximum length is 4.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Excon Project Restricted Units ¶
Get Excon Project Restricted Units by KeyGET/excon/api/v1/excon-project-restricted-units(key)
Example URI
GET /excon/api/v1/excon-project-restricted-units(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"unitNumber": "(val)",
"_primaryKey": "(val)"
}Get All Excon Project Restricted UnitsGET/excon/api/v1/excon-project-restricted-units
Example URI
GET /excon/api/v1/excon-project-restricted-units
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"unitNumber": "(val)",
"_primaryKey": "(val)"
},
{
"unitNumber": "(val)",
"_primaryKey": "(val)"
}
]Get All Excon Project Restricted Units with FilteringGET/excon/api/v1/excon-project-restricted-units
Example URI
GET /excon/api/v1/excon-project-restricted-units
URI Parameters
- unitNumber
string(optional)Restricted Unit ID. Maximum length is 8.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"unitNumber": "(val)",
"_primaryKey": "(val)"
},
{
"unitNumber": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Excon Project Restricted UnitsGET/excon/api/v1/excon-project-restricted-units
Example URI
GET /excon/api/v1/excon-project-restricted-units
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"unitNumber"
],
"primaryKey": "unitNumber"
}Get Blueprint API specification for Excon Project Restricted UnitsGET/excon/api/v1/excon-project-restricted-units
Example URI
GET /excon/api/v1/excon-project-restricted-units
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Excon Project Restricted Units.md"
transfer-encoding: chunkedUpdate Excon Project Restricted UnitsPUT/excon/api/v1/excon-project-restricted-units(key)
Example URI
PUT /excon/api/v1/excon-project-restricted-units(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"unitNumber": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Excon Project Restricted UnitsPUT/excon/api/v1/excon-project-restricted-units
Example URI
PUT /excon/api/v1/excon-project-restricted-units
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"unitNumber": "(val)",
"_primaryKey": "(val)"
},
{
"unitNumber": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Excon Project Restricted UnitsPATCH/excon/api/v1/excon-project-restricted-units(key)
Example URI
PATCH /excon/api/v1/excon-project-restricted-units(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"unitNumber": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"unitNumber": "(val)",
"_primaryKey": "(val)"
}Insert Excon Project Restricted UnitsPOST/excon/api/v1/excon-project-restricted-units
Example URI
POST /excon/api/v1/excon-project-restricted-units
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"unitNumber": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"unitNumber": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Excon Project Restricted UnitsPOST/excon/api/v1/excon-project-restricted-units
Example URI
POST /excon/api/v1/excon-project-restricted-units
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"unitNumber": "(val)",
"_primaryKey": "(val)"
},
{
"unitNumber": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"unitNumber": "(val)",
"_primaryKey": "(val)"
},
{
"unitNumber": "(val)",
"_primaryKey": "(val)"
}
]Delete Excon Project Restricted Units by KeyDELETE/excon/api/v1/excon-project-restricted-units(key)
Example URI
DELETE /excon/api/v1/excon-project-restricted-units(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project Restricted UnitsDELETE/excon/api/v1/excon-project-restricted-units
Example URI
DELETE /excon/api/v1/excon-project-restricted-units
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project Restricted Units with MatchingDELETE/excon/api/v1/excon-project-restricted-units
Example URI
DELETE /excon/api/v1/excon-project-restricted-units
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- unitNumber
string(optional)Restricted Unit ID. Maximum length is 8.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Excon Project Reviews ¶
Get Excon Project Reviews by KeyGET/excon/api/v1/excon-project-reviews(key)
Example URI
GET /excon/api/v1/excon-project-reviews(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"exconProjectReviewId": "(val)",
"projectReviewTypeCode": "(val)",
"reviewComment": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Get All Excon Project ReviewsGET/excon/api/v1/excon-project-reviews
Example URI
GET /excon/api/v1/excon-project-reviews
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"exconProjectReviewId": "(val)",
"projectReviewTypeCode": "(val)",
"reviewComment": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectReviewId": "(val)",
"projectReviewTypeCode": "(val)",
"reviewComment": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}
]Get All Excon Project Reviews with FilteringGET/excon/api/v1/excon-project-reviews
Example URI
GET /excon/api/v1/excon-project-reviews
URI Parameters
- exconProjectReviewId
string(optional)Export Control Review ID. Maximum length is 22.
- projectReviewTypeCode
string(optional)Review Type Code. Maximum length is 3.
- reviewComment
string(optional)Comment. Maximum length is 100.
- projectNumber
string(optional)- sequenceNumber
string(optional)- exconProject.projectId
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"exconProjectReviewId": "(val)",
"projectReviewTypeCode": "(val)",
"reviewComment": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectReviewId": "(val)",
"projectReviewTypeCode": "(val)",
"reviewComment": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Excon Project ReviewsGET/excon/api/v1/excon-project-reviews
Example URI
GET /excon/api/v1/excon-project-reviews
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"exconProjectReviewId",
"projectReviewTypeCode",
"reviewComment",
"projectNumber",
"sequenceNumber",
"exconProject.projectId"
],
"primaryKey": "exconProjectReviewId"
}Get Blueprint API specification for Excon Project ReviewsGET/excon/api/v1/excon-project-reviews
Example URI
GET /excon/api/v1/excon-project-reviews
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Excon Project Reviews.md"
transfer-encoding: chunkedUpdate Excon Project ReviewsPUT/excon/api/v1/excon-project-reviews(key)
Example URI
PUT /excon/api/v1/excon-project-reviews(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"exconProjectReviewId": "(val)",
"projectReviewTypeCode": "(val)",
"reviewComment": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Excon Project ReviewsPUT/excon/api/v1/excon-project-reviews
Example URI
PUT /excon/api/v1/excon-project-reviews
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"exconProjectReviewId": "(val)",
"projectReviewTypeCode": "(val)",
"reviewComment": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectReviewId": "(val)",
"projectReviewTypeCode": "(val)",
"reviewComment": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Excon Project ReviewsPATCH/excon/api/v1/excon-project-reviews(key)
Example URI
PATCH /excon/api/v1/excon-project-reviews(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"exconProjectReviewId": "(val)",
"projectReviewTypeCode": "(val)",
"reviewComment": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"exconProjectReviewId": "(val)",
"projectReviewTypeCode": "(val)",
"reviewComment": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Insert Excon Project ReviewsPOST/excon/api/v1/excon-project-reviews
Example URI
POST /excon/api/v1/excon-project-reviews
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"exconProjectReviewId": "(val)",
"projectReviewTypeCode": "(val)",
"reviewComment": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"exconProjectReviewId": "(val)",
"projectReviewTypeCode": "(val)",
"reviewComment": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Excon Project ReviewsPOST/excon/api/v1/excon-project-reviews
Example URI
POST /excon/api/v1/excon-project-reviews
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"exconProjectReviewId": "(val)",
"projectReviewTypeCode": "(val)",
"reviewComment": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectReviewId": "(val)",
"projectReviewTypeCode": "(val)",
"reviewComment": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"exconProjectReviewId": "(val)",
"projectReviewTypeCode": "(val)",
"reviewComment": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectReviewId": "(val)",
"projectReviewTypeCode": "(val)",
"reviewComment": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}
]Delete Excon Project Reviews by KeyDELETE/excon/api/v1/excon-project-reviews(key)
Example URI
DELETE /excon/api/v1/excon-project-reviews(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project ReviewsDELETE/excon/api/v1/excon-project-reviews
Example URI
DELETE /excon/api/v1/excon-project-reviews
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project Reviews with MatchingDELETE/excon/api/v1/excon-project-reviews
Example URI
DELETE /excon/api/v1/excon-project-reviews
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- exconProjectReviewId
string(optional)Export Control Review ID. Maximum length is 22.
- projectReviewTypeCode
string(optional)Review Type Code. Maximum length is 3.
- reviewComment
string(optional)Comment. Maximum length is 100.
- projectNumber
string(optional)- sequenceNumber
string(optional)- exconProject.projectId
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Excon Project Status Types ¶
Get Excon Project Status Types by KeyGET/excon/api/v1/excon-project-status-types(key)
Example URI
GET /excon/api/v1/excon-project-status-types(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"exconProjectStatusTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Excon Project Status TypesGET/excon/api/v1/excon-project-status-types
Example URI
GET /excon/api/v1/excon-project-status-types
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"exconProjectStatusTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectStatusTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Excon Project Status Types with FilteringGET/excon/api/v1/excon-project-status-types
Example URI
GET /excon/api/v1/excon-project-status-types
URI Parameters
- exconProjectStatusTypeCode
string(optional)Export Control Project Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"exconProjectStatusTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectStatusTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Excon Project Status TypesGET/excon/api/v1/excon-project-status-types
Example URI
GET /excon/api/v1/excon-project-status-types
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"exconProjectStatusTypeCode",
"description"
],
"primaryKey": "exconProjectStatusTypeCode"
}Get Blueprint API specification for Excon Project Status TypesGET/excon/api/v1/excon-project-status-types
Example URI
GET /excon/api/v1/excon-project-status-types
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Excon Project Status Types.md"
transfer-encoding: chunkedUpdate Excon Project Status TypesPUT/excon/api/v1/excon-project-status-types(key)
Example URI
PUT /excon/api/v1/excon-project-status-types(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"exconProjectStatusTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Excon Project Status TypesPUT/excon/api/v1/excon-project-status-types
Example URI
PUT /excon/api/v1/excon-project-status-types
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"exconProjectStatusTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectStatusTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Excon Project Status TypesPATCH/excon/api/v1/excon-project-status-types(key)
Example URI
PATCH /excon/api/v1/excon-project-status-types(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"exconProjectStatusTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"exconProjectStatusTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Excon Project Status TypesPOST/excon/api/v1/excon-project-status-types
Example URI
POST /excon/api/v1/excon-project-status-types
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"exconProjectStatusTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"exconProjectStatusTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Excon Project Status TypesPOST/excon/api/v1/excon-project-status-types
Example URI
POST /excon/api/v1/excon-project-status-types
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"exconProjectStatusTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectStatusTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"exconProjectStatusTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectStatusTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Excon Project Status Types by KeyDELETE/excon/api/v1/excon-project-status-types(key)
Example URI
DELETE /excon/api/v1/excon-project-status-types(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project Status TypesDELETE/excon/api/v1/excon-project-status-types
Example URI
DELETE /excon/api/v1/excon-project-status-types
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project Status Types with MatchingDELETE/excon/api/v1/excon-project-status-types
Example URI
DELETE /excon/api/v1/excon-project-status-types
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- exconProjectStatusTypeCode
string(optional)Export Control Project Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Excon Project Traveler Communications ¶
Get Excon Project Traveler Communications by KeyGET/excon/api/v1/excon-project-traveler-communications(key)
Example URI
GET /excon/api/v1/excon-project-traveler-communications(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"projectTravelerComId": "(val)",
"communicationDate": "(val)",
"emailBodyContentCode": "(val)",
"emailAttachmentContentCode": "(val)",
"agendaContentCode": "(val)",
"travelComment": "(val)",
"traveler.personId": "(val)",
"_primaryKey": "(val)"
}Get All Excon Project Traveler CommunicationsGET/excon/api/v1/excon-project-traveler-communications
Example URI
GET /excon/api/v1/excon-project-traveler-communications
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"projectTravelerComId": "(val)",
"communicationDate": "(val)",
"emailBodyContentCode": "(val)",
"emailAttachmentContentCode": "(val)",
"agendaContentCode": "(val)",
"travelComment": "(val)",
"traveler.personId": "(val)",
"_primaryKey": "(val)"
},
{
"projectTravelerComId": "(val)",
"communicationDate": "(val)",
"emailBodyContentCode": "(val)",
"emailAttachmentContentCode": "(val)",
"agendaContentCode": "(val)",
"travelComment": "(val)",
"traveler.personId": "(val)",
"_primaryKey": "(val)"
}
]Get All Excon Project Traveler Communications with FilteringGET/excon/api/v1/excon-project-traveler-communications
Example URI
GET /excon/api/v1/excon-project-traveler-communications
URI Parameters
- projectTravelerComId
string(optional)- communicationDate
string(optional)- emailBodyContentCode
string(optional)- emailAttachmentContentCode
string(optional)- agendaContentCode
string(optional)- travelComment
string(optional)- traveler.personId
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"projectTravelerComId": "(val)",
"communicationDate": "(val)",
"emailBodyContentCode": "(val)",
"emailAttachmentContentCode": "(val)",
"agendaContentCode": "(val)",
"travelComment": "(val)",
"traveler.personId": "(val)",
"_primaryKey": "(val)"
},
{
"projectTravelerComId": "(val)",
"communicationDate": "(val)",
"emailBodyContentCode": "(val)",
"emailAttachmentContentCode": "(val)",
"agendaContentCode": "(val)",
"travelComment": "(val)",
"traveler.personId": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Excon Project Traveler CommunicationsGET/excon/api/v1/excon-project-traveler-communications
Example URI
GET /excon/api/v1/excon-project-traveler-communications
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"projectTravelerComId",
"communicationDate",
"emailBodyContentCode",
"emailAttachmentContentCode",
"agendaContentCode",
"travelComment",
"traveler.personId"
],
"primaryKey": "projectTravelerComId"
}Get Blueprint API specification for Excon Project Traveler CommunicationsGET/excon/api/v1/excon-project-traveler-communications
Example URI
GET /excon/api/v1/excon-project-traveler-communications
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Excon Project Traveler Communications.md"
transfer-encoding: chunkedUpdate Excon Project Traveler CommunicationsPUT/excon/api/v1/excon-project-traveler-communications(key)
Example URI
PUT /excon/api/v1/excon-project-traveler-communications(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"projectTravelerComId": "(val)",
"communicationDate": "(val)",
"emailBodyContentCode": "(val)",
"emailAttachmentContentCode": "(val)",
"agendaContentCode": "(val)",
"travelComment": "(val)",
"traveler.personId": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Excon Project Traveler CommunicationsPUT/excon/api/v1/excon-project-traveler-communications
Example URI
PUT /excon/api/v1/excon-project-traveler-communications
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"projectTravelerComId": "(val)",
"communicationDate": "(val)",
"emailBodyContentCode": "(val)",
"emailAttachmentContentCode": "(val)",
"agendaContentCode": "(val)",
"travelComment": "(val)",
"traveler.personId": "(val)",
"_primaryKey": "(val)"
},
{
"projectTravelerComId": "(val)",
"communicationDate": "(val)",
"emailBodyContentCode": "(val)",
"emailAttachmentContentCode": "(val)",
"agendaContentCode": "(val)",
"travelComment": "(val)",
"traveler.personId": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Excon Project Traveler CommunicationsPATCH/excon/api/v1/excon-project-traveler-communications(key)
Example URI
PATCH /excon/api/v1/excon-project-traveler-communications(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"projectTravelerComId": "(val)",
"communicationDate": "(val)",
"emailBodyContentCode": "(val)",
"emailAttachmentContentCode": "(val)",
"agendaContentCode": "(val)",
"travelComment": "(val)",
"traveler.personId": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"projectTravelerComId": "(val)",
"communicationDate": "(val)",
"emailBodyContentCode": "(val)",
"emailAttachmentContentCode": "(val)",
"agendaContentCode": "(val)",
"travelComment": "(val)",
"traveler.personId": "(val)",
"_primaryKey": "(val)"
}Insert Excon Project Traveler CommunicationsPOST/excon/api/v1/excon-project-traveler-communications
Example URI
POST /excon/api/v1/excon-project-traveler-communications
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"projectTravelerComId": "(val)",
"communicationDate": "(val)",
"emailBodyContentCode": "(val)",
"emailAttachmentContentCode": "(val)",
"agendaContentCode": "(val)",
"travelComment": "(val)",
"traveler.personId": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"projectTravelerComId": "(val)",
"communicationDate": "(val)",
"emailBodyContentCode": "(val)",
"emailAttachmentContentCode": "(val)",
"agendaContentCode": "(val)",
"travelComment": "(val)",
"traveler.personId": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Excon Project Traveler CommunicationsPOST/excon/api/v1/excon-project-traveler-communications
Example URI
POST /excon/api/v1/excon-project-traveler-communications
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"projectTravelerComId": "(val)",
"communicationDate": "(val)",
"emailBodyContentCode": "(val)",
"emailAttachmentContentCode": "(val)",
"agendaContentCode": "(val)",
"travelComment": "(val)",
"traveler.personId": "(val)",
"_primaryKey": "(val)"
},
{
"projectTravelerComId": "(val)",
"communicationDate": "(val)",
"emailBodyContentCode": "(val)",
"emailAttachmentContentCode": "(val)",
"agendaContentCode": "(val)",
"travelComment": "(val)",
"traveler.personId": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"projectTravelerComId": "(val)",
"communicationDate": "(val)",
"emailBodyContentCode": "(val)",
"emailAttachmentContentCode": "(val)",
"agendaContentCode": "(val)",
"travelComment": "(val)",
"traveler.personId": "(val)",
"_primaryKey": "(val)"
},
{
"projectTravelerComId": "(val)",
"communicationDate": "(val)",
"emailBodyContentCode": "(val)",
"emailAttachmentContentCode": "(val)",
"agendaContentCode": "(val)",
"travelComment": "(val)",
"traveler.personId": "(val)",
"_primaryKey": "(val)"
}
]Delete Excon Project Traveler Communications by KeyDELETE/excon/api/v1/excon-project-traveler-communications(key)
Example URI
DELETE /excon/api/v1/excon-project-traveler-communications(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project Traveler CommunicationsDELETE/excon/api/v1/excon-project-traveler-communications
Example URI
DELETE /excon/api/v1/excon-project-traveler-communications
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project Traveler Communications with MatchingDELETE/excon/api/v1/excon-project-traveler-communications
Example URI
DELETE /excon/api/v1/excon-project-traveler-communications
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- projectTravelerComId
string(optional)- communicationDate
string(optional)- emailBodyContentCode
string(optional)- emailAttachmentContentCode
string(optional)- agendaContentCode
string(optional)- travelComment
string(optional)- traveler.personId
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Excon Project Travelers ¶
Get Excon Project Travelers by KeyGET/excon/api/v1/excon-project-travelers(key)
Example URI
GET /excon/api/v1/excon-project-travelers(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"personId": "(val)",
"_primaryKey": "(val)"
}Get All Excon Project TravelersGET/excon/api/v1/excon-project-travelers
Example URI
GET /excon/api/v1/excon-project-travelers
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"personId": "(val)",
"_primaryKey": "(val)"
},
{
"personId": "(val)",
"_primaryKey": "(val)"
}
]Get All Excon Project Travelers with FilteringGET/excon/api/v1/excon-project-travelers
Example URI
GET /excon/api/v1/excon-project-travelers
URI Parameters
- personId
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"personId": "(val)",
"_primaryKey": "(val)"
},
{
"personId": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Excon Project TravelersGET/excon/api/v1/excon-project-travelers
Example URI
GET /excon/api/v1/excon-project-travelers
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"personId"
],
"primaryKey": "personId"
}Get Blueprint API specification for Excon Project TravelersGET/excon/api/v1/excon-project-travelers
Example URI
GET /excon/api/v1/excon-project-travelers
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Excon Project Travelers.md"
transfer-encoding: chunkedUpdate Excon Project TravelersPUT/excon/api/v1/excon-project-travelers(key)
Example URI
PUT /excon/api/v1/excon-project-travelers(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"personId": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Excon Project TravelersPUT/excon/api/v1/excon-project-travelers
Example URI
PUT /excon/api/v1/excon-project-travelers
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"personId": "(val)",
"_primaryKey": "(val)"
},
{
"personId": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Excon Project TravelersPATCH/excon/api/v1/excon-project-travelers(key)
Example URI
PATCH /excon/api/v1/excon-project-travelers(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"personId": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"personId": "(val)",
"_primaryKey": "(val)"
}Insert Excon Project TravelersPOST/excon/api/v1/excon-project-travelers
Example URI
POST /excon/api/v1/excon-project-travelers
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"personId": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"personId": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Excon Project TravelersPOST/excon/api/v1/excon-project-travelers
Example URI
POST /excon/api/v1/excon-project-travelers
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"personId": "(val)",
"_primaryKey": "(val)"
},
{
"personId": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"personId": "(val)",
"_primaryKey": "(val)"
},
{
"personId": "(val)",
"_primaryKey": "(val)"
}
]Delete Excon Project Travelers by KeyDELETE/excon/api/v1/excon-project-travelers(key)
Example URI
DELETE /excon/api/v1/excon-project-travelers(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project TravelersDELETE/excon/api/v1/excon-project-travelers
Example URI
DELETE /excon/api/v1/excon-project-travelers
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project Travelers with MatchingDELETE/excon/api/v1/excon-project-travelers
Example URI
DELETE /excon/api/v1/excon-project-travelers
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- personId
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Excon Project Types ¶
Get Excon Project Types by KeyGET/excon/api/v1/excon-project-types(key)
Example URI
GET /excon/api/v1/excon-project-types(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"exconProjectTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Excon Project TypesGET/excon/api/v1/excon-project-types
Example URI
GET /excon/api/v1/excon-project-types
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"exconProjectTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Excon Project Types with FilteringGET/excon/api/v1/excon-project-types
Example URI
GET /excon/api/v1/excon-project-types
URI Parameters
- exconProjectTypeCode
string(optional)Export Control Project Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"exconProjectTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Excon Project TypesGET/excon/api/v1/excon-project-types
Example URI
GET /excon/api/v1/excon-project-types
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"exconProjectTypeCode",
"description"
],
"primaryKey": "exconProjectTypeCode"
}Get Blueprint API specification for Excon Project TypesGET/excon/api/v1/excon-project-types
Example URI
GET /excon/api/v1/excon-project-types
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Excon Project Types.md"
transfer-encoding: chunkedUpdate Excon Project TypesPUT/excon/api/v1/excon-project-types(key)
Example URI
PUT /excon/api/v1/excon-project-types(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"exconProjectTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Excon Project TypesPUT/excon/api/v1/excon-project-types
Example URI
PUT /excon/api/v1/excon-project-types
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"exconProjectTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Excon Project TypesPATCH/excon/api/v1/excon-project-types(key)
Example URI
PATCH /excon/api/v1/excon-project-types(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"exconProjectTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"exconProjectTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Excon Project TypesPOST/excon/api/v1/excon-project-types
Example URI
POST /excon/api/v1/excon-project-types
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"exconProjectTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"exconProjectTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Excon Project TypesPOST/excon/api/v1/excon-project-types
Example URI
POST /excon/api/v1/excon-project-types
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"exconProjectTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"exconProjectTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Excon Project Types by KeyDELETE/excon/api/v1/excon-project-types(key)
Example URI
DELETE /excon/api/v1/excon-project-types(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project TypesDELETE/excon/api/v1/excon-project-types
Example URI
DELETE /excon/api/v1/excon-project-types
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project Types with MatchingDELETE/excon/api/v1/excon-project-types
Example URI
DELETE /excon/api/v1/excon-project-types
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- exconProjectTypeCode
string(optional)Export Control Project Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Excon Project Unit Person Role Types ¶
Get Excon Project Unit Person Role Types by KeyGET/excon/api/v1/excon-project-unit-person-role-types(key)
Example URI
GET /excon/api/v1/excon-project-unit-person-role-types(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"exconProjectUnitPersonRoleTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Excon Project Unit Person Role TypesGET/excon/api/v1/excon-project-unit-person-role-types
Example URI
GET /excon/api/v1/excon-project-unit-person-role-types
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"exconProjectUnitPersonRoleTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectUnitPersonRoleTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Excon Project Unit Person Role Types with FilteringGET/excon/api/v1/excon-project-unit-person-role-types
Example URI
GET /excon/api/v1/excon-project-unit-person-role-types
URI Parameters
- exconProjectUnitPersonRoleTypeCode
string(optional)Export Control Project Unit Person Role Type Code. Maximum length is 5.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"exconProjectUnitPersonRoleTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectUnitPersonRoleTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Excon Project Unit Person Role TypesGET/excon/api/v1/excon-project-unit-person-role-types
Example URI
GET /excon/api/v1/excon-project-unit-person-role-types
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"exconProjectUnitPersonRoleTypeCode",
"description"
],
"primaryKey": "exconProjectUnitPersonRoleTypeCode"
}Get Blueprint API specification for Excon Project Unit Person Role TypesGET/excon/api/v1/excon-project-unit-person-role-types
Example URI
GET /excon/api/v1/excon-project-unit-person-role-types
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Excon Project Unit Person Role Types.md"
transfer-encoding: chunkedUpdate Excon Project Unit Person Role TypesPUT/excon/api/v1/excon-project-unit-person-role-types(key)
Example URI
PUT /excon/api/v1/excon-project-unit-person-role-types(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"exconProjectUnitPersonRoleTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Excon Project Unit Person Role TypesPUT/excon/api/v1/excon-project-unit-person-role-types
Example URI
PUT /excon/api/v1/excon-project-unit-person-role-types
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"exconProjectUnitPersonRoleTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectUnitPersonRoleTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Excon Project Unit Person Role TypesPATCH/excon/api/v1/excon-project-unit-person-role-types(key)
Example URI
PATCH /excon/api/v1/excon-project-unit-person-role-types(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"exconProjectUnitPersonRoleTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"exconProjectUnitPersonRoleTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Excon Project Unit Person Role TypesPOST/excon/api/v1/excon-project-unit-person-role-types
Example URI
POST /excon/api/v1/excon-project-unit-person-role-types
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"exconProjectUnitPersonRoleTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"exconProjectUnitPersonRoleTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Excon Project Unit Person Role TypesPOST/excon/api/v1/excon-project-unit-person-role-types
Example URI
POST /excon/api/v1/excon-project-unit-person-role-types
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"exconProjectUnitPersonRoleTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectUnitPersonRoleTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"exconProjectUnitPersonRoleTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectUnitPersonRoleTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Excon Project Unit Person Role Types by KeyDELETE/excon/api/v1/excon-project-unit-person-role-types(key)
Example URI
DELETE /excon/api/v1/excon-project-unit-person-role-types(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project Unit Person Role TypesDELETE/excon/api/v1/excon-project-unit-person-role-types
Example URI
DELETE /excon/api/v1/excon-project-unit-person-role-types
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project Unit Person Role Types with MatchingDELETE/excon/api/v1/excon-project-unit-person-role-types
Example URI
DELETE /excon/api/v1/excon-project-unit-person-role-types
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- exconProjectUnitPersonRoleTypeCode
string(optional)Export Control Project Unit Person Role Type Code. Maximum length is 5.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Excon Project Unit Persons ¶
Get Excon Project Unit Persons by KeyGET/excon/api/v1/excon-project-unit-persons(key)
Example URI
GET /excon/api/v1/excon-project-unit-persons(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"exconProjectUnitPersonId": "(val)",
"personId": "(val)",
"fullName": "(val)",
"unitAdministratorTypeCode": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"unitAdministratorUnitNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Get All Excon Project Unit PersonsGET/excon/api/v1/excon-project-unit-persons
Example URI
GET /excon/api/v1/excon-project-unit-persons
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"exconProjectUnitPersonId": "(val)",
"personId": "(val)",
"fullName": "(val)",
"unitAdministratorTypeCode": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"unitAdministratorUnitNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectUnitPersonId": "(val)",
"personId": "(val)",
"fullName": "(val)",
"unitAdministratorTypeCode": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"unitAdministratorUnitNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}
]Get All Excon Project Unit Persons with FilteringGET/excon/api/v1/excon-project-unit-persons
Example URI
GET /excon/api/v1/excon-project-unit-persons
URI Parameters
- exconProjectUnitPersonId
string(optional)Export Control Unit Person ID. Maximum length is 22.
- personId
string(optional)Person ID. Maximum length is 40.
- fullName
string(optional)Full Name. Maximum length is 90.
- unitAdministratorTypeCode
string(optional)Unit Administrator Type Code. Maximum length is 5.
- projectNumber
string(optional)- sequenceNumber
string(optional)- unitAdministratorUnitNumber
string(optional)Unit Administrator Unit Number. Maximum length is 8.
- exconProject.projectId
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"exconProjectUnitPersonId": "(val)",
"personId": "(val)",
"fullName": "(val)",
"unitAdministratorTypeCode": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"unitAdministratorUnitNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectUnitPersonId": "(val)",
"personId": "(val)",
"fullName": "(val)",
"unitAdministratorTypeCode": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"unitAdministratorUnitNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Excon Project Unit PersonsGET/excon/api/v1/excon-project-unit-persons
Example URI
GET /excon/api/v1/excon-project-unit-persons
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"exconProjectUnitPersonId",
"personId",
"fullName",
"unitAdministratorTypeCode",
"projectNumber",
"sequenceNumber",
"unitAdministratorUnitNumber",
"exconProject.projectId"
],
"primaryKey": "exconProjectUnitPersonId"
}Get Blueprint API specification for Excon Project Unit PersonsGET/excon/api/v1/excon-project-unit-persons
Example URI
GET /excon/api/v1/excon-project-unit-persons
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Excon Project Unit Persons.md"
transfer-encoding: chunkedUpdate Excon Project Unit PersonsPUT/excon/api/v1/excon-project-unit-persons(key)
Example URI
PUT /excon/api/v1/excon-project-unit-persons(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"exconProjectUnitPersonId": "(val)",
"personId": "(val)",
"fullName": "(val)",
"unitAdministratorTypeCode": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"unitAdministratorUnitNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Excon Project Unit PersonsPUT/excon/api/v1/excon-project-unit-persons
Example URI
PUT /excon/api/v1/excon-project-unit-persons
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"exconProjectUnitPersonId": "(val)",
"personId": "(val)",
"fullName": "(val)",
"unitAdministratorTypeCode": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"unitAdministratorUnitNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectUnitPersonId": "(val)",
"personId": "(val)",
"fullName": "(val)",
"unitAdministratorTypeCode": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"unitAdministratorUnitNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Excon Project Unit PersonsPATCH/excon/api/v1/excon-project-unit-persons(key)
Example URI
PATCH /excon/api/v1/excon-project-unit-persons(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"exconProjectUnitPersonId": "(val)",
"personId": "(val)",
"fullName": "(val)",
"unitAdministratorTypeCode": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"unitAdministratorUnitNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"exconProjectUnitPersonId": "(val)",
"personId": "(val)",
"fullName": "(val)",
"unitAdministratorTypeCode": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"unitAdministratorUnitNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Insert Excon Project Unit PersonsPOST/excon/api/v1/excon-project-unit-persons
Example URI
POST /excon/api/v1/excon-project-unit-persons
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"exconProjectUnitPersonId": "(val)",
"personId": "(val)",
"fullName": "(val)",
"unitAdministratorTypeCode": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"unitAdministratorUnitNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"exconProjectUnitPersonId": "(val)",
"personId": "(val)",
"fullName": "(val)",
"unitAdministratorTypeCode": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"unitAdministratorUnitNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Excon Project Unit PersonsPOST/excon/api/v1/excon-project-unit-persons
Example URI
POST /excon/api/v1/excon-project-unit-persons
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"exconProjectUnitPersonId": "(val)",
"personId": "(val)",
"fullName": "(val)",
"unitAdministratorTypeCode": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"unitAdministratorUnitNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectUnitPersonId": "(val)",
"personId": "(val)",
"fullName": "(val)",
"unitAdministratorTypeCode": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"unitAdministratorUnitNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"exconProjectUnitPersonId": "(val)",
"personId": "(val)",
"fullName": "(val)",
"unitAdministratorTypeCode": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"unitAdministratorUnitNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
},
{
"exconProjectUnitPersonId": "(val)",
"personId": "(val)",
"fullName": "(val)",
"unitAdministratorTypeCode": "(val)",
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"unitAdministratorUnitNumber": "(val)",
"exconProject.projectId": "(val)",
"_primaryKey": "(val)"
}
]Delete Excon Project Unit Persons by KeyDELETE/excon/api/v1/excon-project-unit-persons(key)
Example URI
DELETE /excon/api/v1/excon-project-unit-persons(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project Unit PersonsDELETE/excon/api/v1/excon-project-unit-persons
Example URI
DELETE /excon/api/v1/excon-project-unit-persons
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Project Unit Persons with MatchingDELETE/excon/api/v1/excon-project-unit-persons
Example URI
DELETE /excon/api/v1/excon-project-unit-persons
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- exconProjectUnitPersonId
string(optional)Export Control Unit Person ID. Maximum length is 22.
- personId
string(optional)Person ID. Maximum length is 40.
- fullName
string(optional)Full Name. Maximum length is 90.
- unitAdministratorTypeCode
string(optional)Unit Administrator Type Code. Maximum length is 5.
- projectNumber
string(optional)- sequenceNumber
string(optional)- unitAdministratorUnitNumber
string(optional)Unit Administrator Unit Number. Maximum length is 8.
- exconProject.projectId
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Excon Projects ¶
Get Excon Projects by KeyGET/excon/api/v1/excon-projects(key)
Example URI
GET /excon/api/v1/excon-projects(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"title": "(val)",
"projectTypeCode": "(val)",
"projectId": "(val)",
"unitNumber": "(val)",
"sponsorCode": "(val)",
"fundamentalResearch": "(val)",
"internationalResearch": "(val)",
"classifiedResearch": "(val)",
"restrictedResearch": "(val)",
"projectStartDate": "(val)",
"projectEndDate": "(val)",
"projectStatusCode": "(val)",
"agreementRole": "(val)",
"responsibleParty": "(val)",
"exconProjectSequenceStatus": "(val)",
"exconProjectDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
}Get All Excon ProjectsGET/excon/api/v1/excon-projects
Example URI
GET /excon/api/v1/excon-projects
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"title": "(val)",
"projectTypeCode": "(val)",
"projectId": "(val)",
"unitNumber": "(val)",
"sponsorCode": "(val)",
"fundamentalResearch": "(val)",
"internationalResearch": "(val)",
"classifiedResearch": "(val)",
"restrictedResearch": "(val)",
"projectStartDate": "(val)",
"projectEndDate": "(val)",
"projectStatusCode": "(val)",
"agreementRole": "(val)",
"responsibleParty": "(val)",
"exconProjectSequenceStatus": "(val)",
"exconProjectDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
},
{
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"title": "(val)",
"projectTypeCode": "(val)",
"projectId": "(val)",
"unitNumber": "(val)",
"sponsorCode": "(val)",
"fundamentalResearch": "(val)",
"internationalResearch": "(val)",
"classifiedResearch": "(val)",
"restrictedResearch": "(val)",
"projectStartDate": "(val)",
"projectEndDate": "(val)",
"projectStatusCode": "(val)",
"agreementRole": "(val)",
"responsibleParty": "(val)",
"exconProjectSequenceStatus": "(val)",
"exconProjectDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
}
]Get All Excon Projects with FilteringGET/excon/api/v1/excon-projects
Example URI
GET /excon/api/v1/excon-projects
URI Parameters
- projectNumber
string(optional)Project Number. Maximum length is 12.
- sequenceNumber
string(optional)Sequence Number. Maximum length is 4.
- title
string(optional)Project Title. Maximum length is 100.
- projectTypeCode
string(optional)Project Type Code. Maximum length is 3.
- projectId
string(optional)Project Id. Maximum length is 22.
- unitNumber
string(optional)The lead unit number for the ExconProject. Maximum length is 8.
- sponsorCode
string(optional)The identification number of the organization or agency that is providing support for the sponsored project. Maximum length is 6.
- fundamentalResearch
string(optional)Fundamental Research. Maximum length is 1.
- internationalResearch
string(optional)International. Maximum length is 1.
- classifiedResearch
string(optional)Classified. Maximum length is 1.
- restrictedResearch
string(optional)Export Restricted. Maximum length is 1.
- projectStartDate
string(optional)Project Start Date. Maximum length is 21.
- projectEndDate
string(optional)Project End Date. Maximum length is 21.
- projectStatusCode
string(optional)Project Status. Maximum length is 3.
- agreementRole
string(optional)Agreement Role. Maximum length is 1.
- responsibleParty
string(optional)Responsible Party. Maximum length is 40.
- exconProjectSequenceStatus
string(optional)- exconProjectDocument.documentNumber
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"title": "(val)",
"projectTypeCode": "(val)",
"projectId": "(val)",
"unitNumber": "(val)",
"sponsorCode": "(val)",
"fundamentalResearch": "(val)",
"internationalResearch": "(val)",
"classifiedResearch": "(val)",
"restrictedResearch": "(val)",
"projectStartDate": "(val)",
"projectEndDate": "(val)",
"projectStatusCode": "(val)",
"agreementRole": "(val)",
"responsibleParty": "(val)",
"exconProjectSequenceStatus": "(val)",
"exconProjectDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
},
{
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"title": "(val)",
"projectTypeCode": "(val)",
"projectId": "(val)",
"unitNumber": "(val)",
"sponsorCode": "(val)",
"fundamentalResearch": "(val)",
"internationalResearch": "(val)",
"classifiedResearch": "(val)",
"restrictedResearch": "(val)",
"projectStartDate": "(val)",
"projectEndDate": "(val)",
"projectStatusCode": "(val)",
"agreementRole": "(val)",
"responsibleParty": "(val)",
"exconProjectSequenceStatus": "(val)",
"exconProjectDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Excon ProjectsGET/excon/api/v1/excon-projects
Example URI
GET /excon/api/v1/excon-projects
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"projectNumber",
"sequenceNumber",
"title",
"projectTypeCode",
"projectId",
"unitNumber",
"sponsorCode",
"fundamentalResearch",
"internationalResearch",
"classifiedResearch",
"restrictedResearch",
"projectStartDate",
"projectEndDate",
"projectStatusCode",
"agreementRole",
"responsibleParty",
"exconProjectSequenceStatus",
"exconProjectDocument.documentNumber"
],
"primaryKey": "projectId"
}Get Blueprint API specification for Excon ProjectsGET/excon/api/v1/excon-projects
Example URI
GET /excon/api/v1/excon-projects
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Excon Projects.md"
transfer-encoding: chunkedUpdate Excon ProjectsPUT/excon/api/v1/excon-projects(key)
Example URI
PUT /excon/api/v1/excon-projects(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"title": "(val)",
"projectTypeCode": "(val)",
"projectId": "(val)",
"unitNumber": "(val)",
"sponsorCode": "(val)",
"fundamentalResearch": "(val)",
"internationalResearch": "(val)",
"classifiedResearch": "(val)",
"restrictedResearch": "(val)",
"projectStartDate": "(val)",
"projectEndDate": "(val)",
"projectStatusCode": "(val)",
"agreementRole": "(val)",
"responsibleParty": "(val)",
"exconProjectSequenceStatus": "(val)",
"exconProjectDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Excon ProjectsPUT/excon/api/v1/excon-projects
Example URI
PUT /excon/api/v1/excon-projects
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"title": "(val)",
"projectTypeCode": "(val)",
"projectId": "(val)",
"unitNumber": "(val)",
"sponsorCode": "(val)",
"fundamentalResearch": "(val)",
"internationalResearch": "(val)",
"classifiedResearch": "(val)",
"restrictedResearch": "(val)",
"projectStartDate": "(val)",
"projectEndDate": "(val)",
"projectStatusCode": "(val)",
"agreementRole": "(val)",
"responsibleParty": "(val)",
"exconProjectSequenceStatus": "(val)",
"exconProjectDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
},
{
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"title": "(val)",
"projectTypeCode": "(val)",
"projectId": "(val)",
"unitNumber": "(val)",
"sponsorCode": "(val)",
"fundamentalResearch": "(val)",
"internationalResearch": "(val)",
"classifiedResearch": "(val)",
"restrictedResearch": "(val)",
"projectStartDate": "(val)",
"projectEndDate": "(val)",
"projectStatusCode": "(val)",
"agreementRole": "(val)",
"responsibleParty": "(val)",
"exconProjectSequenceStatus": "(val)",
"exconProjectDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Excon ProjectsPATCH/excon/api/v1/excon-projects(key)
Example URI
PATCH /excon/api/v1/excon-projects(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"title": "(val)",
"projectTypeCode": "(val)",
"projectId": "(val)",
"unitNumber": "(val)",
"sponsorCode": "(val)",
"fundamentalResearch": "(val)",
"internationalResearch": "(val)",
"classifiedResearch": "(val)",
"restrictedResearch": "(val)",
"projectStartDate": "(val)",
"projectEndDate": "(val)",
"projectStatusCode": "(val)",
"agreementRole": "(val)",
"responsibleParty": "(val)",
"exconProjectSequenceStatus": "(val)",
"exconProjectDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"title": "(val)",
"projectTypeCode": "(val)",
"projectId": "(val)",
"unitNumber": "(val)",
"sponsorCode": "(val)",
"fundamentalResearch": "(val)",
"internationalResearch": "(val)",
"classifiedResearch": "(val)",
"restrictedResearch": "(val)",
"projectStartDate": "(val)",
"projectEndDate": "(val)",
"projectStatusCode": "(val)",
"agreementRole": "(val)",
"responsibleParty": "(val)",
"exconProjectSequenceStatus": "(val)",
"exconProjectDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
}Insert Excon ProjectsPOST/excon/api/v1/excon-projects
Example URI
POST /excon/api/v1/excon-projects
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"title": "(val)",
"projectTypeCode": "(val)",
"projectId": "(val)",
"unitNumber": "(val)",
"sponsorCode": "(val)",
"fundamentalResearch": "(val)",
"internationalResearch": "(val)",
"classifiedResearch": "(val)",
"restrictedResearch": "(val)",
"projectStartDate": "(val)",
"projectEndDate": "(val)",
"projectStatusCode": "(val)",
"agreementRole": "(val)",
"responsibleParty": "(val)",
"exconProjectSequenceStatus": "(val)",
"exconProjectDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"title": "(val)",
"projectTypeCode": "(val)",
"projectId": "(val)",
"unitNumber": "(val)",
"sponsorCode": "(val)",
"fundamentalResearch": "(val)",
"internationalResearch": "(val)",
"classifiedResearch": "(val)",
"restrictedResearch": "(val)",
"projectStartDate": "(val)",
"projectEndDate": "(val)",
"projectStatusCode": "(val)",
"agreementRole": "(val)",
"responsibleParty": "(val)",
"exconProjectSequenceStatus": "(val)",
"exconProjectDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Excon ProjectsPOST/excon/api/v1/excon-projects
Example URI
POST /excon/api/v1/excon-projects
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"title": "(val)",
"projectTypeCode": "(val)",
"projectId": "(val)",
"unitNumber": "(val)",
"sponsorCode": "(val)",
"fundamentalResearch": "(val)",
"internationalResearch": "(val)",
"classifiedResearch": "(val)",
"restrictedResearch": "(val)",
"projectStartDate": "(val)",
"projectEndDate": "(val)",
"projectStatusCode": "(val)",
"agreementRole": "(val)",
"responsibleParty": "(val)",
"exconProjectSequenceStatus": "(val)",
"exconProjectDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
},
{
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"title": "(val)",
"projectTypeCode": "(val)",
"projectId": "(val)",
"unitNumber": "(val)",
"sponsorCode": "(val)",
"fundamentalResearch": "(val)",
"internationalResearch": "(val)",
"classifiedResearch": "(val)",
"restrictedResearch": "(val)",
"projectStartDate": "(val)",
"projectEndDate": "(val)",
"projectStatusCode": "(val)",
"agreementRole": "(val)",
"responsibleParty": "(val)",
"exconProjectSequenceStatus": "(val)",
"exconProjectDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"title": "(val)",
"projectTypeCode": "(val)",
"projectId": "(val)",
"unitNumber": "(val)",
"sponsorCode": "(val)",
"fundamentalResearch": "(val)",
"internationalResearch": "(val)",
"classifiedResearch": "(val)",
"restrictedResearch": "(val)",
"projectStartDate": "(val)",
"projectEndDate": "(val)",
"projectStatusCode": "(val)",
"agreementRole": "(val)",
"responsibleParty": "(val)",
"exconProjectSequenceStatus": "(val)",
"exconProjectDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
},
{
"projectNumber": "(val)",
"sequenceNumber": "(val)",
"title": "(val)",
"projectTypeCode": "(val)",
"projectId": "(val)",
"unitNumber": "(val)",
"sponsorCode": "(val)",
"fundamentalResearch": "(val)",
"internationalResearch": "(val)",
"classifiedResearch": "(val)",
"restrictedResearch": "(val)",
"projectStartDate": "(val)",
"projectEndDate": "(val)",
"projectStatusCode": "(val)",
"agreementRole": "(val)",
"responsibleParty": "(val)",
"exconProjectSequenceStatus": "(val)",
"exconProjectDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
}
]Delete Excon Projects by KeyDELETE/excon/api/v1/excon-projects(key)
Example URI
DELETE /excon/api/v1/excon-projects(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon ProjectsDELETE/excon/api/v1/excon-projects
Example URI
DELETE /excon/api/v1/excon-projects
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Excon Projects with MatchingDELETE/excon/api/v1/excon-projects
Example URI
DELETE /excon/api/v1/excon-projects
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- projectNumber
string(optional)Project Number. Maximum length is 12.
- sequenceNumber
string(optional)Sequence Number. Maximum length is 4.
- title
string(optional)Project Title. Maximum length is 100.
- projectTypeCode
string(optional)Project Type Code. Maximum length is 3.
- projectId
string(optional)Project Id. Maximum length is 22.
- unitNumber
string(optional)The lead unit number for the ExconProject. Maximum length is 8.
- sponsorCode
string(optional)The identification number of the organization or agency that is providing support for the sponsored project. Maximum length is 6.
- fundamentalResearch
string(optional)Fundamental Research. Maximum length is 1.
- internationalResearch
string(optional)International. Maximum length is 1.
- classifiedResearch
string(optional)Classified. Maximum length is 1.
- restrictedResearch
string(optional)Export Restricted. Maximum length is 1.
- projectStartDate
string(optional)Project Start Date. Maximum length is 21.
- projectEndDate
string(optional)Project End Date. Maximum length is 21.
- projectStatusCode
string(optional)Project Status. Maximum length is 3.
- agreementRole
string(optional)Agreement Role. Maximum length is 1.
- responsibleParty
string(optional)Responsible Party. Maximum length is 40.
- exconProjectSequenceStatus
string(optional)- exconProjectDocument.documentNumber
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204