Jump to

• Request
• Response

Get a place

get

https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/place/{id}

Returns the place that matches the specified ID, including its configured details.

Request

Path Parameters

• id(required): string
  The ID of the resource item.

Query Parameters

• fields: string
  The comma-separated field names that are returned in the response. The field names are the names that you specify when you create or retrieve a resource.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The place was returned successfully.

Body ()

Root Schema : PlaceOracle

Type: object

Title: PlaceOracle

The place resource.

Show Source

• @baseType: string
  The base type of the place.
• @schemaLocation: string
  The URI of the schema that defines the place.
• @type(required): string
  The class type of the place.
• applicationName: string
  The name of the application associated with the place.
• created: string (date-time)
  The date and time of the place creation.
• createdBy: string
  The name of the person who created the place.
• description: string
  The description of place.
• externalId: string
  The ID of the external associated with the place.
• href: string
  The hyperlink reference to the place.
• id: string
  Maximum Length: 30

  The ID of the place.
• lastUpdate: string (date-time)
  The date and time when the place was last updated.
• lastUpdatedBy: string
  The name of the person who updated the place.
• lifecycleStatus: string
  The status of the place.
• name(required): string
  The name of the place.
• project: object ProjectRef
  Title: ProjectRef

  The project reference resource.
• validFor: object TimePeriod
  Title: TimePeriod

  The period for which the productOffering is valid.
• version: string
  The place version.
• versionState: number
  The version state of the place.

{
    "title":"PlaceOracle",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"The ID of the place."
        },
        "name":{
            "type":"string",
            "description":"The name of the place."
        },
        "description":{
            "type":"string",
            "description":"The description of place."
        },
        "href":{
            "type":"string",
            "description":"The hyperlink reference to the place."
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the place was last updated."
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"The status of the place."
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod",
            "description":"The period for which the place is valid."
        },
        "@type":{
            "type":"string",
            "description":"The class type of the place."
        },
        "@baseType":{
            "type":"string",
            "description":"The base type of the place."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the place."
        },
        "project":{
            "$ref":"#/components/schemas/ProjectRef",
            "description":"The place."
        },
        "version":{
            "type":"string",
            "description":"The place version."
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time of the place creation."
        },
        "createdBy":{
            "type":"string",
            "description":"The name of the person who created the place."
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"The name of the person who updated the place."
        },
        "versionState":{
            "type":"number",
            "description":"The version state of the place."
        },
        "externalId":{
            "type":"string",
            "description":"The ID of the external associated with the place."
        },
        "applicationName":{
            "type":"string",
            "description":"The name of the application associated with the place."
        }
    },
    "required":[
        "name",
        "@type"
    ],
    "description":"The place resource."
}

Nested Schema : ProjectRef

Type: object

Title: ProjectRef

The project reference resource.

Show Source

• href: string
  The hyperlink reference to the project reference.
• id(required): string
  The ID of the project reference.
• name: string
  The name of the project reference.
• version: string
  The version of the project.

{
    "title":"ProjectRef",
    "type":"object",
    "description":"The project reference resource.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the project reference."
        },
        "href":{
            "type":"string",
            "description":"The hyperlink reference to the project reference."
        },
        "name":{
            "type":"string",
            "description":"The name of the project reference."
        },
        "version":{
            "type":"string",
            "description":"The version of the project."
        }
    },
    "required":[
        "id"
    ]
}

Nested Schema : TimePeriod

Type: object

Title: TimePeriod

The period for which the productOffering is valid.

Show Source

• endDateTime: string (date-time)
  The end date and time of the time period.
• startDateTime: string (date-time)
  The start date and time of the time period.

{
    "title":"TimePeriod",
    "description":"The period for which the productOffering is valid.",
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The start date and time of the time period."
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The end date and time of the time period."
        }
    }
}

400 Response

Your request couldn't be processed because it contains missing or invalid information, such as a validation error on an input field, a missing required value, and so forth.

Body ()

Root Schema : Error

Type: object

Title: Error

The error resource.

Show Source

• @schemaLocation: string
  The URI of the schema that defines the error.
• @type: string
  The class type of a REST resource.
• code(required): string
  Application related code (as defined in the API or from a common list).
• message: string
  The text that provides more details and corrective actions related to the error. This can be shown to a client user.
• reason(required): string
  The text that explains the reason for error. This can be shown to a client user.
• referenceError: string
  The URL pointing to documentation describing the error.
• status: string
  The status of the error.

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)."
        },
        "reason":{
            "type":"string",
            "description":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

401 Response

Your request isn't authorized. The authentication credentials included with this request are missing or invalid.

Body ()

Root Schema : Error

Type: object

Title: Error

The error resource.

Show Source

• @schemaLocation: string
  The URI of the schema that defines the error.
• @type: string
  The class type of a REST resource.
• code(required): string
  Application related code (as defined in the API or from a common list).
• message: string
  The text that provides more details and corrective actions related to the error. This can be shown to a client user.
• reason(required): string
  The text that explains the reason for error. This can be shown to a client user.
• referenceError: string
  The URL pointing to documentation describing the error.
• status: string
  The status of the error.

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)."
        },
        "reason":{
            "type":"string",
            "description":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

404 Response

The resource with the specified URI couldn't be found.

Body ()

Root Schema : Error

Type: object

Title: Error

The error resource.

Show Source

• @schemaLocation: string
  The URI of the schema that defines the error.
• @type: string
  The class type of a REST resource.
• code(required): string
  Application related code (as defined in the API or from a common list).
• message: string
  The text that provides more details and corrective actions related to the error. This can be shown to a client user.
• reason(required): string
  The text that explains the reason for error. This can be shown to a client user.
• referenceError: string
  The URL pointing to documentation describing the error.
• status: string
  The status of the error.

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)."
        },
        "reason":{
            "type":"string",
            "description":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

405 Response

HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.

Body ()

Root Schema : Error

Type: object

Title: Error

The error resource.

Show Source

• @schemaLocation: string
  The URI of the schema that defines the error.
• @type: string
  The class type of a REST resource.
• code(required): string
  Application related code (as defined in the API or from a common list).
• message: string
  The text that provides more details and corrective actions related to the error. This can be shown to a client user.
• reason(required): string
  The text that explains the reason for error. This can be shown to a client user.
• referenceError: string
  The URL pointing to documentation describing the error.
• status: string
  The status of the error.

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)."
        },
        "reason":{
            "type":"string",
            "description":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

500 Response

The server encountered something unexpected that prevented it from completing the request.

Body ()

Root Schema : Error

Type: object

Title: Error

The error resource.

Show Source

• @schemaLocation: string
  The URI of the schema that defines the error.
• @type: string
  The class type of a REST resource.
• code(required): string
  Application related code (as defined in the API or from a common list).
• message: string
  The text that provides more details and corrective actions related to the error. This can be shown to a client user.
• reason(required): string
  The text that explains the reason for error. This can be shown to a client user.
• referenceError: string
  The URL pointing to documentation describing the error.
• status: string
  The status of the error.

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)."
        },
        "reason":{
            "type":"string",
            "description":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

Back to Top