|
Topics: |
Use the following REST call to return detailed metadata for a subject master in the project. See the data dictionary for the metadata repository for an explanation of the attributes returned. This REST call is available as of Version 3.10.
|
Topics: |
The response is returned in JSON format. {name} is the name of a subject master in the project.
GET https://localhost:9500/api/v1/metadata/subject/master/SalesOrg
-- response --
{
"status": "OK",
"code": 0,
"message": null,
"developerMessage": null,
"responseType": "com.ibi.omni.model.ids.IdsDocumentModel",
"response": {
"name": "SalesOrgMaster",
"version": null,
"bundleCreatedBy": "IBI Deployment Bundler",
"projectName": "CustomerAutoiwqaomnia",
"bundleReleaseNumber": "3.5.0.Alpha.10",
"bundleVersion": "CustomerAutoiwqaomnia_3_5_0_Alpha_10_190506131145",
"idsVersion": "2.0",
"udlName": "SalesOrgMaster",
"type": "master",
"master": null,
"instance": "SalesOrg",
"access": "standard",
"tableName": "og_sales_org_m",
"sourceTableName": null,
"rampTableName": null,
"tableSpace": null,
"domain": "SalesOrg",
"elementOrder": "MasterStatus,MasterStatusReason,MasterId,MasterStatusCode,sales_org_name,sales_org_desc,sales_org_start_dt,sales_org_end_dt,primary_geo_area",
"captureHistory": false,
"excludeFromRamp": false,
"backingClass": "com.ibi.omni.model.DIBMaster",
"implementationClass": null,
"allowInitialUpdates": false,
"persistenceUnit": null,
"cleanse": true,
"match": true,
"merge": false,
"remediate": false,
"system": false,
"documentation": "The enterprise's sales organization information such as name, identifier and description.",
"longDocumentation": "",
"changeLogs": [],"elements": [
{
"name": "sales_org_start_dt",
"udlName": "sales_org_start_dt",
"typeName": "date",
"dbTable": "og_sales_org_m",
"sourceTable": null,
"rampTable": null,
"dbColumn": "sales_org_start_dt",
"dbRampColumns": null,
"contains": null,
"keys": null,
"immediate": false,
"hidden": false,
"key": false,
"excludeInDoc": false,
"required": false,
"index": false,
"allowCreate": true,
"maxLength": null,
"precision": null,
"scale": null,
"excludeFromRamp": false,
"codeSourceName": null,
"codeSet": null,
"cleanse": false,
"match": false,
"merge": false,
"remediate": false,
"system": false,
"documentation": "The start date for a sales organization.",
"shortDescription": null
},
{
"name": "sales_org_desc",
"udlName": "sales_org_desc",
"typeName": "string",
"dbTable": "og_sales_org_m",
"sourceTable": null,
"rampTable": null,
"dbColumn": "sales_org_desc",
"dbRampColumns": null,
"contains": null,
"keys": null,
"immediate": false,
"hidden": false,
"key": false,
"excludeInDoc": false,
"required": false,
"index": false,
"allowCreate": true,
"maxLength": null,
"precision": null,
"scale": null,
"excludeFromRamp": false, "codeSourceName": null,
"codeSet": null,
"cleanse": false,
"match": false,
"merge": false,
"remediate": false,
"system": false,
"documentation": "The textual description for a sales organization.",
"shortDescription": null
},
{
"name": "sales_org_name",
"udlName": "sales_org_name",
"typeName": "string",
"dbTable": "og_sales_org_m",
"sourceTable": null,
"rampTable": null,
"dbColumn": "sales_org_name",
"dbRampColumns": null,
"contains": null,
"keys": null,
"immediate": false,
"hidden": false,
"key": false,
"excludeInDoc": false,
"required": false,
"index": false,
"allowCreate": true,
"maxLength": null,
"precision": null,
"scale": null,
"excludeFromRamp": false,
"codeSourceName": null,
"codeSet": null,
"cleanse": false,
"match": false,
"merge": false,
"remediate": false,
"system": false,
"documentation": "The textual name for a sales organization.",
"shortDescription": null
},
{
"name": "MasterStatus",
"udlName": "masterStatus",
"typeName": "string",
"dbTable": "og_sales_org_m",
"sourceTable": null,
"rampTable": null,
"dbColumn": "status",
"dbRampColumns": null,
"contains": null, "keys": null,
"immediate": false,
"hidden": true,
"key": false,
"excludeInDoc": false,
"required": false,
"index": false,
"allowCreate": true,
"maxLength": null,
"precision": null,
"scale": null,
"excludeFromRamp": false,
"codeSourceName": null,
"codeSet": null,
"cleanse": true,
"match": true,
"merge": true,
"remediate": false,
"system": true,
"documentation": "",
"shortDescription": null
},
{
"name": "primary_geo_area",
"udlName": "primary_geo_area",
"typeName": "code",
"dbTable": "og_sales_org_m",
"sourceTable": null,
"rampTable": null,
"dbColumn": "primary_geo_area_code",
"dbRampColumns": null,
"contains": null,
"keys": null,
"immediate": false,
"hidden": false,
"key": false,
"excludeInDoc": false,
"required": false,
"index": false,
"allowCreate": true,
"maxLength": null,
"precision": null,
"scale": null,
"excludeFromRamp": false,
"codeSourceName": null,
"codeSet": null,
"cleanse": false,
"match": false,
"merge": false,
"remediate": false,
"system": false,
"documentation": "The primary geographical area assigned to a sales organization.",
"shortDescription": null
},{
"name": "MasterStatusCode",
"udlName": "masterStatus",
"typeName": "masteromnicode",
"dbTable": "og_sales_org_m",
"sourceTable": null,
"rampTable": null,
"dbColumn": "master_status_code",
"dbRampColumns": null,
"contains": null,
"keys": null,
"immediate": false,
"hidden": false,
"key": false,
"excludeInDoc": false,
"required": false,
"index": false,
"allowCreate": true,
"maxLength": null,
"precision": null,
"scale": null,
"excludeFromRamp": false,
"codeSourceName": null,
"codeSet": null,
"cleanse": false,
"match": false,
"merge": false,
"remediate": false,
"system": true,
"documentation": "",
"shortDescription": null
},
{
"name": "MasterId",
"udlName": "masterId",
"typeName": "string",
"dbTable": "og_sales_org_m",
"sourceTable": null,
"rampTable": null,
"dbColumn": "master_id",
"dbRampColumns": null,
"contains": null,
"keys": null,
"immediate": false,
"hidden": false,
"key": true,
"excludeInDoc": false,
"required": false,
"index": false,
"allowCreate": true,
"maxLength": null,
"precision": null,
"scale": null,
"excludeFromRamp": false, "codeSourceName": null,
"codeSet": null,
"cleanse": false,
"match": false,
"merge": false,
"remediate": false,
"system": true,
"documentation": "Master id for master instance relationship.",
"shortDescription": null
},
{
"name": "MasterStatusReason",
"udlName": "masterStatusReason",
"typeName": "string",
"dbTable": "og_sales_org_m",
"sourceTable": null,
"rampTable": null,
"dbColumn": "status_reason",
"dbRampColumns": null,
"contains": null,
"keys": null,
"immediate": false,
"hidden": true,
"key": false,
"excludeInDoc": false,
"required": false,
"index": false,
"allowCreate": true,
"maxLength": null,
"precision": null,
"scale": null,
"excludeFromRamp": false,
"codeSourceName": null,
"codeSet": null,
"cleanse": true,
"match": true,
"merge": true,
"remediate": false,
"system": true,
"documentation": "Use to specify the reason for the status.",
"shortDescription": null
},
{
"name": "sales_org_end_dt",
"udlName": "sales_org_end_dt",
"typeName": "date",
"dbTable": "og_sales_org_m",
"sourceTable": null,
"rampTable": null,
"dbColumn": "sales_org_end_dt",
"dbRampColumns": null,
"contains": null,
"keys": null,
"immediate": false, "hidden": false,
"key": false,
"excludeInDoc": false,
"required": false,
"index": false,
"allowCreate": true,
"maxLength": null,
"precision": null,
"scale": null,
"excludeFromRamp": false,
"codeSourceName": null,
"codeSet": null,
"cleanse": false,
"match": false,
"merge": false,
"remediate": false,
"system": false,
"documentation": "The end date for a sales organization.",
"shortDescription": null
}
],
"lists": [],
"groups": []
},
"exception": null
}